[ML] Configure sorting for partition values on Single Metric Viewer #81510

darnautov · 2020-10-22T16:49:45Z

Summary

Resolves #69526.

Allows configuring entities dropdowns individually on the Single Metric Viewer with the following parameters:

Anomalous only
Sort by anomaly score or name
Sorting order

By default shows only anomalous values, sorting descending by the record score.

In case "Anomalous only" is disabled there are two possible scenarios:

Model plot is disabled, so we remove time boundaries from the query showing values for all existing records. The info icon provides an explanation about suggested options.
Model plot is enabled, hence we look up for model plot results, disabling sorting by the anomaly score. The info icon shows another helper text in this case.

Also, show a color indicator for each option based on the max anomaly score for the value. In case the model plot is enabled and not only anomalous values have been requested an indicator is not presented.

The configuration is stored in the browser's local storage under ml.singleMetricViewer.partitionFields key.

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

… support for partition config

…partition-sorting # Conflicts: # x-pack/plugins/ml/public/application/timeseriesexplorer/components/entity_control/entity_control.tsx

elasticmachine · 2020-10-27T13:13:50Z

Pinging @elastic/ml-ui (:ml)

tveasey

I've mainly focused on the logic to construct the filters and the queries since I don't know the code base that well. I think you have the condition on filtering to the selected time range back to front, but otherwise looks good.

x-pack/plugins/ml/server/models/results_service/get_partition_fields_values.ts

tveasey

LGTM

pheyos

Functional tests LGTM

….tsx

...plugins/ml/public/application/timeseriesexplorer/components/entity_control/entity_config.tsx

x-pack/plugins/ml/public/application/timeseriesexplorer/get_controls_for_detector.ts

alvarezmelissa87 · 2020-10-30T18:50:21Z

x-pack/plugins/ml/common/types/storage.ts

+      applyTimeRange: boolean;
+      sort: {
+        by: string; // 'anomaly_score' | 'name';
+        order: string; // 'asc' | 'desc';


Should this type be updated with the commented code?

Yes, updated in c4203a3

darnautov · 2020-11-02T09:12:17Z

@elasticmachine merge upstream

peteharverson

Tested latest edits and LGTM.

One last thought, I was wondering if we should move the top section of the popover (Apply time range / Anomalous only) to the bottom, seeing as the most common use case is to edit the sort field (Score or Name)?

…f the popover

kibanamachine · 2020-11-02T13:50:42Z

💚 Build Succeeded

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

Metrics [docs]

@kbn/optimizer bundle module count

id	before	after	diff
`ml`	1228	1234	+6

async chunks size

id	before	after	diff
`ml`	6.6MB	6.6MB	+22.1KB

distributable file count

id	before	after	diff
`default`	48126	48127	+1

History

💚 Build #85068 succeeded 8728e0f
💚 Build #84963 succeeded 9783cfa
💔 Build #84917 failed 49f3d0e
💚 Build #84868 succeeded 3ad0468
💚 Build #84818 succeeded ca7c2fc

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

alvarezmelissa87

Latest edits LGTM ⚡

…81510) (#82295) * [ML] fix callout styles * [ML] refactor timeseriesexplorer.js, add series_controls.tsx, storage support for partition config * [ML] anomalousOnly support * [ML] sort by control * [ML] update query * [ML] sort order controls * [ML] adjust query * [ML] merge default and local configs, add info * [ML] fix types, adjust sorting logic for model plot results * [ML] fix translation keys * [ML] fixed size for the icon flex item * [ML] fix time range condition, refactor * [ML] change info messages and the icon color * Fix model plot info message Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co> * [ML] functional tests * [ML] rename ML_ENTITY_FIELDS_CONFIG * [ML] support manual input * [ML] show max record score color indicator * [ML] use :checked selector * [ML] refactor functional tests * [ML] extend config with "applyTimeRange", refactor with entity_config.tsx * [ML] info messages * [ML] remove custom message * [ML] adjust the endpoint * [ML] customOptionText * [ML] sort by name UI tweak * [ML] change text * [ML] remove TODO comment * [ML] fix functional test * [ML] move "Anomalous only"/"Apply time range" control to the bottom of the popover * [ML] update types

darnautov added release_note:enhancement :ml Feature:Anomaly Detection ML anomaly detection v8.0.0 v7.11.0 labels Oct 22, 2020

darnautov requested review from alvarezmelissa87 and peteharverson October 22, 2020 16:49

darnautov self-assigned this Oct 22, 2020

darnautov added 10 commits October 26, 2020 11:08

[ML] fix callout styles

593c9ea

[ML] refactor timeseriesexplorer.js, add series_controls.tsx, storage…

beb067e

… support for partition config

[ML] anomalousOnly support

b648467

[ML] sort by control

149287f

[ML] update query

71487fc

[ML] sort order controls

5defba6

Merge remote-tracking branch 'upstream/master' into ML-69526-improve-…

953e1ff

…partition-sorting # Conflicts: # x-pack/plugins/ml/public/application/timeseriesexplorer/components/entity_control/entity_control.tsx

[ML] adjust query

e1a5c45

[ML] merge default and local configs, add info

4855208

[ML] fix types, adjust sorting logic for model plot results

d2710c9

darnautov force-pushed the ML-69526-improve-partition-sorting branch from 58f7fa3 to d2710c9 Compare October 27, 2020 12:22

darnautov requested review from jgowdyelastic and tveasey October 27, 2020 12:24

darnautov added 2 commits October 27, 2020 13:40

[ML] fix translation keys

fa59221

[ML] fixed size for the icon flex item

799efd0

darnautov marked this pull request as ready for review October 27, 2020 13:13

darnautov requested review from a team as code owners October 27, 2020 13:13

tveasey reviewed Oct 27, 2020

View reviewed changes

x-pack/plugins/ml/server/models/results_service/get_partition_fields_values.ts Outdated Show resolved Hide resolved

[ML] fix time range condition, refactor

faeaf2f

tveasey approved these changes Oct 27, 2020

View reviewed changes

[ML] refactor functional tests

ca7c2fc

pheyos approved these changes Oct 30, 2020

View reviewed changes

darnautov added 5 commits October 30, 2020 16:25

[ML] extend config with "applyTimeRange", refactor with entity_config…

9f094ea

….tsx

[ML] info messages

6026d41

[ML] remove custom message

c0b348e

[ML] adjust the endpoint

044768a

[ML] customOptionText

3ad0468

peteharverson reviewed Oct 30, 2020

View reviewed changes

...plugins/ml/public/application/timeseriesexplorer/components/entity_control/entity_config.tsx Outdated Show resolved Hide resolved

peteharverson reviewed Oct 30, 2020

View reviewed changes

...plugins/ml/public/application/timeseriesexplorer/components/entity_control/entity_config.tsx Outdated Show resolved Hide resolved

peteharverson reviewed Oct 30, 2020

View reviewed changes

x-pack/plugins/ml/public/application/timeseriesexplorer/get_controls_for_detector.ts Outdated Show resolved Hide resolved

darnautov added 3 commits October 30, 2020 19:04

[ML] sort by name UI tweak

accd14a

[ML] change text

a9a810e

[ML] remove TODO comment

49f3d0e

darnautov requested review from lcawl and peteharverson October 30, 2020 18:08

alvarezmelissa87 reviewed Oct 30, 2020

View reviewed changes

[ML] fix functional test

9783cfa

Merge branch 'master' into ML-69526-improve-partition-sorting

8728e0f

peteharverson approved these changes Nov 2, 2020

View reviewed changes

darnautov added 2 commits November 2, 2020 12:51

[ML] move "Anomalous only"/"Apply time range" control to the bottom o…

5d4b138

…f the popover

[ML] update types

c4203a3

darnautov requested a review from alvarezmelissa87 November 2, 2020 13:58

alvarezmelissa87 approved these changes Nov 2, 2020

View reviewed changes

darnautov merged commit f50c5a2 into elastic:master Nov 2, 2020

darnautov deleted the ML-69526-improve-partition-sorting branch November 2, 2020 15:05

darnautov mentioned this pull request Nov 2, 2020

[7.x] [ML] Configure sorting for partition values on Single Metric Viewer (#81510) #82295

Merged

peteharverson mentioned this pull request Nov 3, 2020

[ML] Add option for anomaly charts for metric detector should plot min, mean or max as appropriate #81662

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ML] Configure sorting for partition values on Single Metric Viewer #81510

[ML] Configure sorting for partition values on Single Metric Viewer #81510

darnautov commented Oct 22, 2020 •

edited

elasticmachine commented Oct 27, 2020

tveasey left a comment

tveasey left a comment

pheyos left a comment

alvarezmelissa87 Oct 30, 2020

darnautov Nov 2, 2020

darnautov commented Nov 2, 2020

peteharverson left a comment

kibanamachine commented Nov 2, 2020

alvarezmelissa87 left a comment

[ML] Configure sorting for partition values on Single Metric Viewer #81510

[ML] Configure sorting for partition values on Single Metric Viewer #81510

Conversation

darnautov commented Oct 22, 2020 • edited

Summary

Checklist

elasticmachine commented Oct 27, 2020

tveasey left a comment

Choose a reason for hiding this comment

tveasey left a comment

Choose a reason for hiding this comment

pheyos left a comment

Choose a reason for hiding this comment

alvarezmelissa87 Oct 30, 2020

Choose a reason for hiding this comment

darnautov Nov 2, 2020

Choose a reason for hiding this comment

darnautov commented Nov 2, 2020

peteharverson left a comment

Choose a reason for hiding this comment

kibanamachine commented Nov 2, 2020

💚 Build Succeeded

Metrics [docs]

@kbn/optimizer bundle module count

async chunks size

distributable file count

History

alvarezmelissa87 left a comment

Choose a reason for hiding this comment

darnautov commented Oct 22, 2020 •

edited