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

Update metric-alert-config.mdx #11753

Merged
merged 1 commit into from
Nov 6, 2024
Merged
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions docs/product/alerts/create-alerts/metric-alert-config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ There are three threshold types:

- **Static**: A fixed numerical threshold set by you. (For example, if there are 100 errors in a set period of time.)
- **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).
- **Dynamic**: A dynamic threshold set by Sentry that detects anomalies whenever values fall outside of expected bounds.
- **Anomaly**: A dynamic threshold maintained by Sentry that detects anomalies whenever values fall outside of expected bounds.

By default, metric alerts use a fixed threshold.

Expand All @@ -127,15 +127,15 @@ Change alerts, or alerts that use a percent change threshold, are useful when yo

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

### Dynamic Alerts
### Anomaly Alerts

<Include name="feature-available-for-plan-trial-business.mdx" />
<Include name="feature-available-for-user-group-early-adopter.mdx" />

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 have three options for the responsiveness of the alert: low, medium, and high. Low responsiveness means the alert will fire less frequently with each instance being higher signal. High responsiveness will capture more instances of the alert, which creates more coverage with a greater likelihood for false positives. Our recommendation is to start with our default (medium), and iterate based on the results you see.
Anomaly 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 have three options for the responsiveness of the alert: low, medium, and high. Low responsiveness means the alert will fire less frequently with each instance being higher signal. High responsiveness will capture more instances of the alert, which creates more coverage with a greater likelihood for false positives. Our recommendation is to start with our default (medium), and iterate based on the results you see.
Another setting is to set the direction of the alert: above and/or below the expected bounds. This setting can help increase the signal of your alert rule.

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. Dynamic alerts are not available for all metric alert types.
Critical and Resolved thresholds will be controlled by Sentry rather than the user. When no more anomalies are detected, the alert will resolve. Anomaly alerts are not available for all metric alert types.


![When the dynamic threshold is selected.](./img/dynamic-threshold.png)
Expand Down
Loading