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] Set up alerts for anomaly detector on visualization #440

Closed
Tracked by #66
xeniatup opened this issue Mar 13, 2023 · 1 comment
Closed
Tracked by #66

[UX] Set up alerts for anomaly detector on visualization #440

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

Comments

@xeniatup
Copy link

xeniatup commented Mar 13, 2023

This is part 2 of a combined flow for creating anomaly detector and setting up alerts for the detector.
Part 1 of the flow Create anomaly detector from a visualization is here.

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 story: 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 alerting monitor (part 2 of the flow - optional)

User can additionally create alerting monitor associated with the anomaly detector to receive alerts on anomaly occurrences.

create-monitor-forAD.mp4

Screen 1: User is optionally setting up alerts for an anomaly detector in the two-part flow. After creating anomaly detector user selects "Set up alerts" from the success toast message (OuiToast). An alternative way to set up alerts for an anomaly detector is Alerting plugin UI.

Screenshot 2023-04-04 at 12 47 45 PM

Screen 2a: Selecting "Set up alerts" opens a flyout OuiFlyout with "Set up alerts" form (OuiFormRow, OuiFormRows) prefilled with the information from the detector. Monitor details are collapsed by default.

Screenshot 2023-04-04 at 12 52 26 PM

Screen 3a: Trigger conditions are prefilled with default values. The accordion is expanded by default on the form load.

Screenshot 2023-04-04 at 12 52 51 PM

Screen 4: User selects a notification channel from the list of existing channels (OuiComboBox). Additionally user can select "Manage channels" to access Notification plugin UI in a new tab (OuiButton).
Note on the element behavior - The list of channels is refreshing dynamically. If any new channels are added in Notifications plugin, those could be accessed from the list without reloading the form.

Screenshot 2023-03-13 at 12 38 48 PM

Screen 5: After selecting a channel user can edit default notification settings and the message copy by selecting "Configure notification".

Screenshot 2023-03-23 at 5 57 12 PM

Screen 6a: Selecting "Configure notification" shows a modal dialog over the flyout with a form (OuiModal).

Screenshot 2023-04-04 at 12 53 23 PM

Screen 7: Additional notifications are added by selecting "Add notification". Next notification is placed in a new nested accordion expanded for editing. The first notification accordion is collapsed after the second notification accordion is added.
Additional triggers are added by selecting "Add trigger". A new trigger is placed in a new expanded accordion below the first one. The first one is collapsed.

Screenshot 2023-03-13 at 12 42 38 PM

Screen 8: User selects "Create monitor" button. The flyout closes, user returns to the dashboard.

Screenshot 2023-04-04 at 12 53 52 PM

Error states:

Notes on validation error states:

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

Screen 2b: (Validation error state) Selecting "Set up alerts" opens a flyout OuiFlyout with "Set up alerts" form (OuiFormRow, OuiFormRows).

Screenshot 2023-04-04 at 12 56 03 PM

Screen 3b: (Validation error state) Trigger conditions.

Screenshot 2023-03-13 at 12 54 58 PM

Screen 4b: (Validation error state) If Notifications plugin is not installed, user sees a warning callout OuiCallOut .

Screenshot 2023-04-04 at 12 58 24 PM

Screen 6b: (Validation error state) Selecting "Configure notification" shows modal dialog over the flyout with a form (OuiModal).

Screenshot 2023-04-04 at 1 00 25 PM

@xeniatup xeniatup changed the title [UX] Set up alerts for anomaly detector on Dashboards [UX] Set up alerts for anomaly detector on visualization Mar 13, 2023
@kaituo kaituo added feature A new feature for the plugin and removed untriaged labels Mar 14, 2023
@xeniatup
Copy link
Author

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

2 participants