Skip to content

Commit e2d593d

Browse files
authored
Add feature attribution documentation (opensearch-project#871)
* Add feature attribution documentation Signed-off-by: Naarcha-AWS <[email protected]> * Delete references to removed images Signed-off-by: Naarcha-AWS <[email protected]> * Add technical feedback Signed-off-by: Naarcha-AWS <[email protected]> * Add new images. Delete redundant note Signed-off-by: Naarcha-AWS <[email protected]> * Fix a formatting bug Signed-off-by: Naarcha-AWS <[email protected]> * Add editorial feedback Signed-off-by: Naarcha-AWS <[email protected]> * Add more editorial feedback Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
1 parent 206e97a commit e2d593d

File tree

5 files changed

+20
-12
lines changed

5 files changed

+20
-12
lines changed

_monitoring-plugins/ad/index.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -140,37 +140,45 @@ If you see any validation errors, edit the settings to fix the errors and then r
140140

141141
## Step 5: Observe the results
142142

143-
Choose the **Real-time results** or **Historical analysis** tab. For real-time results, you need to wait for some time to see the anomaly results. If the detector interval is 10 minutes, the detector might take more than an hour to start, as it's waiting for sufficient data to generate anomalies.
143+
Choose the **Real-time results** or **Historical analysis** tab. For real-time results, you need to wait for some time to see the anomaly results. If the detector interval is 10 minutes, the detector might take more than an hour to start, because its waiting for sufficient data to generate anomalies.
144144

145145
A shorter interval means the model passes the shingle process more quickly and starts to generate the anomaly results sooner.
146146
Use the [profile detector]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/api#profile-detector) operation to make sure you have sufficient data points.
147147

148148
If you see the detector pending in "initialization" for longer than a day, aggregate your existing data using the detector interval to check for any missing data points. If you find a lot of missing data points from the aggregated data, consider increasing the detector interval.
149149

150-
![Anomaly detection results]({{site.url}}{{site.baseurl}}/images/ad.png)
150+
Choose and drag over the anomaly line chart to zoom in and see a more detailed view of an anomaly.
151+
{: .note }
151152

152153
Analyze anomalies with the following visualizations:
153154

154-
- **Live anomalies** - displays live anomaly results for the last 60 intervals. For example, if the interval is 10, it shows results for the last 600 minutes. The chart refreshes every 30 seconds.
155-
- **Anomaly history** (for historical analysis) / **Anomaly overview** (for real-time results) - plots the anomaly grade with the corresponding measure of confidence.
156-
- **Anomaly occurrence** - shows the `Start time`, `End time`, `Data confidence`, and `Anomaly grade` for each detected anomaly.
157-
- **Feature breakdown** - plots the features based on the aggregation method. You can vary the date-time range of the detector.
155+
- **Live anomalies** (for real-time results) displays live anomaly results for the last 60 intervals. For example, if the interval is 10, it shows results for the last 600 minutes. The chart refreshes every 30 seconds.
156+
- **Anomaly overview** (for real-time results) / **Anomaly history** (for historical analysis in the **Historical analysis** tab) plots the anomaly grade with the corresponding measure of confidence. This pane includes:
157+
- The number of anomaly occurrences based on the given data-time range.
158+
- The **Average anomaly grade**, a number between 0 and 1 that indicates how anomalous a data point is. An anomaly grade of 0 represents “not an anomaly,” and a non-zero value represents the relative severity of the anomaly.
159+
- **Confidence** estimate of the probability that the reported anomaly grade matches the expected anomaly grade. Confidence increases as the model observes more data and learns the data behavior and trends. Note that confidence is distinct from model accuracy.
160+
- **Last anomaly occurrence** is the time at which the last anomaly occurred.
161+
162+
Underneath **Anomaly overview**/**Anomaly history** are:
163+
164+
- **Feature breakdown** plots the features based on the aggregation method. You can vary the date-time range of the detector. Selecting a point on the feature line chart shows the **Feature output**, the number of times a field appears in your index, and the **Expected value**, a predicted value for the feature output. Where there is no anomaly, the output and expected values are equal.
165+
166+
![Anomaly detection results]({{site.url}}{{site.baseurl}}/images/feature-contribution-ad.png)
158167

159-
`Anomaly grade` is a number between 0 and 1 that indicates how anomalous a data point is. An anomaly grade of 0 represents “not an anomaly,” and a non-zero value represents the relative severity of the anomaly.
168+
- **Anomaly occurrences** shows the `Start time`, `End time`, `Data confidence`, and `Anomaly grade` for each detected anomaly.
169+
170+
Selecting a point on the anomaly line chart shows **Feature Contribution**, the percentage of a feature that contributes to the anomaly
171+
172+
![Anomaly detection results]({{site.url}}{{site.baseurl}}/images/feature-contribution-ad.png)
160173

161-
`Data confidence` is an estimate of the probability that the reported anomaly grade matches the expected anomaly grade. Confidence increases as the model observes more data and learns the data behavior and trends. Note that confidence is distinct from model accuracy.
162174

163175
If you set the category field, you see an additional **Heat map** chart. The heat map correlates results for anomalous entities. This chart is empty until you select an anomalous entity. You also see the anomaly and feature line chart for the time period of the anomaly (`anomaly_grade` > 0).
164176

165-
Choose and drag over the anomaly line chart to zoom in and see a more detailed view of an anomaly.
166-
{: .note }
167177

168178
If you have set multiple category fields, you can select a subset of fields to filter and sort the fields by. Selecting a subset of fields lets you see the top values of one field that share a common value with another field.
169179

170180
For example, if you have a detector with the category fields `ip` and `endpoint`, you can select `endpoint` in the **View by** dropdown menu. Then, select a specific cell to overlay the top 20 values of `ip` on the charts. The anomaly detection plugin selects the top `ip` by default. You can see a maximum of 5 individual time-series values at the same time.
171181

172-
![Anomaly detection results]({{site.url}}{{site.baseurl}}/images/multi-category-ad.png)
173-
174182
## Step 6: Set up alerts
175183

176184
Under **Real-time results**, choose **Set up alerts** and configure a monitor to notify you when anomalies are detected. For steps to create a monitor and set up notifications based on your anomaly detector, see [Monitors]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/monitors/).

images/ad.png

-271 KB
Binary file not shown.

images/feature-contribution-ad.png

117 KB
Loading

images/feature-output-ad.png

132 KB
Loading

images/multi-category-ad.png

-307 KB
Binary file not shown.

0 commit comments

Comments
 (0)