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

Add anomaly detection visualizations documentation #4091

Merged
merged 32 commits into from
Jul 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
20225f2
Add anomaly detection visualizations documentation
vagimeli May 16, 2023
9a1592b
Writing
vagimeli May 16, 2023
471cd1c
Rewriting
vagimeli May 17, 2023
1186264
Rewriting
vagimeli May 17, 2023
1f32798
Revisions
vagimeli May 18, 2023
3d6db0b
Address tech input
vagimeli Jun 9, 2023
771d595
Update dashboards-anomaly-detection.md
vagimeli Jun 9, 2023
8fec333
Update dashboards-anomaly-detection.md
vagimeli Jul 13, 2023
bb53636
Update dashboards-anomaly-detection.md
vagimeli Jul 13, 2023
3deb1db
Update dashboards-anomaly-detection.md
vagimeli Jul 13, 2023
35fb05b
Update dashboards-anomaly-detection.md
vagimeli Jul 13, 2023
045cc2c
Update dashboards-anomaly-detection.md
vagimeli Jul 14, 2023
7b8f56e
Update _observing-your-data/ad/dashboards-anomaly-detection.md
vagimeli Jul 14, 2023
a939356
Update dashboards-anomaly-detection.md
vagimeli Jul 14, 2023
f81f742
Update dashboards-anomaly-detection.md
vagimeli Jul 14, 2023
b2d0729
Update dashboards-anomaly-detection.md
vagimeli Jul 14, 2023
191baa1
Update _observing-your-data/ad/dashboards-anomaly-detection.md
vagimeli Jul 14, 2023
47f958e
Update _observing-your-data/ad/dashboards-anomaly-detection.md
vagimeli Jul 14, 2023
69e7e16
Update dashboards-anomaly-detection.md
vagimeli Jul 14, 2023
3707eb2
Update _observing-your-data/ad/dashboards-anomaly-detection.md
vagimeli Jul 14, 2023
28f9ebf
Update dashboards-anomaly-detection.md
vagimeli Jul 14, 2023
7e22386
Update dashboards-anomaly-detection.md
vagimeli Jul 14, 2023
6456fa0
Update _observing-your-data/ad/dashboards-anomaly-detection.md
vagimeli Jul 14, 2023
b1fc3e8
Update _observing-your-data/ad/dashboards-anomaly-detection.md
vagimeli Jul 14, 2023
ebc84a4
Update _observing-your-data/ad/dashboards-anomaly-detection.md
vagimeli Jul 14, 2023
2a9a077
Update _observing-your-data/ad/dashboards-anomaly-detection.md
vagimeli Jul 14, 2023
99beb22
Update _observing-your-data/ad/dashboards-anomaly-detection.md
vagimeli Jul 17, 2023
0d5e4b1
Add dashboard interface image
vagimeli Jul 17, 2023
9347e96
Add dashboard interface image
vagimeli Jul 17, 2023
b31e2c7
Adjust image size
vagimeli Jul 17, 2023
c625942
Adjust image
vagimeli Jul 17, 2023
fd618fe
Replace outdated screenshot
vagimeli Jul 17, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions _observing-your-data/ad/dashboards-anomaly-detection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
layout: default
title: Anomaly detection visualizations and dashboards
parent: Anomaly detection
nav_order: 50
---

# Anomaly detection dashboards and visualizations
Introduced 2.9
{: .label .label-purple }

OpenSearch provides an automated means of detecting harmful outliers and protecting your data when you enable anomaly detection. When applied to metrics, OpenSearch uses algorithms to continuously analyze systems and applications, determine normal baselines, and surface anomalies.

You can connect data visualizations to OpenSearch datasets and then create, run, and view anomaly alarms and results from visualizations in the **Dashboard** interface. With only a couple of steps, you can bring together traces, metrics, and logs to make your applications and infrastructure fully observable.

## Getting started

Before getting started, you must have:

- Installed OpenSearch and OpenSearch Dashboards version 2.9 or later. See [Installing OpenSearch]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/index/).
- Installed the Alerting and Notifications Dashboards plugins. See [Managing OpenSearch Dashboards plugins]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/plugins/) to get started.

## General requirements for anomaly detection visualizations

Anomaly detection visualizations are intended for use with time-series data (real-time or historical). The following visualization types are used frequently for time-series data: line, area, vertical bar, and time-series visual builder (TSVB).

## Configuring admin settings

Users can only access, create, or manage alerts for resources for which they have permissions. Access to anomaly detection dashboards and visualizations is controlled by OpenSearch and OpenSearch Dashboards permissions. It is enabled by default and appears as a feature under **Dashboards Management** > **Advanced Settings** > **Visualization**. If the setting is disabled, it does not appear under **Dashboards Management**. You can disable the setting at the cluster level in the `opensearch-dashboards.yml` file.

## Creating anomaly detectors
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

To start, first create an anomaly detector:

1. Select **Dashboard** from the OpenSearch Dashboards main menu.
2. From the **Dashboards** window, select **Create** and then choose **Dashboard**.
3. Select **Add an existing**, then select the appropriate visualization from the **Add panels** list. The visualization is added to the dashboard.
4. From the visualization panel, choose the ellipsis icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/ellipsis-icon.png" class="inline-icon" alt="ellipsis icon"/>{:/}).
5. From the **Options** menu, choose **Anomaly Detection** > **Add anomaly detector**.
6. Select **Create new detector**.
7. Input information for **Detector details** and **Model features**. Up to five model features are allowed.
8. To preview the visualization within the flyout, toggle the **Show visualization** button.
9. Select **Create detector**. Once you have created a new detector, the detector is added to the visualization, as shown in the following image.

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/add-detector.png" alt="Interface of adding a detector" width="800" height="800">

## Adding anomaly detectors to visualizations

Use a single interface to add, view, and edit anomaly detectors that you want to associate with a visualization. Continuing with the visualization and dashboard in the preceding tutorial, follow these steps to associate an anomaly detector with a visualization:

1. Select the ellipsis icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/ellipsis-icon.png" class="inline-icon" alt="ellipsis icon"/>{:/}) from the visualization panel, then select **Anomaly Detection**.
2. Select **Associate a detector**.
3. From the **Select detector to associate** dropdown menu, select the detector. Only eligible detectors are listed in the dropdown menu.
4. View basic information about the detectors. To view comprehensive details, select **View detector page** to open the Anomaly Detection plugin page.
5. Select **Associate detector**. An existing detector is now associated to the visualization, as shown in the following image.

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/anomaly-detect-dashboard.png" alt="Interface and confirmation message of associating a detector" width="800" height="800">

## Refreshing the visualization

Depending on the threshold settings, the visualization refreshes automatically at the specified interval. To manually refresh the visualization, select the **Refresh** button on the Dashboard page.

## Next steps

- [Learn more about the Dashboard application]({{site.url}}{{site.baseurl}}/dashboards/dashboard/index/).
- [Learn more about anomaly detection]({{site.url}}{{site.baseurl}}/observing-your-data/ad/index/).
Binary file added images/dashboards/add-detector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/ellipsis-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading