[Serverless Search] Index Management - Index Details Overview #173581

TattdCodeMonkey · 2023-12-18T22:15:58Z

Summary

This PR implements a new Overview tab for an Index details in Index Management for Serverless.

It has data panels for information about the index and optional empty states if the index has no documents. (see Screenshots)

Screenshots

Index with data

Index without data

Connector Index without data

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Flaky Test Runner was used on any tests changed
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

.../serverless_search/public/application/components/index_management/connector_setup_prompt.tsx

...lugins/serverless_search/public/application/components/index_management/api_empty_prompt.tsx

...s/serverless_search/public/application/components/index_management/overview_empty_prompt.tsx

x-pack/plugins/serverless_search/public/application/hooks/api/use_create_connector.tsx

...ugins/serverless_search/public/application/components/connectors/empty_connectors_prompt.tsx

.../serverless_search/public/application/components/index_management/connector_empty_prompt.tsx

TattdCodeMonkey · 2023-12-19T17:02:56Z

.../plugins/serverless_search/public/application/components/index_management/index_overview.tsx

+  const [aliasesFlyoutOpen, setAliasesFlyoutOpen] = React.useState<boolean>(false);
+  const { data, isLoading, isError } = useIndex(index.name);
+  const indexAliases =
+    typeof index.aliases === 'string'


this logic could be removed if we add aliases to the fetchIndex endpoint and just always return an array instead of the currently index management behavior or string | string[] including "none" when there are no aliases.

Always returning an array would make more sense to me

leemthompo

Thanks for copy ping @TattdCodeMonkey

...lugins/serverless_search/public/application/components/index_management/api_empty_prompt.tsx

...s/serverless_search/public/application/components/index_management/overview_empty_prompt.tsx

TattdCodeMonkey · 2023-12-19T17:53:36Z

@sphilipse any ideas on what in this PR made the bundle size 439.4KB ?

sphilipse

couple nits but looks good overall

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

.../serverless_search/public/application/components/index_management/connector_empty_prompt.tsx

sphilipse · 2023-12-19T18:08:32Z

.../plugins/serverless_search/public/application/components/index_management/index_overview.tsx

+  const [aliasesFlyoutOpen, setAliasesFlyoutOpen] = React.useState<boolean>(false);
+  const { data, isLoading, isError } = useIndex(index.name);
+  const indexAliases =
+    typeof index.aliases === 'string'


Always returning an array would make more sense to me

.../plugins/serverless_search/public/application/components/index_management/index_overview.tsx

sphilipse · 2023-12-19T18:13:15Z

x-pack/plugins/serverless_search/server/lib/indices/fetch_index.ts

+  client: ElasticsearchClient,
+  indexName: string
+): Promise<FetchIndexResult | undefined> {
+  const [indexData, indexStats, indexCount, connector] = await Promise.all([


question: What happens if the index doesn't exist or Elasticsearch throws an error for a different reason (temporarily unavailable shards or whatever)?

any error in any of these cause with cause this function to throw... which is not exactly ideal.

In practice currently if the index doesn't exist the frontend will never call this endpoint since the index management page will render an error and never render our detail component. BUT that not really good enough for this endpoint to have such poor error handling.

So how should we handle intermittent errors in serverless endpoints? we have utility functions in enterprise_search to catch errors from library functions and return errors to the frontend. We haven't gotten that far in serverless search yet.

I don't mind just surfacing the underlying Elasticsearch error. The reason we have those obfuscating errors in Search is that Enterprise Search can leak information we don't want to leak, but that's not really an issue for this.

Could we use .allSettled() instead of .all() so we return partial information when one call fails?

using .allSettled() is fine with me, will update.

I updated this. My only concern is we're now swallowing errors if any of these calls fail (other than the get index) and we're not logging anything. which is something we should address later.

sphilipse · 2023-12-19T18:15:53Z

@TattdCodeMonkey looks like you pulled what was a lazy-loaded chunk into the initial page load bundle. Probably connectors got pulled into the main chunk instead of being lazy-loaded.

.../serverless_search/public/application/components/index_management/connector_empty_prompt.tsx

Importing the connector route paths from the router was causing our async chunks to explode in size. Moving these to the constants file instead resolved the chunking issue.

TattdCodeMonkey · 2023-12-19T22:31:24Z

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

+export const BadgeList = ({ badges, maxBadgesToDisplay }: BadgeListProps) => {
+  const maxBadges = maxBadgesToDisplay ?? 3;
+  if (badges.length === 0) {
+    return <></>;


I'm not sure why I did this vs. return null; but googling it it seems returning is fragment is possibly preferable for TS since the result is always JSX.Element instead of JSX.Element | null

TattdCodeMonkey · 2023-12-20T21:06:05Z

@elasticmachine merge upstream

kibana-ci · 2023-12-20T22:10:34Z

💚 Build Succeeded

Buildkite Build
Commit: c9bad07

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`serverlessSearch`	326	336	+10

Async chunks

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

id	before	after	diff
`serverlessSearch`	379.0KB	424.8KB	+45.8KB

Page load bundle

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

id	before	after	diff
`serverlessSearch`	71.1KB	55.4KB	-15.7KB

Unknown metric groups

async chunk count

id	before	after	diff
`serverlessSearch`	4	7	+3

ESLint disabled line counts

id	before	after	diff
`serverlessSearch`	4	6	+2

Total ESLint disabled count

id	before	after	diff
`serverlessSearch`	4	6	+2

History

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

TattdCodeMonkey added 3 commits December 18, 2023 22:01

added ingestDataIndex handlers for java and dotnet

a5e4605

fetch index route with aggregated index data

b228343

feat(es3): index details overview

7f3d6eb

TattdCodeMonkey added release_note:skip Skip the PR/issue when compiling release notes Team:Search v8.13.0 labels Dec 18, 2023

TattdCodeMonkey requested a review from a team December 18, 2023 22:15

TattdCodeMonkey commented Dec 19, 2023

View reviewed changes

leemthompo reviewed Dec 19, 2023

View reviewed changes

add back button translations

72ca1d9

copy updates

71aba1d

sphilipse reviewed Dec 19, 2023

View reviewed changes

TattdCodeMonkey added 6 commits December 19, 2023 19:30

use back constant translation

ff99d96

fix BadgeListProps typo

4feab6d

update Index copy to prefer lowercasing

3f1afa0

prepend connector route with http base path

654dbef

import just connector type

4b6d464

sep index overview component from render function

12a4b12

TattdCodeMonkey commented Dec 19, 2023

View reviewed changes

.../serverless_search/public/application/components/index_management/connector_empty_prompt.tsx Show resolved Hide resolved

move paths to constants file

429793f

Importing the connector route paths from the router was causing our async chunks to explode in size. Moving these to the constants file instead resolved the chunking issue.

TattdCodeMonkey commented Dec 19, 2023

View reviewed changes

sphilipse approved these changes Dec 20, 2023

View reviewed changes

TattdCodeMonkey added 3 commits December 20, 2023 19:06

lazy load index overview component

9b3caf5

lazy load index documents component

d9ac99c

return partial results if fetchIndex client calls reject

f7f5e3a

TattdCodeMonkey enabled auto-merge (squash) December 20, 2023 19:56

Merge branch 'main' into rnorris/es3-index-detail-overview

c9bad07

TattdCodeMonkey merged commit 5798255 into elastic:main Dec 20, 2023
35 checks passed

kibanamachine added the backport:skip This commit does not require backporting label Dec 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Serverless Search] Index Management - Index Details Overview #173581

[Serverless Search] Index Management - Index Details Overview #173581

TattdCodeMonkey commented Dec 18, 2023

TattdCodeMonkey Dec 19, 2023

sphilipse Dec 19, 2023

leemthompo left a comment

TattdCodeMonkey commented Dec 19, 2023

sphilipse left a comment

sphilipse Dec 19, 2023

sphilipse Dec 19, 2023

TattdCodeMonkey Dec 19, 2023

sphilipse Dec 20, 2023

TattdCodeMonkey Dec 20, 2023

TattdCodeMonkey Dec 20, 2023

sphilipse commented Dec 19, 2023

TattdCodeMonkey Dec 19, 2023 •

edited

Loading

TattdCodeMonkey commented Dec 20, 2023

kibana-ci commented Dec 20, 2023

async chunk count

ESLint disabled line counts

Total ESLint disabled count

[Serverless Search] Index Management - Index Details Overview #173581

[Serverless Search] Index Management - Index Details Overview #173581

Conversation

TattdCodeMonkey commented Dec 18, 2023

Summary

Screenshots

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leemthompo left a comment

Choose a reason for hiding this comment

TattdCodeMonkey commented Dec 19, 2023

sphilipse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sphilipse commented Dec 19, 2023

TattdCodeMonkey Dec 19, 2023 • edited Loading

Choose a reason for hiding this comment

TattdCodeMonkey commented Dec 20, 2023

kibana-ci commented Dec 20, 2023

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

async chunk count

ESLint disabled line counts

Total ESLint disabled count

History

TattdCodeMonkey Dec 19, 2023 •

edited

Loading