[Index Management] Add Overview tab by alisonelizabeth · Pull Request #164628 · elastic/kibana

alisonelizabeth · 2023-08-23T18:44:59Z

This PR builds out the "Overview" tab on the new index details page.

Note: We will likely iterate on this design in the future.

How to test

On serverless:

Run in serverless mode

yarn es serverless
yarn start --serverless=es

Create an index

PUT /my-index

Navigate to Index Management --> verify index details for the index created.

On stateful:

Start up Kibana and ES locally

yarn es snapshot
yarn start

Create an index
Navigate to Index Management --> verify index details for the index created. Index stats should be visible.

Screenshots

// Serverless view (index stats info not available)

// Self-managed (with index stats panel)

…fix'

…t/overview_tab

…fix'

packages/kbn-search-api-panels/types.ts

alisonelizabeth · 2023-08-25T17:45:57Z

x-pack/plugins/serverless_search/public/application/components/overview.tsx

            codeSnippetArguments
          )}
-          showTryInConsole={getConsoleRequest('ingestData')}
+          consoleRequest={getConsoleRequest('ingestData')}


I think this maybe was an oversight of #164766?

yes this is fixed in main

TattdCodeMonkey

search-api-panel changes LGTM

packages/kbn-search-api-panels/utils.ts

packages/kbn-search-api-panels/utils.test.ts

packages/kbn-search-api-panels/types.ts

packages/kbn-search-api-panels/components/code_box.tsx

…t/overview_tab

alisonelizabeth · 2023-08-31T12:55:40Z

.../public/application/sections/home/index_list/details_page/details_page_overview/languages.ts

+
+const INDEX_NAME_PLACEHOLDER = 'index_name';
+
+export const curlDefinition: LanguageDefinition = {


@TattdCodeMonkey is there someone you usually work with to verify the code snippets for each language? I copied this from existing definitions, but would be good to get a pair of 👀 on it to confirm.

Yes we usually ping the language clients team and see if they can give them a review.

alisonelizabeth · 2023-08-31T12:57:16Z

x-pack/plugins/index_management/public/assets/curl.svg

@TattdCodeMonkey have you considered having a shared place for some of these common client svgs?

We haven't yet but it would be a good topic for improvement. I know Efe included them in enterprise_search and imported them (see here & here) vs populating the url path. Which might be an option to include them in the search-api-panels package that way but I'm not 100% sure what if that would work in a package.

Yeah, I was wondering if it might makes sense in the search-api-panels package. I also found there's a kbn-shared-svg package, although it doesn't appear to be used much yet.

I will as-is for now; but I think it's worth revisiting.

…t/overview_tab

elasticmachine · 2023-09-06T17:48:15Z

Pinging @elastic/platform-deployment-management (Team:Deployment Management)

alisonelizabeth · 2023-09-06T17:53:41Z

@elasticmachine merge upstream

JoshMock

Code snippets for Python and JavaScript look right to me. 👍 Ruby and PHP also seem right, but @ezimuel and @picandocodigo would be best for those. And @Anaethelion for Go.

…t/overview_tab

yuliacech

Great job, @alisonelizabeth!
Code changes LGTM! Index details definitely look better on stateful than serverless when there is hardly any info to display, but we could work on it in a follow up.

alisonelizabeth · 2023-09-07T12:28:40Z

@elasticmachine merge upstream

mdefazio

This is exciting to see this evolve!

When selecting an index and using the bulk action menu (with only a single index selected), the options don't navigate anywhere now. (Perhaps still trying to trigger the flyout?)

I expected these options to take me to the appropriate tab on the detail page.

Perhaps not due to this PR. So if not, I am happy to approve this one and file this elsewhere.

Screenshot--2023-09-07--Index.Management.-.Elastic.mp4

yuliacech · 2023-09-07T13:16:42Z

Hey @mdefazio, that is correct, the actions are not working for the new details page. I'm working on enabling the new page by default (draft PR) and I thought we could remove those actions altogether. I'm not sure it makes sense to keep those "show" actions with the new page for index details

sphilipse

Awesome! LGTM :)

alisonelizabeth · 2023-09-07T18:41:17Z

@elasticmachine merge upstream

alisonelizabeth · 2023-09-07T19:49:12Z

@elasticmachine merge upstream

alisonelizabeth · 2023-09-08T12:31:47Z

@elasticmachine merge upstream

alisonelizabeth · 2023-09-08T12:53:36Z

@sphilipse do you mind reviewing b3a31e3? CI was failing on my PR due to this TS error; I believe it was introduced via #165880.

kibana-ci · 2023-09-08T13:21:24Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`indexManagement`	504	532	+28

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/search-api-panels`	67	68	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`enterpriseSearch`	2.6MB	2.6MB	+316.0B
`indexManagement`	542.4KB	558.2KB	+15.8KB
`serverlessSearch`	79.7KB	80.0KB	+316.0B
total			+16.4KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`indexManagement`	32.6KB	32.7KB	+16.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/search-api-panels`	67	68	+1

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

mdefazio

LGTM.

alisonelizabeth · 2023-09-08T14:17:00Z

I'm going to go ahead and merge this. If there are any additional changes needed to the clients code, I will open up a follow-up PR (re: #164628 (review)).

alisonelizabeth and others added 10 commits August 23, 2023 14:43

init commit: build out overview tab

7f076ee

add code panel (wip)

600f815

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

d24ca3f

…fix'

add client svgs (for now)

dd72256

add tests

6e9e56e

Merge branch 'main' of github.com:elastic/kibana into index_managemen…

6085fd8

…t/overview_tab

fix 'try in console' feature

acd2851

fix deployment url on cloud

e3ff17d

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

89d3bc1

…fix'

make docLink optional

d68f994

alisonelizabeth added ci:cloud-deploy Create or update a Cloud deployment Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more t// release_note:skip Skip the PR/issue when compiling release notes labels Aug 25, 2023

remove unused class; rename data-test-subj

2edb9d5

alisonelizabeth commented Aug 25, 2023

View reviewed changes

packages/kbn-search-api-panels/types.ts Show resolved Hide resolved

alisonelizabeth commented Aug 25, 2023

View reviewed changes

TattdCodeMonkey approved these changes Aug 25, 2023

View reviewed changes

alisonelizabeth added 2 commits August 28, 2023 10:40

Merge branch 'main' of github.com:elastic/kibana into index_managemen…

15dba95

…t/overview_tab

address review feedback

19800a9

alisonelizabeth mentioned this pull request Aug 29, 2023

[Index Management] Add "Stats" tab #165027

Merged

alisonelizabeth added 2 commits August 31, 2023 08:41

Merge branch 'main' of github.com:elastic/kibana into index_managemen…

cebb3cc

…t/overview_tab

align code with other tabs

3a1ab02

alisonelizabeth commented Aug 31, 2023

View reviewed changes

yuliacech mentioned this pull request Sep 5, 2023

[Index Management] Implement index details page #165705

Merged

alisonelizabeth added 2 commits September 6, 2023 08:57

Merge branch 'main' of github.com:elastic/kibana into index_managemen…

dca33d9

…t/overview_tab

add check for primaries and replicas

a87be01

alisonelizabeth marked this pull request as ready for review September 6, 2023 17:48

alisonelizabeth requested a review from a team as a code owner September 6, 2023 17:48

alisonelizabeth requested a review from a team September 6, 2023 17:48

alisonelizabeth requested a review from a team as a code owner September 6, 2023 17:48

alisonelizabeth requested a review from yuliacech September 6, 2023 17:48

Merge branch 'main' into index_management/overview_tab

580d4de

JoshMock reviewed Sep 6, 2023

View reviewed changes

Merge branch 'main' of github.com:elastic/kibana into index_managemen…

a500fb0

…t/overview_tab

yuliacech approved these changes Sep 7, 2023

View reviewed changes

Merge branch 'main' into index_management/overview_tab

e41004b

mdefazio reviewed Sep 7, 2023

View reviewed changes

sphilipse approved these changes Sep 7, 2023

View reviewed changes

Merge branch 'main' into index_management/overview_tab

3d6215a

Merge branch 'main' into index_management/overview_tab

180ab5d

kibanamachine and others added 2 commits September 8, 2023 08:31

Merge branch 'main' into index_management/overview_tab

e388073

fix TS error

b3a31e3

mdefazio approved these changes Sep 8, 2023

View reviewed changes

alisonelizabeth merged commit 4c2f702 into elastic:main Sep 8, 2023

alisonelizabeth deleted the index_management/overview_tab branch September 8, 2023 14:17

kibanamachine added v8.11.0 backport:skip This PR does not require backporting labels Sep 8, 2023


		const INDEX_NAME_PLACEHOLDER = 'index_name';

		export const curlDefinition: LanguageDefinition = {

Conversation

alisonelizabeth commented Aug 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How to test

Screenshots

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TattdCodeMonkey left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Sep 6, 2023

Uh oh!

alisonelizabeth commented Sep 6, 2023

Uh oh!

JoshMock left a comment

Choose a reason for hiding this comment

Uh oh!

yuliacech left a comment

Choose a reason for hiding this comment

Uh oh!

alisonelizabeth commented Sep 7, 2023

Uh oh!

mdefazio left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yuliacech commented Sep 7, 2023

Uh oh!

sphilipse left a comment

Choose a reason for hiding this comment

Uh oh!

alisonelizabeth commented Sep 7, 2023

Uh oh!

alisonelizabeth commented Sep 7, 2023

Uh oh!

alisonelizabeth commented Sep 8, 2023

Uh oh!

alisonelizabeth commented Sep 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kibana-ci commented Sep 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

History

Uh oh!

mdefazio left a comment

Choose a reason for hiding this comment

Uh oh!

alisonelizabeth commented Sep 8, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

alisonelizabeth commented Aug 23, 2023 •

edited

Loading

mdefazio left a comment •

edited

Loading

alisonelizabeth commented Sep 8, 2023 •

edited

Loading

kibana-ci commented Sep 8, 2023 •

edited

Loading