[ILM] New copy for rollover and small refactor for timeline by jloleysens · Pull Request #89422 · elastic/kibana

jloleysens · 2021-01-27T14:30:02Z

Summary

Added copy to explain that rollover adds variation in how long data will be in the hot phase
Refactored Timeline component to be memoized
Factored out a small component in the Timeline component's file to it's own file (timeline_phase_text.tsx)
Refactored (renaming) functions in the absolute -> relative timing lib files - no logic changes and all test coverage still intact
Updated comments

Please note: copy in screenshots may be out-of-date.

Review

ES UI

Start Kibana on basic license (yarn start)
Go to ILM
Open or create a new policy (assuming that rollover is on for the given policy, should be on for new policies)
Expand the hot phase settings and check that the new rollover copy is visible
Check that the timeline has an icon in the hot phase
Check that the tooltip renders on hover
Turn rollover off, the copy in settings should still be visible, the tooltip in the timeline should not be visible

Copy/Docs

New copy was added, specifically in

x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/i18n_texts.ts
x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/timeline/timeline.tsx

Design

@mdefazio I'd like to hear your thoughts on the approach of adding the tooltip in the timeline. Do you think this could work?

Screenshots

Added copy regarding rollover to settings

Calling out rollover on timeline (only when it is active), tooltip closed

Calling out rollover on timeline (only when it is active), tooltip open

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Add component integration tests

…tside of edit_policy section

…lean up public API for relative timing calculation

elasticmachine · 2021-01-27T14:30:37Z

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

…updates-and-timeline-cleanup * 'master' of github.com:elastic/kibana: (44 commits) [Discover] Add grid flyout jest test (elastic#89088) [Search Sessions] Improve session restoration back button (elastic#87635) [TSVB] Remove vis_type_timeseries_enhanced plugin (elastic#89274) [Security Solution] Init Osquery plugin (elastic#87109) [Fleet] Do not defined aliases inside datastream template (elastic#89512) skip flaky suite (elastic#86950) chore(NA): bazel machinery installation on kbn bootstrap (elastic#89469) [build/docker] Add support for centos ARM builds (elastic#84831) Convert default_watch.json to a JS object in order to avoid TS complaints (elastic#89488) [CI] Decrease number of Jest workers (elastic#89504) [Maps] remove maps_oss TS project (elastic#89502) Adds migration settings to Docker (elastic#89501) [Lens] Fix crash in transition from unique count to last value (elastic#88916) [kbn-es] Always use bundled JDK when starting Elasticsearch (elastic#89437) unskip getting_started/shakespeare test elasticsearch 64016 (elastic#89346) [Maps] migrate maps, maps_file_upload, and maps_legacy_licensing to TS projects (elastic#89439) skip flaky suite (elastic#89478) skip flaky suite (elastic#89476) skip flaky suite (elastic#89477) skip flaky suite (elastic#89475) ... # Conflicts: # x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/components/phases/hot_phase/hot_phase.tsx # x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/lib/absolute_timing_to_relative_timing.ts

mdefazio

LGTM!

yuliacech

Hi @jloleysens , tested locally and everything looks good, thanks for adding this rollover warning!

debadair

Provided a couple suggestions to get around the awkwardness of "data age" and "variation to time".

debadair · 2021-01-29T00:37:56Z

...ifecycle_management/public/application/sections/edit_policy/components/timeline/timeline.tsx

+    'xpack.indexLifecycleMgmt.timeline.hotPhaseRolloverToolTipContent',
+    {
+      defaultMessage:
+        'Data age is only considered after rollover has occurred which adds variation to time in hot phase. See hot phase settings.',


I think this could be clearer. It seems like you're trying to make two different points:

The min_age for moving to the next phase is based on the elapsed time since rollover, not the absolute age of the data.

The total time spent in the hot phase can vary depending on what triggers the rollover.

That's a lot to pack into a tooltip. :-) Maybe:

Suggested change

'Data age is only considered after rollover has occurred which adds variation to time in hot phase. See hot phase settings.',

'How long it takes to reach the rollover criteria in the hot phase can vary. Data moves to the next phase when the time since rollover reaches the minimum age.',

debadair · 2021-01-29T00:49:14Z

x-pack/plugins/index_lifecycle_management/public/application/sections/edit_policy/i18n_texts.ts

+          'When rollover is active, data age is only considered after rollover has occurred which adds variation to time in hot phase.',
+      }


I think I'd just re-use the previous suggestion, the qualifier isn't necessary.

Suggested change

'When rollover is active, data age is only considered after rollover has occurred which adds variation to time in hot phase.',

}

'How long it takes to reach the rollover criteria in the hot phase can vary.

Data moves to the next phase when the time since rollover reaches the minimum age.',

}

jloleysens · 2021-01-29T11:22:13Z

@elasticmachine merge upstream

…line

jloleysens · 2021-01-29T13:09:19Z

Thanks for the reviews all!

@debadair I've implemented your suggestions, would you mind taking another look?

debadair

LGTM!

jloleysens · 2021-02-01T08:29:38Z

@elasticmachine merge upstream

kibanamachine · 2021-02-01T10:11:32Z

💚 Build Succeeded

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

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`indexLifecycleManagement`	170	173	+3

Async chunks

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

id	before	after	diff
`indexLifecycleManagement`	225.5KB	228.1KB	+2.7KB

History

💚 Build #102119 succeeded 583908a
💚 Build #102113 succeeded 014d0ee
💚 Build #102097 succeeded 9f6bc9f
💚 Build #101709 succeeded 1265afd
💔 Build #101704 failed 494a041

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

…89422) * refactor timeline and relative ms calculation logic for easier use outside of edit_policy section * further refactor, move child component to own file in timeline, and clean up public API for relative timing calculation * added copy to call out variation in timing (slop) introduced by rollover * use separate copy for timeline * remove unused import * fix unresolved merge * implement copy feedback * added component integration for showing/hiding hot phase icon on timeline Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

…89840) * refactor timeline and relative ms calculation logic for easier use outside of edit_policy section * further refactor, move child component to own file in timeline, and clean up public API for relative timing calculation * added copy to call out variation in timing (slop) introduced by rollover * use separate copy for timeline * remove unused import * fix unresolved merge * implement copy feedback * added component integration for showing/hiding hot phase icon on timeline Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

jloleysens added 3 commits January 27, 2021 14:48

refactor timeline and relative ms calculation logic for easier use ou…

9eeb85c

…tside of edit_policy section

further refactor, move child component to own file in timeline, and c…

075120d

…lean up public API for relative timing calculation

added copy to call out variation in timing (slop) introduced by rollover

6c1b754

jloleysens requested review from mdefazio and yuliacech January 27, 2021 14:30

jloleysens requested a review from a team as a code owner January 27, 2021 14:30

jloleysens added Feature:ILM release_note:skip Skip the PR/issue when compiling release notes Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more t// v7.12.0 v8.0.0 labels Jan 27, 2021

jloleysens added 4 commits January 27, 2021 15:44

use separate copy for timeline

0e1cf77

remove unused import

353bcdb

fix unresolved merge

1265afd

mdefazio approved these changes Jan 28, 2021

View reviewed changes

yuliacech approved these changes Jan 28, 2021

View reviewed changes

debadair suggested changes Jan 29, 2021

View reviewed changes

kibanamachine and others added 2 commits January 29, 2021 06:22

Merge branch 'master' into ilm/rollover-updates-and-timeline-cleanup

9f6bc9f

implement copy feedback

014d0ee

jloleysens mentioned this pull request Jan 29, 2021

[ILM] Delete phase redesign #89451

Closed

4 tasks

added component integration for showing/hiding hot phase icon on time…

583908a

…line

jloleysens requested a review from a team as a code owner January 29, 2021 13:08

myasonik approved these changes Jan 29, 2021

View reviewed changes

debadair approved these changes Jan 29, 2021

View reviewed changes

Merge branch 'master' into ilm/rollover-updates-and-timeline-cleanup

5974687

jloleysens merged commit 61a51b5 into elastic:master Feb 1, 2021

jloleysens deleted the ilm/rollover-updates-and-timeline-cleanup branch February 1, 2021 10:14

jloleysens mentioned this pull request Feb 1, 2021

[7.x] [ILM] New copy for rollover and small refactor for timeline (#89422) #89840

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ILM] New copy for rollover and small refactor for timeline#89422

[ILM] New copy for rollover and small refactor for timeline#89422
jloleysens merged 11 commits intoelastic:masterfrom
jloleysens:ilm/rollover-updates-and-timeline-cleanup

jloleysens commented Jan 27, 2021 •

edited

Loading

Uh oh!

elasticmachine commented Jan 27, 2021

Uh oh!

mdefazio left a comment

Uh oh!

yuliacech left a comment

Uh oh!

debadair left a comment

Uh oh!

debadair Jan 29, 2021

Uh oh!

debadair Jan 29, 2021

Uh oh!

jloleysens commented Jan 29, 2021

Uh oh!

jloleysens commented Jan 29, 2021

Uh oh!

debadair left a comment

Uh oh!

jloleysens commented Feb 1, 2021

Uh oh!

kibanamachine commented Feb 1, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

	'Data age is only considered after rollover has occurred which adds variation to time in hot phase. See hot phase settings.',
	'How long it takes to reach the rollover criteria in the hot phase can vary. Data moves to the next phase when the time since rollover reaches the minimum age.',

		'When rollover is active, data age is only considered after rollover has occurred which adds variation to time in hot phase.',
		}

-          'When rollover is active, data age is only considered after rollover has occurred which adds variation to time in hot phase.',
-      }
+          'How long it takes to reach the rollover criteria in the hot phase can vary.
+Data moves to the next phase when the time since rollover reaches the minimum age.',
+      }

Conversation

jloleysens commented Jan 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Review

ES UI

Copy/Docs

Design

Screenshots

Added copy regarding rollover to settings

Calling out rollover on timeline (only when it is active), tooltip closed

Calling out rollover on timeline (only when it is active), tooltip open

Checklist

Uh oh!

elasticmachine commented Jan 27, 2021

Uh oh!

mdefazio 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!

debadair left a comment

Choose a reason for hiding this comment

Uh oh!

debadair Jan 29, 2021

Choose a reason for hiding this comment

Uh oh!

debadair Jan 29, 2021

Choose a reason for hiding this comment

Uh oh!

jloleysens commented Jan 29, 2021

Uh oh!

jloleysens commented Jan 29, 2021

Uh oh!

debadair left a comment

Choose a reason for hiding this comment

Uh oh!

jloleysens commented Feb 1, 2021

Uh oh!

kibanamachine commented Feb 1, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

jloleysens commented Jan 27, 2021 •

edited

Loading