Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[UX] Create anomaly detector from visualizations #436

Closed
Tracked by #66
xeniatup opened this issue Feb 14, 2023 · 1 comment
Closed
Tracked by #66

[UX] Create anomaly detector from visualizations #436

xeniatup opened this issue Feb 14, 2023 · 1 comment
Labels
feature A new feature for the plugin

Comments

@xeniatup
Copy link

xeniatup commented Feb 14, 2023

Is your feature request related to a problem?
As an unsure user who is troubleshooting a problem, I want to augment my visualization with anomaly detection, so I can quickly identify if something is problematic or not.

UX Meta issue

What solution would you like?
opensearch-project/anomaly-detection#521
#400

Initial UX proposal on Anomaly Detection on Dashboards opensearch-project/OpenSearch-Dashboards#1798

User stories

  • User quickly creates an anomaly detector to see out of bounds events on a time series visualization on a dashboard. The detector details and model features are prefilled from the data source and metrics of the visualization.
  • User sets up alerts for the detector created on a visualization to receive alerts on a dashboard.

Screenshot 2023-02-14 at 10 33 19 AM

Create anomaly detector (part 1 of the flow)

See part two - set up alerts for anomaly detector on visualization - here.

create-anomaly-detector.mp4

Screen 1: User selects a visualization on a dashboard and selects "Anomaly detection" from the visualization context menu OuiContextMenu:

Screenshot 2023-03-12 at 11 08 30 PM

Screen 2: User selects "Add anomaly detector" from the context menu:

Screenshot 2023-03-12 at 11 08 35 PM

Screen 3a: "Add anomaly detector" option opens a flyout OuiFlyout with "Create anomaly detector" option prefilled with the information from the visualization:

Screenshot 2023-03-23 at 5 49 56 PM

Screen 4: User toggles visualization for additional context (optional):

Screenshot 2023-03-23 at 5 50 27 PM

Screen 5: User expands an accordion with basic detector details prefilled with defaults from the visualization to review. All fields are editable.
Note on the accordion behavior - the description is dynamic and changes onBlur with the form inputs.

Screenshot 2023-03-23 at 5 50 50 PM

Screen 6: User expands an accordion to review and edit advanced detector details OuiAccordion.
Note on the accordion behavior - Only one nested accordion can be expanded at every moment.

Screenshot 2023-04-04 at 12 42 45 PM

Screen 7: User selects "Add data filter" button to create a filter. (OuiBadgeGroup, OuiBadges)

Screenshot 2023-04-04 at 12 43 29 PM

Screen 8a: "Add data filter" form (OuiFlexGroup) opens in a modal dialog (OuiModal).

Screenshot 2023-03-13 at 10 29 43 AM

Screen 9: The modal for add and edit data filters provides two options - a visual editor (see screen 8 above) or DSL query editor(OuiCodeBlock).

Screenshot 2023-03-13 at 10 31 38 AM

Screen 10a: Shingle size is edited using an inline form field with append prop

Screenshot 2023-04-04 at 12 44 04 PM

Screen 11: Custom result index is not enabled by default:

Screenshot 2023-03-13 at 10 47 02 AM

Screen 12: Custom result index is enabled by checking a checkbox and the name is provided in the single field form with prepend prop.

Screenshot 2023-03-13 at 10 47 07 AM

Screen 13: High cardinality anomaly detectors are currently not supported in this feature.

Screenshot 2023-04-04 at 12 44 55 PM

Screen 14a: Model features are prefilled using metrics on the visualization (up to 5). Features can be deleted or added from the visualization within this number. Each feature's details are edited in an accordion (OuiAccordion)
Note on the "delete" icon button (OuiButtonIcon): in the default state it is displayed in ouiTextSubduedColor, and in focused state it uses ouiColorDanger

Screenshot 2023-03-13 at 11 53 01 AM

Screen 14b: User can select either find anomalies based on field value or custom expression (OuiCodeBlock)

Screenshot 2023-03-13 at 12 03 40 PM

Screen 15: User selects "Create detector" button. The flyout closes, user returns to the dashboard.
The resulting toast message displays a CTA to continue with the second part of the flow - Set up alerts.

Screenshot 2023-04-04 at 12 45 38 PM

Error states:
Notes on validation error states:

  • The flyout is kept open and scrolled to the top
  • Error callout on the top
  • All accordions that contain errors are expanded
  • All failed form rows in invalid state
  • Toast message for index permission errors, plugin permission errors, API failed responses
  • Missing accordion headers and descriptions use hyphen as placeholder for missing values

Screen 3b: (Validation error state) "Add anomaly detector" option opens a flyout OuiFlyout with "Create anomaly detector" option prefilled with the information from the visualization:

Screenshot 2023-03-23 at 5 53 57 PM

Screen 8b: (Validation error state) "Add data filter" form (OuiFlexGroup) opens in a modal dialog (OuiModal).
Screenshot 2023-03-13 at 12 21 04 PM

Screen 10b: (Validation error state) Shingle size is edited using an inline form field with append prop

Screenshot 2023-04-04 at 12 46 43 PM

@xeniatup
Copy link
Author

Done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature A new feature for the plugin
Projects
None yet
Development

No branches or pull requests

3 participants