Skip to content

Commit d14b58a

Browse files
committed
feat(alerts): Add anomaly detection docs
1 parent cc8e436 commit d14b58a

File tree

3 files changed

+20
-2
lines changed

3 files changed

+20
-2
lines changed

docs/organization/early-adopter-features/index.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,4 @@ Limitations:
2222
- [Span Summary](/product/performance/transaction-summary/#span-summary)
2323
- [Investigation Mode](/product/performance/retention-priorities/#investigation-mode) for retention priorities in Tracing
2424
- [Uptime Monitoring](/product/alerts/uptime-monitoring/)
25+
- [Dynamic Alerts](/product/alerts/create-alerts/metric-alert-config/#dynamic-alerts)

docs/product/alerts/alert-types.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ The **Alert Details** page also includes a list of issues that triggered the ale
3838

3939
Metric alerts tell you when a [metric](/product/performance/metrics/) crosses a threshold set by you, like a spike in the number of errors in a project, or a change in a performance metric, such as [transaction duration](/product/performance/metrics/#latency), [Apdex](/product/performance/metrics/#apdex), [failure rate](/product/performance/metrics/#failure-rate), or [throughput](/product/performance/metrics/#throughput-total-tpm-tps).
4040

41+
<Note>
42+
You can use [dynamic alerts](/product/alerts/create-alerts/metric-alert-config/#dynamic-alerts) to let Sentry define the threshold for you.
43+
</Note>
44+
4145
Metric alerts monitor macro-level metrics for both error and transaction events. A metric takes a set of events and computes an aggregate value using a function, such as `count()` or `avg()`, applied to the event properties over a period of time. When you create a metric alert, you can filter events by attributes and <PlatformLink to="/enriching-events/tags/">tags</PlatformLink>, which is particularly useful for aggregating across events that aren't grouped into single issues. Sentry allows a maximum of 1000 metric alerts for an organization.
4246

4347
<Note>

docs/product/alerts/create-alerts/metric-alert-config.mdx

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,10 +111,11 @@ While Sentry won’t allow you to create new alerts with invalid or unavailable
111111

112112
## Thresholds
113113

114-
There are two threshold types:
114+
There are three threshold types:
115115

116116
- **Static**: A fixed threshold, such as when there are 100 errors in a period of time.
117-
- **Percent change**: A dynamic threshold, such as when there are 10% more errors in a time period compared to a previous period. These are also referred to as [Change Alerts](#change-alerts-percent-change).
117+
- **Percent change**: A percent based threshold, such as when there are 10% more errors in a time period compared to a previous period. These are also referred to as [Change Alerts](#change-alerts-percent-change).
118+
- **Dynamic**: A dynamic threshold set by Sentry that detects anomalies whenever values fall outside expected bounds.
118119

119120
By default, metric alerts use a fixed threshold.
120121

@@ -126,6 +127,18 @@ Change alerts, or alerts that use a percent change threshold, are useful when yo
126127

127128
![When the percent change option is selected.](./img/percent-change.png)
128129

130+
### Dynamic Alerts
131+
132+
<Include name="feature-available-for-user-group-early-adopter.mdx" />
133+
134+
Dynamic alerts can be used when you don't know what threshold to set, but you know you want to be alerted when something is far outside the bounds of normalcy. Sentry will look at the historical data for the given metric and determine if the current data is anomalous. You can select how responsive the alert will be, and whether you want to be alerted when the metric is above, below, or both above and below the expected bounds.
135+
136+
Dynamic alerts do not use the Critical, Warning, and Resolved thresholds like other alert threshold types as you are not setting these yourself. When no more anomalies are detected, the alert will resolve.
137+
138+
TODO update this image when deploy is finished
139+
140+
![When the percent change option is selected.](./img/percent-change.png)
141+
129142
### Set Threshold to Trigger Alert
130143

131144
You can set the status of an alert rule when a threshold is met using the labels:

0 commit comments

Comments
 (0)