[Index Management] Add indices list columns to the extensions service #174785

yuliacech · 2024-01-12T17:19:53Z

Summary

This PR adds a function to the extensions service that allows to add new columns to the indices list. The new column can display information that is already available in the index data or a new index data enricher can be registered. See readme for more details.

Screenshot

Example of adding an ILM phase column
86864fe

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

This reverts commit 86864fe.

yuliacech · 2024-01-12T17:20:16Z

/ci

…-fix'

yuliacech · 2024-01-15T17:13:08Z

/ci

elasticmachine · 2024-01-17T10:04:58Z

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

TattdCodeMonkey · 2024-01-17T19:45:47Z

x-pack/plugins/index_management/README.md

@@ -44,6 +54,14 @@ interface IndexContent {
 ```
 - `setIndexMappingsContent(content: IndexContent)`: adds content to the mappings tab of the index details page. The content is displayed in the right bottom corner, below the mappings docs link. 

+## Index data enrichers


TIL, this is great. We should be using this for serverless search.

TattdCodeMonkey · 2024-01-17T19:49:54Z

...gins/index_management/public/application/sections/home/index_list/index_table/index_table.js

-              <span className="eui-textLeft">
-                {this.buildRowCell(fieldName, value, index, appServices)}
-              </span>
+              <span className="eui-textLeft">{this.buildRowCell(index, columnConfig)}</span>


Not needed now, but in the future we may want to allow the columnConfig to optionally override this eui-textLeft class. I'm not sure how often designers would want different alignments for cell content, but in the past I've had to do right alignment for columns with numbers.

Yes, we had some numbers columns right aligned as well. We can add to the column config in the future when needed.

ElenaStoeva

Thanks for working on this @yuliacech! Tested locally adding a column and it worked fine. However, I noticed that clicking the column header doesn't seem to sort the rows properly:

Screen.Recording.2024-01-18.at.16.35.33.mov

Here is how I added the column:

  extensionsService.addColumn({
    label: 'ILM phase',
    fieldName: 'ilm.phase',
    order: 90,
    render: (index: Index) => (index.ilm?.managed ? index.ilm.phase : 'test'),
  });

Would that be possible to be fixed somehow?

yuliacech · 2024-01-18T17:21:30Z

That's right, the sorting doesn't work with the extended columns yet, I'll open an issue for that, thanks for the review @ElenaStoeva!

yuliacech · 2024-01-18T17:28:11Z

Opened #175140 to track the sorting issue @ElenaStoeva
cc @TattdCodeMonkey this could affect the "ingestion method" column as well

…-fix'

ElenaStoeva

That's right, the sorting doesn't work with the extended columns yet, I'll open an issue for that, thanks for the review @ElenaStoeva!

Thanks for clarifying @yuliacech, changes LGTM!

kibana-ci · 2024-01-22T16:59:48Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 4404c85

Failed CI Steps

FTR Configs #24

Test Failures

[job] [logs] FTR Configs #24 / X-Pack Accessibility Tests - Group 1 Dashboard links a11y tests "after all" hook for "Links panel"
[job] [logs] FTR Configs #24 / X-Pack Accessibility Tests - Group 1 Dashboard links a11y tests Non-empty links editor flyout

Metrics [docs]

Async chunks

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

id	before	after	diff
`indexManagement`	586.7KB	587.0KB	+357.0B

Page load bundle

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

id	before	after	diff
`indexManagement`	35.0KB	35.2KB	+130.0B

History

💚 Build #188255 succeeded 029cf8d
💚 Build #187537 succeeded f3f3d18
💔 Build #187281 failed db6cbe6

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

… service (#176163) ## Summary Fixes #175140 Follow up for #174785 This PR fixes the sorting in the indices table for columns added via the extensions service. To test this change, add an ILM phase column as the example in this [commit](90bdf47) and follow the instructions in the ILM plugin [readme](https://github.com/elastic/kibana/blob/04415ce2fc3b302efdace7f391c07047839fb0f1/x-pack/plugins/index_lifecycle_management/README.md#quick-steps-for-testing-ilm-in-index-management). ### Screenshot <img width="1088" alt="Screenshot 2024-02-02 at 18 03 34" src="https://github.com/elastic/kibana/assets/6585477/9f8b9409-ea38-41ed-9e04-636b4f61e8dd"> ### Checklist Delete any items that are not applicable to this PR. - [ ] 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 - [ ] [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 - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] 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) - [ ] 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)) - [ ] 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)

… service (elastic#176163) ## Summary Fixes elastic#175140 Follow up for elastic#174785 This PR fixes the sorting in the indices table for columns added via the extensions service. To test this change, add an ILM phase column as the example in this [commit](elastic@90bdf47) and follow the instructions in the ILM plugin [readme](https://github.com/elastic/kibana/blob/04415ce2fc3b302efdace7f391c07047839fb0f1/x-pack/plugins/index_lifecycle_management/README.md#quick-steps-for-testing-ilm-in-index-management). ### Screenshot <img width="1088" alt="Screenshot 2024-02-02 at 18 03 34" src="https://github.com/elastic/kibana/assets/6585477/9f8b9409-ea38-41ed-9e04-636b4f61e8dd"> ### Checklist Delete any items that are not applicable to this PR. - [ ] 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 - [ ] [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 - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] 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) - [ ] 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)) - [ ] 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)

…elastic#174785) ## Summary This PR adds a function to the extensions service that allows to add new columns to the indices list. The new column can display information that is already available in the index data or a new index data enricher can be registered. See [readme](https://github.com/elastic/kibana/blob/b72c03e9b022e30476969b18b9c0ca5344c5d67c/x-pack/plugins/index_management/README.md) for more details. ### Screenshot Example of adding an ILM phase column elastic@86864fe <img width="1127" alt="Screenshot 2024-01-15 at 18 09 43" src="https://github.com/elastic/kibana/assets/6585477/9502a90b-43e8-45a0-aa44-515585865452"> ### Checklist Delete any items that are not applicable to this PR. - [ ] 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 - [ ] [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 - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] 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) - [ ] 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)) - [ ] 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: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

… service (elastic#176163) ## Summary Fixes elastic#175140 Follow up for elastic#174785 This PR fixes the sorting in the indices table for columns added via the extensions service. To test this change, add an ILM phase column as the example in this [commit](elastic@90bdf47) and follow the instructions in the ILM plugin [readme](https://github.com/elastic/kibana/blob/04415ce2fc3b302efdace7f391c07047839fb0f1/x-pack/plugins/index_lifecycle_management/README.md#quick-steps-for-testing-ilm-in-index-management). ### Screenshot <img width="1088" alt="Screenshot 2024-02-02 at 18 03 34" src="https://github.com/elastic/kibana/assets/6585477/9f8b9409-ea38-41ed-9e04-636b4f61e8dd"> ### Checklist Delete any items that are not applicable to this PR. - [ ] 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 - [ ] [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 - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] 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) - [ ] 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)) - [ ] 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)

yuliacech added 3 commits January 12, 2024 18:16

[Index Management] Add columns configs to the extensions service

9c1edca

[Index Management] Testing: add an ILM phase column

86864fe

Revert "[Index Management] Testing: add an ILM phase column"

db6cbe6

This reverts commit 86864fe.

yuliacech added Feature:Index Management Index and index templates UI Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more release_note:skip Skip the PR/issue when compiling release notes labels Jan 12, 2024

kibanamachine and others added 5 commits January 12, 2024 17:53

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

0571808

…-fix'

Merge branch 'main' into im/indices_list/add_columns

5083138

[Index Management] Add tests

cfdfa19

[Index Management] Update the readme file

b72c03e

[Index Management] Fix the types

f3f3d18

Merge branch 'main' into im/indices_list/add_columns

e3bc5a4

yuliacech marked this pull request as ready for review January 17, 2024 10:04

yuliacech requested a review from a team as a code owner January 17, 2024 10:04

yuliacech requested a review from TattdCodeMonkey January 17, 2024 18:04

TattdCodeMonkey approved these changes Jan 17, 2024

View reviewed changes

ElenaStoeva reviewed Jan 18, 2024

View reviewed changes

Merge branch 'main' into im/indices_list/add_columns

f225e6b

yuliacech mentioned this pull request Jan 18, 2024

[Index Management] Fix the sorting for extended columns in indices list #175140

Closed

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

029cf8d

…-fix'

ElenaStoeva approved these changes Jan 22, 2024

View reviewed changes

Merge branch 'main' into im/indices_list/add_columns

4404c85

yuliacech enabled auto-merge (squash) January 22, 2024 15:46

yuliacech merged commit 16e10e7 into elastic:main Jan 22, 2024
17 checks passed

kibanamachine added v8.13.0 backport:skip This commit does not require backporting labels Jan 22, 2024

yuliacech mentioned this pull request Feb 2, 2024

[Index Management] Add sorting for index columns added via extensions service #176163

Merged

10 tasks

yuliacech deleted the im/indices_list/add_columns branch February 15, 2024 12:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Index Management] Add indices list columns to the extensions service #174785

[Index Management] Add indices list columns to the extensions service #174785

yuliacech commented Jan 12, 2024 •

edited

Loading

yuliacech commented Jan 12, 2024

yuliacech commented Jan 15, 2024

elasticmachine commented Jan 17, 2024

TattdCodeMonkey Jan 17, 2024

TattdCodeMonkey Jan 17, 2024

yuliacech Jan 18, 2024

ElenaStoeva left a comment

yuliacech commented Jan 18, 2024

yuliacech commented Jan 18, 2024

ElenaStoeva left a comment

kibana-ci commented Jan 22, 2024

[Index Management] Add indices list columns to the extensions service #174785

[Index Management] Add indices list columns to the extensions service #174785

Conversation

yuliacech commented Jan 12, 2024 • edited Loading

Summary

Screenshot

Checklist

Risk Matrix

For maintainers

yuliacech commented Jan 12, 2024

yuliacech commented Jan 15, 2024

elasticmachine commented Jan 17, 2024

TattdCodeMonkey Jan 17, 2024

Choose a reason for hiding this comment

TattdCodeMonkey Jan 17, 2024

Choose a reason for hiding this comment

yuliacech Jan 18, 2024

Choose a reason for hiding this comment

ElenaStoeva left a comment

Choose a reason for hiding this comment

yuliacech commented Jan 18, 2024

yuliacech commented Jan 18, 2024

ElenaStoeva left a comment

Choose a reason for hiding this comment

kibana-ci commented Jan 22, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Async chunks

Page load bundle

History

yuliacech commented Jan 12, 2024 •

edited

Loading