Surface data stream stats, index template, and ILM policy in the UI #75107

cjcenizal · 2020-08-14T23:32:39Z

Release note

The Data Streams tab in Index Management now allows users to view additional information for data streams:

Health
Storage size on disk
Timestamp the data stream was last updated
The index template that configures the data stream's indices
The index lifecycle policy that manages the data stream's lifecycle

Testing

To test this PR, create a data stream and then view it in the UI:

PUT _index_template/ds
{
  "index_patterns": ["ds"],
  "data_stream": {},
  "template": {
    "settings": {
      "index.lifecycle.name": "kibana-event-log-policy"
    }
  }
}

POST ds/_doc
{
  "@timestamp": "2020-01-27"
}

- Extract out DataHealth component for use in both Data Streams and Indices tabs. - Refactor detail panel to use data structure & algo to build component. - Refactor detail panel to use i18n.translate instead of FormattedMessage.

…ail panel.

… panel. - Add 'Include stats' switch. - Add humanizeTimeStamp service, localized to data streams.

elasticmachine · 2020-08-16T20:01:09Z

Pinging @elastic/es-ui (Team:Elasticsearch UI)

cjcenizal · 2020-08-16T20:01:14Z

@elasticmachine merge upstream

cjcenizal · 2020-08-18T02:31:53Z

@elasticmachine merge upstream

cjcenizal · 2020-08-18T03:36:20Z

@elasticmachine merge upstream

cjcenizal · 2020-08-20T21:55:52Z

@elasticmachine merge upstream

alisonelizabeth

Nice job @cjcenizal! LGTM. Tested locally. I left a few non-blocking comments.

alisonelizabeth · 2020-08-21T13:22:14Z

x-pack/plugins/index_management/README.md

@@ -0,0 +1,22 @@
+# Index Management UI


Thanks for adding this!

alisonelizabeth · 2020-08-21T13:26:48Z

x-pack/plugins/index_management/__jest__/client_integration/home/data_streams_tab.helpers.ts


+  const clickIncludeStatsSwitch = () => {
+    const { find } = testBed;
+    find('includeStatsSwitch').simulate('click');


[nit] The test lib does provide toggleEuiSwitch, which checks for the existence of the element before simulating click.

https://github.com/elastic/kibana/blob/master/src/test_utils/public/testbed/testbed.ts#L246

Thanks! I'll convert this to use toggleEuiSwitch.

alisonelizabeth · 2020-08-21T13:37:28Z

...ication/sections/home/data_stream_list/data_stream_detail_panel/data_stream_detail_panel.tsx

+        }),
+        content:
+          ilmPolicyName ??
+          i18n.translate('xpack.idxMgmt.dataStreamDetailPanel.ilmPolicyContentNoneMessage', {


does this need i18n?

Probably not 😄 I'll remove it. Good spot!

alisonelizabeth · 2020-08-21T13:42:37Z

x-pack/plugins/index_management/server/routes/api/data_streams/register_get_route.ts

 import { RouteDependencies } from '../../../types';
 import { addBasePath } from '../index';

+// Require the template format version (V1 or V2) to be provided as Query param


Wrong comment? 😄

Oops, right

alisonelizabeth · 2020-08-21T13:48:57Z

x-pack/test/api_integration/apis/management/index_management/data_streams.ts

+    // type, and then remove it.
+    expect(dataStream.storageSize).to.be.ok();
+    expect(typeof dataStream.storageSize).to.be('string');
+    delete dataStream.storageSize;


~~Can you explain why storageSize needs to be deleted?~~ Never mind I understand now based on your comment above. It does feel a little strange to delete it though in a test. Could you do something like this instead?

const { storageSize, ....response } = dataStream;

and assert against response?

Good idea! Will do.

alisonelizabeth · 2020-08-21T14:07:34Z

...ns/index_management/public/application/sections/home/data_stream_list/humanize_time_stamp.ts

+
+import moment from 'moment';
+
+export const humanizeTimeStamp = (timeStamp?: number): string =>


should timeStamp be required?

Great spot! Will fix.

…kibana into data-streams/related-entities

cjcenizal · 2020-08-21T21:57:26Z

@alisonelizabeth I ended up rendering "None" instead of a dash for when data is missing. I think this will be more useful for screen readers and for other locales.

kibanamachine · 2020-08-22T00:51:42Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: e1f3263

Build metrics

@kbn/optimizer bundle module count

id	value	diff	baseline
indexManagement	500	+1	499

async chunks size

id	value	diff	baseline
indexManagement	1.6MB	+5.9KB	1.5MB

page load bundle size

id	value	diff	baseline
indexManagement	248.1KB	-91.0B	248.1KB

History

💔 Build #69830 failed c1b7ccb
💚 Build #69551 succeeded 74ec4ba
💚 Build #68917 succeeded cf00feb
💔 Build #68791 failed b9e5c81
💔 Build #68641 failed a367682

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

…75107) (#75713) * Add Index Management README and quick testing steps for data streams. * Surface data stream health in Data Streams tab (table and detail panel). - Extract out DataHealth component for use in both Data Streams and Indices tabs. - Refactor detail panel to use data structure & algo to build component. - Refactor detail panel to use i18n.translate instead of FormattedMessage. * Render index template name and index lifecycle policy name in the detail panel. * Render storage size and max timestamp information in table and detail panel. - Add 'Include stats' switch. - Add humanizeTimeStamp service, localized to data streams.

cjcenizal added 6 commits August 14, 2020 16:22

Add Index Management README and quick testing steps for data streams.

6b36cba

Render index template name and index lifecycle policy name in the det…

07de0bc

…ail panel.

Render storage size and max timestamp information in table and detail…

23e1961

… panel. - Add 'Include stats' switch. - Add humanizeTimeStamp service, localized to data streams.

Update API integration tests.

f27db14

Add client integration test for 'Include stats' switch.

a01d4e2

cjcenizal added release_note:enhancement Feature:Index Management Index and index templates UI v8.0.0 Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more t// v7.10.0 labels Aug 14, 2020

cjcenizal marked this pull request as ready for review August 16, 2020 20:01

cjcenizal requested a review from a team as a code owner August 16, 2020 20:01

Merge branch 'master' into data-streams/related-entities

ef2b801

elasticmachine and others added 3 commits August 17, 2020 21:36

Merge branch 'master' into data-streams/related-entities

a367682

Update code exploration docs.

b9e5c81

Fix i18n and type check error.

cf00feb

cjcenizal requested a review from alisonelizabeth August 18, 2020 21:42

Merge branch 'master' into data-streams/related-entities

74ec4ba

alisonelizabeth approved these changes Aug 21, 2020

View reviewed changes

alisonelizabeth reviewed Aug 21, 2020

View reviewed changes

cjcenizal added 2 commits August 21, 2020 14:55

Address Alison's feedback.

fba53d7

Merge branch 'data-streams/related-entities' of github.com:cjcenizal/…

c1b7ccb

…kibana into data-streams/related-entities

Fix type check error.

e1f3263

cjcenizal merged commit 50499a5 into elastic:master Aug 22, 2020

cjcenizal deleted the data-streams/related-entities branch August 22, 2020 00:53

cjcenizal mentioned this pull request Aug 22, 2020

[7.x] Surface data stream stats, index template, and ILM policy in the UI (#75107) #75713

Merged


		import moment from 'moment';

		export const humanizeTimeStamp = (timeStamp?: number): string =>

Surface data stream stats, index template, and ILM policy in the UI #75107

Surface data stream stats, index template, and ILM policy in the UI #75107

Uh oh!

Conversation

cjcenizal commented Aug 14, 2020

Release note

Testing

Uh oh!

elasticmachine commented Aug 16, 2020

Uh oh!

cjcenizal commented Aug 16, 2020

Uh oh!

cjcenizal commented Aug 18, 2020

Uh oh!

cjcenizal commented Aug 18, 2020

Uh oh!

cjcenizal commented Aug 20, 2020

Uh oh!

alisonelizabeth left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alisonelizabeth Aug 21, 2020 • 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!

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!

cjcenizal commented Aug 21, 2020

Uh oh!

kibanamachine commented Aug 22, 2020

💚 Build Succeeded

Build metrics

@kbn/optimizer bundle module count

async chunks size

page load bundle size

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

alisonelizabeth Aug 21, 2020 •

edited

Loading