Skip to content

Commit

Permalink
Add documentation for rule-based anomaly detection and imputation (op…
Browse files Browse the repository at this point in the history
…ensearch-project#8202)

* Add documentation for rule-based anomaly detection and imputation

This PR introduces new documentation for rule-based anomaly detection (AD) and imputation options, providing detailed guidance on configuring these features. It also updates the maximum shingle size information and enhances the documentation for window delay settings.

Testing done:
- Successfully ran Jekyll build and reviewed the updated documentation to ensure all changes are correctly displayed.

Signed-off-by: Kaituo Li <[email protected]>

* Doc review

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/result-mapping.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update index.md

Copy edit documentation

Signed-off-by: Melissa Vagi <[email protected]>

* Update result-mapping.md

Doc review complete

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

* Fix links

Signed-off-by: Melissa Vagi <[email protected]>

* Fix links

Signed-off-by: Melissa Vagi <[email protected]>

* Address editorial feedback

Signed-off-by: Melissa Vagi <[email protected]>

* Address editorial feedback

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/ad/index.md

Signed-off-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Kaituo Li <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: Noah Staveley <[email protected]>
  • Loading branch information
2 people authored and noahstaveley committed Sep 23, 2024
1 parent 056952b commit ebb2156
Show file tree
Hide file tree
Showing 3 changed files with 222 additions and 105 deletions.
4 changes: 2 additions & 2 deletions _observing-your-data/ad/dashboards-anomaly-detection.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ You can connect data visualizations to OpenSearch datasets and then create, run,
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 Anomaly Detection plugin version 2.9 or later. See [Installing OpenSearch plugins]({{site.url}}{{site.baseurl}}/install-and-configure/plugins).
- Installed the Anomaly Detection plugin version 2.9 or later. See [Installing OpenSearch plugins]/({{site.url}}{{site.baseurl}}/install-and-configure/plugins/).
- Installed the Anomaly Detection Dashboards plugin version 2.9 or later. 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 displayed as time-series charts that give you a snapshot of when anomalies have occurred from different anomaly detectors you have configured for the visualization. You can display up to 10 metrics on your chart, and each series can be shown as a line on the chart. Note that only real-time anomalies will be visible on the chart. For more information on real-time and historical anomaly detection, see [Anomaly detection, Step 3: Set up detector jobs]({{site.url}}{{site.baseurl}}/observing-your-data/ad/index/#step-3-set-up-detector-jobs).
Anomaly detection visualizations are displayed as time-series charts that give you a snapshot of when anomalies have occurred from different anomaly detectors you have configured for the visualization. You can display up to 10 metrics on your chart, and each series can be shown as a line on the chart. Note that only real-time anomalies will be visible on the chart. For more information about real-time and historical anomaly detection, see [Anomaly detection, Step 3: Set up detector jobs]({{site.url}}{{site.baseurl}}/observing-your-data/ad/index/#step-3-setting-up-detector-jobs).

Keep in mind the following requirements when setting up or creating anomaly detection visualizations. The visualization:

Expand Down
Loading

0 comments on commit ebb2156

Please sign in to comment.