[APM] Add ML expected model bounds as an option to Comparison controls by qn895 · Pull Request #132456 · elastic/kibana

qn895 · 2022-05-18T17:12:56Z

Summary

This PR addresses #121520 and adds an option to show ML model bounds in the comparison controls and re-enable the expected bounds from ML anomaly detection jobs as comparison option to Latency, Throughput, and Failed Transaction Rate charts.

If user can access machine learning jobs, but there are no* ML jobs that match the currently selected environment, the Expected bounds option will be shown but will be disabled:

When user can access machine learning jobs, and there are ML jobs that match the current environment, Expected bounds will be enabled:

When Expected bounds is selected for comparison:

When switching environment, and there are no ML jobs that match the new environment, Expected bounds will be disabled, and the current selection will default to the first available time comparison option.

Screen.Recording.2022-05-20.at.17.55.28.mov

When a time range comparison is used, the legend for the charts will show Comparison: Day before Comparison: Week before, or Comparison: {period of time}`. Additionally, tooltip will no longer show series with N/A or null values.

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

…xpected-bounds

elasticmachine · 2022-05-18T20:43:26Z

Pinging @elastic/ml-ui (:ml)

peteharverson

Tested and LGTM with the lower bounds of the ML model plot now displaying correctly.

I don't think we should look to display the model bounds in the sparklines shown in the Services list and Map at this stage. Those searches need to be optimized for speed for which we should investigate using sampling. Also with the limited width and height of the sparklines there may be little value in trying to show model bounds here.

sophiec20 · 2022-05-24T17:51:57Z

++ agree that showing model bounds in the sparklines is not desirable.

sorenlouv · 2022-05-24T21:03:12Z

-                  comparisonEnabled: toBooleanRt,
+                  comparisonEnabled: comparisonEnabledRt,


I think we can just leave this unchanged. We don't need an intermediate type for toBooleanRt

Removed here 025d4ea

sorenlouv · 2022-05-24T21:24:09Z

+      value: TimeRangeComparisonEnum.ExpectedBounds,
+      text: disabled
+        ? i18n.translate('xpack.apm.comparison.mlExpectedBoundsDisabledText', {
+            defaultMessage: 'Expected bounds (select other environment)',


We should mention that anomaly detection must be enabled for the environment:

Suggested change

defaultMessage: 'Expected bounds (select other environment)',

defaultMessage: 'Expected bounds (anomaly detection must be enabled for env)',

@sqren Thanks. Updated with the new text here... I capitalized Anomaly so it looks more like this now: 1d889d0

sorenlouv

lgtm. Thanks for all the work @qn895 . The designers and pm's might have some polish comment but I'm okay with doing that during FF.

kibana-ci · 2022-05-24T22:42:53Z

💛 Build succeeded, but was flaky

Failed CI Steps

APM Cypress Tests

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`apm`	1207	1208	+1

Async chunks

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

id	before	after	diff
`apm`	2.9MB	2.9MB	+1.5KB

History

💚 Build #47285 succeeded d4b35fe
💚 Build #47085 succeeded abee546
💔 Build #47059 failed 0f3ab79
💚 Build #47011 succeeded 894f070
💚 Build #46722 succeeded e31c4bf
💛 Build #46666 was flaky c49c916

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

cc @qn895

qn895 · 2022-05-24T23:01:42Z

Merging this PR as the one failed test for the latest build doesn't seem to be related to changes in this PR. A big thank you to the APM team for all your help 🙏

elastic#132456) * [ML] Add bounds options * [ML] Renable anomalyChartTimeseries boundaries * [ML] Make it into string * [ML] Make it into string * Match colors * [ML] Add comparisonEnabledRt * [ML] Fix types, tests * [ML] Revert json bucket span change * [ML] Add bounds options * [ML] Renable anomalyChartTimeseries boundaries * [ML] Make it into string * [ML] Make it into string * Match colors * [ML] Add comparisonEnabledRt * [ML] Fix types, tests * [ML] Revert json bucket span change * Refactor to use offset with TimeRangeComparisonEnum.ExpectedBounds * Change comparisonColor to be part of anomalySeries * Fix i18n * Add Comparison text to replace 'Previous period' * Fix expected bounds legend default to first * Hide values that are N/A in the tooltips * Fix i18n, color, and null values in tooltips * Refactor to use preferredEnvironment * Don't disable expected bounds by default * Match color of expected bounds with time comparison color * Fix tests * Use bucket_span as minBucketSize for anomaly results * Fix previousPeriodColor undefined for latency chart * Remove 'Comparison:' in legend * Change anomalyTimeseriesColor to use currentPeriod to match stuff * Fix type error * Fix lower model bounds * Add comments * Remove fit * Remove comparisonEnabledRt * Change text Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit c1d0ec5)

sorenlouv · 2022-06-07T18:59:56Z

💚 All backports created successfully

Status	Branch	Result
✅	8.3

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

sorenlouv · 2022-06-07T19:14:43Z

💚 All backports created successfully

Status	Branch	Result
✅	8.3

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

…ontrols (#132456) | [APM] Fix ML expected bounds missing data in chart, option showing when not neccessary (#132975) (#133826) * [APM] Add ML expected model bounds as an option to Comparison controls (#132456) * [ML] Add bounds options * [ML] Renable anomalyChartTimeseries boundaries * [ML] Make it into string * [ML] Make it into string * Match colors * [ML] Add comparisonEnabledRt * [ML] Fix types, tests * [ML] Revert json bucket span change * [ML] Add bounds options * [ML] Renable anomalyChartTimeseries boundaries * [ML] Make it into string * [ML] Make it into string * Match colors * [ML] Add comparisonEnabledRt * [ML] Fix types, tests * [ML] Revert json bucket span change * Refactor to use offset with TimeRangeComparisonEnum.ExpectedBounds * Change comparisonColor to be part of anomalySeries * Fix i18n * Add Comparison text to replace 'Previous period' * Fix expected bounds legend default to first * Hide values that are N/A in the tooltips * Fix i18n, color, and null values in tooltips * Refactor to use preferredEnvironment * Don't disable expected bounds by default * Match color of expected bounds with time comparison color * Fix tests * Use bucket_span as minBucketSize for anomaly results * Fix previousPeriodColor undefined for latency chart * Remove 'Comparison:' in legend * Change anomalyTimeseriesColor to use currentPeriod to match stuff * Fix type error * Fix lower model bounds * Add comments * Remove fit * Remove comparisonEnabledRt * Change text Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit c1d0ec5) * [APM] Fix ML expected bounds missing data in chart, option showing when not neccessary (#132975) * Only show expected bounds option in Overview/Transactions subpage of Services * Bucket span * Fix bucket span didn't show up in chart * Change fixed interval to 60s, add elastic-charts ref * ui settings remembering * Address comments * Address comments * Fix linting * Move data point down instead of extending range * Change to last, add test * Fix to use xValuesExpectedBounds * Revert change to to add extra point as es ml already handled it Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 017c8e1) Co-authored-by: Quynh Nguyen <43350163+qn895@users.noreply.github.com> Co-authored-by: Dario Gieselaar <dario.gieselaar@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

elastic#132456) * [ML] Add bounds options * [ML] Renable anomalyChartTimeseries boundaries * [ML] Make it into string * [ML] Make it into string * Match colors * [ML] Add comparisonEnabledRt * [ML] Fix types, tests * [ML] Revert json bucket span change * [ML] Add bounds options * [ML] Renable anomalyChartTimeseries boundaries * [ML] Make it into string * [ML] Make it into string * Match colors * [ML] Add comparisonEnabledRt * [ML] Fix types, tests * [ML] Revert json bucket span change * Refactor to use offset with TimeRangeComparisonEnum.ExpectedBounds * Change comparisonColor to be part of anomalySeries * Fix i18n * Add Comparison text to replace 'Previous period' * Fix expected bounds legend default to first * Hide values that are N/A in the tooltips * Fix i18n, color, and null values in tooltips * Refactor to use preferredEnvironment * Don't disable expected bounds by default * Match color of expected bounds with time comparison color * Fix tests * Use bucket_span as minBucketSize for anomaly results * Fix previousPeriodColor undefined for latency chart * Remove 'Comparison:' in legend * Change anomalyTimeseriesColor to use currentPeriod to match stuff * Fix type error * Fix lower model bounds * Add comments * Remove fit * Remove comparisonEnabledRt * Change text Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

qn895 added 9 commits May 11, 2022 17:20

[ML] Add bounds options

27272d5

[ML] Renable anomalyChartTimeseries boundaries

524750b

[ML] Make it into string

83eaa1e

[ML] Make it into string

d023e38

Match colors

06b2ead

[ML] Add comparisonEnabledRt

25fb162

[ML] Fix types, tests

410be98

[ML] Revert json bucket span change

ec35ba4

Merge remote-tracking branch 'upstream/main' into apm-comparison-ml-e…

e9bd76d

…xpected-bounds

qn895 changed the title ~~[APM] Add ML expected bounds~~ [APM] Add ML expected model bounds as an option to Comparison controls May 18, 2022

qn895 self-assigned this May 18, 2022

qn895 added release_note:enhancement :ml v8.3.0 labels May 18, 2022

qn895 requested review from dgieselaar, formgeist and peteharverson May 18, 2022 20:42

qn895 marked this pull request as ready for review May 18, 2022 20:43

qn895 requested a review from a team May 18, 2022 20:43

qn895 mentioned this pull request May 18, 2022

[ML] Add ML expected model bounds as an option to Comparison controls #132205

Closed

9 tasks

sorenlouv added the ci:deploy-cloud label May 19, 2022

qn895 added 8 commits May 19, 2022 11:57

[ML] Add bounds options

4ff5d1d

[ML] Renable anomalyChartTimeseries boundaries

f3207c5

[ML] Make it into string

8ecddf1

[ML] Make it into string

a36b80b

Match colors

2d924a9

[ML] Add comparisonEnabledRt

ec52627

[ML] Fix types, tests

0133b29

[ML] Revert json bucket span change

f542b6f

peteharverson approved these changes May 24, 2022

View reviewed changes

sorenlouv reviewed May 24, 2022

View reviewed changes

Remove comparisonEnabledRt

025d4ea

sorenlouv reviewed May 24, 2022

View reviewed changes

Change text

1d889d0

sorenlouv approved these changes May 24, 2022

View reviewed changes

qn895 merged commit c1d0ec5 into elastic:main May 24, 2022

kibanamachine added the backport:skip This PR does not require backporting label May 24, 2022

sorenlouv mentioned this pull request May 25, 2022

[APM] UI polish for "Expected bounds" feature #132898

Closed

LucaWintergerst mentioned this pull request May 25, 2022

[APM] Machine Learning job incorrect results due to wrong interval #132917

Closed

qn895 mentioned this pull request Jun 7, 2022

[8.3] [APM] Add ML expected model bounds as an option to Comparison controls (#132456) #133824

Closed

sorenlouv mentioned this pull request Jun 7, 2022

[8.3] [APM] Add ML expected model bounds as an option to Comparison controls (#132456) #133825

Closed

sorenlouv mentioned this pull request Jun 7, 2022

[8.3] [APM] Add ML expected model bounds as an option to Comparison controls (#132456) | [APM] Fix ML expected bounds missing data in chart, option showing when not neccessary (#132975) #133826

Merged

peteharverson added release_note:feature Makes this part of the condensed release notes and removed release_note:enhancement labels Jun 8, 2022

szabosteve mentioned this pull request Jun 15, 2022

[DOCS] Adds Expected bounds comparison docs #134472

Merged

1 task done

tylersmalley added ci:cloud-deploy Create or update a Cloud deployment and removed ci:deploy-cloud labels Aug 17, 2022

qn895 deleted the apm-comparison-ml-expected-bounds branch September 21, 2022 16:33

Navigation Menu

Repository navigation

[APM] Add ML expected model bounds as an option to Comparison controls - #132456

[APM] Add ML expected model bounds as an option to Comparison controls#132456
qn895 merged 41 commits into
elastic:mainfrom
qn895:apm-comparison-ml-expected-bounds

qn895 commented May 18, 2022 •

edited

Loading

Uh oh!

elasticmachine commented May 18, 2022

Uh oh!

peteharverson left a comment

Uh oh!

sophiec20 commented May 24, 2022

Uh oh!

sorenlouv May 24, 2022

Uh oh!

qn895 May 24, 2022

Uh oh!

sorenlouv May 24, 2022

Uh oh!

qn895 May 24, 2022

Uh oh!

sorenlouv left a comment

Uh oh!

kibana-ci commented May 24, 2022

Uh oh!

qn895 commented May 24, 2022

Uh oh!

sorenlouv commented Jun 7, 2022

Uh oh!

sorenlouv commented Jun 7, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

		comparisonEnabled: toBooleanRt,
		comparisonEnabled: comparisonEnabledRt,

	defaultMessage: 'Expected bounds (select other environment)',
	defaultMessage: 'Expected bounds (anomaly detection must be enabled for env)',

Conversation

qn895 commented May 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Risk Matrix

For maintainers

Uh oh!

elasticmachine commented May 18, 2022

Uh oh!

peteharverson left a comment

Choose a reason for hiding this comment

Uh oh!

sophiec20 commented May 24, 2022

Uh oh!

sorenlouv May 24, 2022

Choose a reason for hiding this comment

Uh oh!

qn895 May 24, 2022

Choose a reason for hiding this comment

Uh oh!

sorenlouv May 24, 2022

Choose a reason for hiding this comment

Uh oh!

qn895 May 24, 2022

Choose a reason for hiding this comment

Uh oh!

sorenlouv left a comment

Choose a reason for hiding this comment

Uh oh!

kibana-ci commented May 24, 2022

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Module Count

Async chunks

History

Uh oh!

qn895 commented May 24, 2022

Uh oh!

sorenlouv commented Jun 7, 2022

💚 All backports created successfully

Questions ?

Uh oh!

sorenlouv commented Jun 7, 2022

💚 All backports created successfully

Questions ?

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

qn895 commented May 18, 2022 •

edited

Loading