Make Indices discoverable in Kibana Global Search #175473

Samiul-TheSoccerFan · 2024-01-24T19:54:55Z

Summary

Added a search provider to return only visible indices and land in the overview page once clicked or selected.

No indices available

Matched index shows up

Shows all matched index

Checklist

Delete any items that are not applicable to this PR.

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)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk	Probability	Severity	Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space.	Low	High	Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks.	High	Low	Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled.	Medium	High	Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

This was checked for breaking API changes and was labeled appropriately

Samiul-TheSoccerFan · 2024-01-25T16:38:02Z

@elasticmachine merge upstream

elasticmachine · 2024-01-26T12:58:04Z

Pinging @elastic/appex-sharedux (Team:SharedUX)

vadimkibana

Passing ES client through Global Search context LGTM.

x-pack/plugins/enterprise_search/server/utils/indices_search_result_provider.ts

sphilipse

I have one general concern with this PR and that is the potential poor search performance/cluster degradation on clusters with many indices. Have we tried to see what the performance is like in cases with a very large number of indices?

Samiul-TheSoccerFan · 2024-01-26T21:31:58Z

I have one general concern with this PR and that is the potential poor search performance/cluster degradation on clusters with many indices. Have we tried to see what the performance is like in cases with a very large number of indices?

I have not tested this code against a large number of indices. Is there a way to automatically generated a large number of indices and/or to test against any benchmark system?
cc: @sphilipse

sphilipse · 2024-01-26T21:41:47Z

I have one general concern with this PR and that is the potential poor search performance/cluster degradation on clusters with many indices. Have we tried to see what the performance is like in cases with a very large number of indices?

I have not tested this code against a large number of indices. Is there a way to automatically generated a large number of indices and/or to test against any benchmark system? cc: @sphilipse

Not that I know of, but setting up a script to do this should be doable.

x-pack/plugins/translations/translations/fr-FR.json

sphilipse · 2024-02-12T10:49:20Z

x-pack/plugins/global_search/server/types.ts

+   * A ES client of type IScopedClusterClient is passed to the `find` call.
+   * When performing calls to ES, the interested provider can utilize this parameter to identify the specific cluster.
+   */
+  client?: IScopedClusterClient;


nitpicking here, but I think it's neater to pass the concrete Elasticsearch Client with permissions (so the result of client.asCurrentUser) instead of the cluster client which still needs to choose between asCurrentUser and asInternalUser, if possible?

get_index_data expects a ClusterClient in here and that is why I kept it as clusterClient. Should I write a different method which expects only currentUser?

We should probably pass that function an ElasticsearchClient in all of its usages, but maybe that's too much effort for this PR.

fetch_indices and indices_search_results_providers* both is using this function and probably their related test files. So not much, however, then we should update getSearchIndexData function and its usage too.

Is it okay if I create a separate small PR to handle this update for both functions?

@sphilipse : Can I get an approval if everything looks good?

Samiul-TheSoccerFan · 2024-02-12T13:39:37Z

@elasticmachine merge upstream

kibana-ci · 2024-02-12T14:51:11Z

💚 Build Succeeded

Buildkite Build
Commit: 6d64980

Metrics [docs]

Page load bundle

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

id	before	after	diff
`globalSearchBar`	27.4KB	27.4KB	+27.0B

Unknown metric groups

API count

id	before	after	diff
`globalSearch`	68	72	+4

History

💚 Build #192756 succeeded 6c9e46a
💔 Build #192698 failed c2ae589c352d5622bc3255f917fd4f4dbfae3588
💛 Build #189389 was flaky 10c358a549bf9a00e9b86889d0ba52ebfc25f1b3
💚 Build #189164 succeeded 457cd1fbf64880c23ae1b57f4e66ce9d2816c504
💔 Build #189121 failed e3e58944ba07dfa30f316b7a12d03a7956806e6a
💔 Build #189118 failed 2e6047f3c189fe0c79bb3f4785caa0593dfa56de

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

cc @Samiul-TheSoccerFan

## Summary Added a search provider to return only visible indices and land in the overview page once clicked or selected. ### No indices available <img width="1046" alt="Screenshot 2024-01-24 at 2 48 58 PM" src="https://github.com/elastic/kibana/assets/150824886/82d5a997-2d0b-42e0-8818-2f4b83170230"> ### Matched index shows up <img width="920" alt="Screenshot 2024-01-24 at 2 42 13 PM" src="https://github.com/elastic/kibana/assets/150824886/59bd676c-f5c3-4b10-a1ae-cd8b4008c81e"> ### Shows all matched index <img width="1048" alt="Screenshot 2024-01-24 at 2 50 09 PM" src="https://github.com/elastic/kibana/assets/150824886/30877185-ac9c-4fe2-b859-d597dd3941b1"> ### Checklist Delete any items that are not applicable to this PR. - [X] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [x] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [x] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [x] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [x] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Samiul-TheSoccerFan requested a review from a team as a code owner January 24, 2024 19:54

Samiul-TheSoccerFan requested a review from a team January 24, 2024 19:54

Samiul-TheSoccerFan self-assigned this Jan 24, 2024

Samiul-TheSoccerFan added v8.13.0 release_note:skip Skip the PR/issue when compiling release notes Team:EnterpriseSearch labels Jan 24, 2024

Samiul-TheSoccerFan force-pushed the search-index-in-kibana-search branch from 2e6047f to e3e5894 Compare January 24, 2024 20:10

Samiul-TheSoccerFan added the Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) label Jan 26, 2024

vadimkibana approved these changes Jan 26, 2024

View reviewed changes

TattdCodeMonkey reviewed Jan 26, 2024

View reviewed changes

x-pack/plugins/enterprise_search/server/utils/indices_search_result_provider.ts Outdated Show resolved Hide resolved

x-pack/plugins/enterprise_search/server/utils/indices_search_result_provider.ts Outdated Show resolved Hide resolved

sphilipse reviewed Jan 26, 2024

View reviewed changes

JoseLuisGJ mentioned this pull request Feb 1, 2024

[EuiIcon] Index glyph elastic/eui#7498

Merged

4 tasks

Samiul-TheSoccerFan added 5 commits February 9, 2024 10:47

ES client object added in find function to enable providers to call ES

b58b21f

registered a provider to return indices to show up in global search

0b74d3b

Fix linting errors in enterprise_search

62f31b8

Fix integration tests for find function

b35b841

Setting searchoptimization to false as we need to match with search term

944e05d

Samiul-TheSoccerFan force-pushed the search-index-in-kibana-search branch from 10c358a to c2ae589 Compare February 9, 2024 21:25

Samiul-TheSoccerFan requested review from TattdCodeMonkey, sphilipse and kderusso February 9, 2024 21:27

TattdCodeMonkey reviewed Feb 9, 2024

View reviewed changes

x-pack/plugins/translations/translations/fr-FR.json Outdated Show resolved Hide resolved

Added svg, icon path in the search results and refine search term

6c9e46a

Samiul-TheSoccerFan force-pushed the search-index-in-kibana-search branch from c2ae589 to 6c9e46a Compare February 11, 2024 17:15

sphilipse reviewed Feb 12, 2024

View reviewed changes

Merge branch 'main' into search-index-in-kibana-search

6d64980

sphilipse approved these changes Feb 12, 2024

View reviewed changes

Samiul-TheSoccerFan merged commit 459dff1 into elastic:main Feb 12, 2024
17 checks passed

kibanamachine added the backport:skip This commit does not require backporting label Feb 12, 2024

Samiul-TheSoccerFan deleted the search-index-in-kibana-search branch February 12, 2024 15:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make Indices discoverable in Kibana Global Search #175473

Make Indices discoverable in Kibana Global Search #175473

Samiul-TheSoccerFan commented Jan 24, 2024 •

edited

Loading

Samiul-TheSoccerFan commented Jan 25, 2024

elasticmachine commented Jan 26, 2024

vadimkibana left a comment

sphilipse left a comment

Samiul-TheSoccerFan commented Jan 26, 2024 •

edited

Loading

sphilipse commented Jan 26, 2024

sphilipse Feb 12, 2024

Samiul-TheSoccerFan Feb 12, 2024

sphilipse Feb 12, 2024

Samiul-TheSoccerFan Feb 12, 2024

sphilipse Feb 12, 2024

Samiul-TheSoccerFan Feb 12, 2024

Samiul-TheSoccerFan commented Feb 12, 2024

kibana-ci commented Feb 12, 2024

API count

Make Indices discoverable in Kibana Global Search #175473

Make Indices discoverable in Kibana Global Search #175473

Conversation

Samiul-TheSoccerFan commented Jan 24, 2024 • edited Loading

Summary

No indices available

Matched index shows up

Shows all matched index

Checklist

Risk Matrix

For maintainers

Samiul-TheSoccerFan commented Jan 25, 2024

elasticmachine commented Jan 26, 2024

vadimkibana left a comment

Choose a reason for hiding this comment

sphilipse left a comment

Choose a reason for hiding this comment

Samiul-TheSoccerFan commented Jan 26, 2024 • edited Loading

sphilipse commented Jan 26, 2024

sphilipse Feb 12, 2024

Choose a reason for hiding this comment

Samiul-TheSoccerFan Feb 12, 2024

Choose a reason for hiding this comment

sphilipse Feb 12, 2024

Choose a reason for hiding this comment

Samiul-TheSoccerFan Feb 12, 2024

Choose a reason for hiding this comment

sphilipse Feb 12, 2024

Choose a reason for hiding this comment

Samiul-TheSoccerFan Feb 12, 2024

Choose a reason for hiding this comment

Samiul-TheSoccerFan commented Feb 12, 2024

kibana-ci commented Feb 12, 2024

💚 Build Succeeded

Metrics [docs]

Page load bundle

API count

History

Samiul-TheSoccerFan commented Jan 24, 2024 •

edited

Loading

Samiul-TheSoccerFan commented Jan 26, 2024 •

edited

Loading