Skip to content
Open
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Issue tracking allows you to create Height tasks from within [sentry.io](https:/

### Automatically

To configure issue management automatically, create an [issue alert](/product/alerts/alert-types/#issue-alerts) or a [metric alert](/product/alerts/alert-types/#metric-alerts). When selecting the [action](/product/alerts/create-alerts/issue-alert-config/#then-conditions-actions), choose "Notify Integration" and then "Height" for issue alerts, or select "Height" from the action dropdown for metric alerts:
To configure issue management automatically, create an [issue alert](/product/alerts/alert-types/#issue-alerts) or a [performance metric alert](/product/alerts/alert-types/#performance-metric-alerts). Performance metric alerts create issues in Sentry when triggered, so you can send those issues to Height the same way as issue alerts. When selecting the [action](/product/alerts/create-alerts/issue-alert-config/#then-conditions-actions), choose "Notify Integration" and then "Height" for issue alerts, or select "Height" from the action dropdown for performance metric alerts:

![Height metric alert rule action settings](./img/height-rule.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Issue tracking allows you to create Linear issues from within Sentry, and link S

### Automatically

To configure issue management automatically, create an [issue alert](/product/alerts/alert-types/#issue-alerts) or a [metric alert](/product/alerts/alert-types/#metric-alerts). When selecting the [action](/product/alerts/create-alerts/issue-alert-config/#then-conditions-actions), choose "Notify Integration" and then "Linear" for issue alerts, or select "Linear" from the action dropdown for metric alerts:
To configure issue management automatically, create an [issue alert](/product/alerts/alert-types/#issue-alerts) or a [performance metric alert](/product/alerts/alert-types/#performance-metric-alerts). Performance metric alerts create issues in Sentry when triggered, so you can send those issues to Linear the same way as issue alerts. When selecting the [action](/product/alerts/create-alerts/issue-alert-config/#then-conditions-actions), choose "Notify Integration" and then "Linear" for issue alerts, or select "Linear" from the action dropdown for performance metric alerts:

![Create Linear issue as metric alert rule action](./img/linear-rule.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ In [issue alerts](/product/alerts/alert-types/#issue-alerts), select "Send a Mic

![Microsoft Teams alert rule action](./img/msteams-add-action.png)

In [metric alerts](/product/alerts/alert-types/#metric-alerts), select the Microsoft Teams option in the dropdown that corresponds to your team and then enter the username or channel:
In [performance metric alerts](/product/alerts/alert-types/#performance-metric-alerts), select the Microsoft Teams option in the dropdown that corresponds to your team and then enter the username or channel:

![Microsoft Teams metric alert rule action](./img/msteams_metric_alert_rule.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Here is what a sample issue alert looks like in Opsgenie:

![Opsgenie sample alert](./img/opsgenie-sample-alert.png)

If you'd rather be alerted when a specific metric crosses a threshold, you can set a [metric alert](/product/alerts/alert-types/#metric-alerts) by following the same steps as above. Once you've chosen the metric you want to be alerted about, click "Add Action", then select Opsgenie from the notification types dropdown. You can also select a custom priority for the alert, or leave it blank to use the default severity level that Sentry provides for incident statuses ("P1" for critical status and "P2" for warning status)
If you'd rather be alerted when a specific metric crosses a threshold, you can set a [performance metric alert](/product/alerts/alert-types/#performance-metric-alerts) by following the same steps as above. Once you've chosen the metric you want to be alerted about, click "Add Action", then select Opsgenie from the notification types dropdown. You can also select a custom priority for the alert, or leave it blank to use the default severity level that Sentry provides for incident statuses ("P1" for critical status and "P2" for warning status)

![Opsgenie metric alert rule action](./img/opsgenie-metric-alert-rule.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ In [issue alerts](/product/alerts/alert-types/#issue-alerts), select "Send a Pag

![PagerDuty alert rule action](./img/pd_alert_rule.png)

In [metric alerts](/product/alerts/alert-types/#metric-alerts), select the PagerDuty option in the dropdown that corresponds to your account and the select your service. You can also select a custom severity for the alert, or leave it blank to use the default severity level that Sentry provides for incident statuses ("critical" for critical status and "warning" for warning status).
In [performance metric alerts](/product/alerts/alert-types/#performance-metric-alerts), select the PagerDuty option in the dropdown that corresponds to your account and the select your service. You can also select a custom severity for the alert, or leave it blank to use the default severity level that Sentry provides for incident statuses ("critical" for critical status and "warning" for warning status).

![PagerDuty metric alert rule action](./img/pd_metric_alert_rule.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Once you receive a Slack notification for an issue alert, you can use the "Resol

#### Metric Alerts

In [metric alerts](/product/alerts/alert-types/#metric-alerts), select the Slack option in the dropdown that corresponds to your workspace and the select your channel:
In [performance metric alerts](/product/alerts/alert-types/#performance-metric-alerts), select the Slack option in the dropdown that corresponds to your workspace and the select your channel:

![Slack metric alert action](./img/slack_metric_alert.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/pricing/quotas/spike-protection.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ We recommend taking the following steps to manage your spikes:

- Check to see which issues are [consuming your quota](https://sentry.io/orgredirect/organizations/:orgslug/stats/).
- Set [rate limits](/pricing/quotas/manage-event-stream-guide/#rate-limiting) on the DSN keys for the projects related to the spike.
- Set up [metric alerts](/product/alerts/alert-types/#metric-alerts) for the number of events in a project.
- Set up [performance metric alerts](/product/alerts/alert-types/#performance-metric-alerts) for the number of events in a project.
- If a specific release version has caused the spike, add the version identifier to the project's [inbound filters](/pricing/quotas/manage-event-stream-guide/#inbound-data-filters) to avoid accepting events from that release.
- Set up a [pay-as-you-go budget](/pricing/#pricing-how-it-works) to make sure you have time to adjust your volume in the event of a future spike.

Expand Down
12 changes: 8 additions & 4 deletions docs/product/alerts/alert-types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,24 @@ The **Alert Details** page shows you the number of times an issue alert rule was

The **Alert Details** page also includes a list of issues that triggered the alert. You can click on any of the issues in the list to go to that issue's details page for more information.

## Metric Alerts
## Performance Metric Alerts

Metric alerts tell you when a [metric](/product/insights/overview/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/insights/overview/metrics/#latency), [Apdex](/product/insights/overview/metrics/#apdex), [failure rate](/product/insights/overview/metrics/#failure-rate), or [throughput](/product/insights/overview/metrics/#throughput-total-tpm-tps). You can use [dynamic alerts](/product/alerts/create-alerts/metric-alert-config/#dynamic-alerts) to let Sentry define the threshold for you.
Performance Metric alerts tell you when a [performance metric](/product/insights/overview/metrics/) crosses a threshold set by you, like a spike in the number of errors in a project, or a change in a metric, such as [transaction duration](/product/insights/overview/metrics/#latency), [Apdex](/product/insights/overview/metrics/#apdex), [failure rate](/product/insights/overview/metrics/#failure-rate), or [throughput](/product/insights/overview/metrics/#throughput-total-tpm-tps). You can use [dynamic alerts](/product/alerts/create-alerts/metric-alert-config/#dynamic-alerts) to let Sentry define the threshold for you.

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.
Performance 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 performance 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 performance metric alerts for an organization.

<Alert>

Metric alerts may include [archived issues](/product/issues/states-triage/#archive) if events from those issues match the filters of your metric alert rule. Events from archived and resolved issues can be filtered out by using the `is:unresolved` filter in your metric alert rule. This filter is added by default when creating a new metric alert, but you may need to manually add it to older metric alerts if you want them to exclude archived issues.
Performance Metric alerts may include [archived issues](/product/issues/states-triage/#archive) if events from those issues match the filters of your metric alert rule. Events from archived and resolved issues can be filtered out by using the `is:unresolved` filter in your metric alert rule. This filter is added by default when creating a new metric alert, but you may need to manually add it to older metric alerts if you want them to exclude archived issues.

</Alert>

These alerts use _Critical_ and _Warning_ triggers to measure severity. An alert’s current status is the highest severity trigger that is active, which can be one of three values: Warning, Critical, or Resolved. Sentry notifies you whenever an alert's status changes.

### Performance Metric Alerts create Issues

When you create a Performance Metric Alert, Sentry will automatically create an [Issue](/product/issues/) for you. This issue will be associated with the performance metric alert. You can see related Issues on the Alert Details page. You can find your alerts [here](https://sentry.io/orgredirect/organizations/:orgslug/issues/alerts/rules/).

When you create an alert, all the displayed alert types (except “Issues”) may be used to create a metric alert. You can create metric alerts for Errors, Sessions (Crash Rate Alerts), and Performance:

### Errors
Expand Down
2 changes: 1 addition & 1 deletion docs/product/alerts/best-practices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Learn best practices for creating alerts."

Alerts should notify you when there's an important problem with your application. But they shouldn't be too noisy, because that can lead to alert fatigue. The following best practices will help you create relevant alerts that notify the right people — that is, the people equipped to fix the problem.

There are two types of alerts: [issue alerts](/product/alerts/alert-types/#issue-alerts) and [metric alerts](/product/alerts/alert-types/#metric-alerts). Most of our alerting best practices are specific to issue alerts, however, the [alert conditions best practices](#alert-conditions-best-practices) apply to both issue and metric alerts.
There are two types of alerts: [issue alerts](/product/alerts/alert-types/#issue-alerts) and [performance metric alerts](/product/alerts/alert-types/#performance-metric-alerts). Performance metric alerts also create issues when triggered, so you can triage and assign them like issue alerts. Most of our alerting best practices are specific to issue alerts, however, the [alert conditions best practices](#alert-conditions-best-practices) apply to both issue and performance metric alerts.

## Issue Alerts Best Practices

Expand Down
4 changes: 2 additions & 2 deletions docs/product/alerts/create-alerts/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The minimum role required to create alerts is member. Sentry users with manager
To create alerts:

1. Navigate to **Alerts** and click "Create Alert Rule".
1. Choose what you want to be alerted about. Selecting “Issues” creates an [issue alert](/product/alerts/alert-types/#issue-alerts), selecting “Uptime Monitor” creates an [uptime alert](/product/alerts/alert-types/#uptime-alerts), while selecting any other option creates a [metric alert](/product/alerts/alert-types/#metric-alerts).
1. Choose what you want to be alerted about. Selecting “Issues” creates an [issue alert](/product/alerts/alert-types/#issue-alerts), selecting “Uptime Monitor” creates an [uptime alert](/product/alerts/alert-types/#uptime-alerts), while selecting any other option creates a [performance metric alert](/product/alerts/alert-types/#performance-metric-alerts). Performance metric alerts also create issues when triggered.
![Choice between alerts about Errors, Sessions, Performance, or a Custom Metric](./img/create-new-alert-rule.png)

1. Click "Set Conditions".
Expand All @@ -27,7 +27,7 @@ To create alerts:

## Duplicate Alerts

You can also create an alert by duplicating an existing issue or metric alert rule. To do so, navigate to **Alerts** and click "Duplicate" in the context menu (under "Actions") on the row with the alert rule you want to copy:
You can also create an alert by duplicating an existing issue or performance metric alert rule. To do so, navigate to **Alerts** and click "Duplicate" in the context menu (under "Actions") on the row with the alert rule you want to copy:

![Expanded alert list row context menu](./img/alert-list-row-menu.png)

Expand Down
4 changes: 2 additions & 2 deletions docs/product/alerts/create-alerts/metric-alert-config.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Metric Alert Configuration
sidebar_order: 20
description: Learn more about the options for configuring a metric alert.
description: Learn more about the options for configuring a performance metric alert.
og_image: /og-images/product-alerts-create-alerts-metric-alert-config.png
---

Sentry provides several configuration options to create a metric alert based on your organization's needs.
Sentry provides several configuration options to create a performance metric alert based on your organization's needs. When a performance metric alert is triggered, Sentry automatically creates an [issue](/product/issues/) that you can view, triage, and assign on the [Alert Details](/product/alerts/alert-types/#performance-metric-alerts) page.

## Metric (Type + Function + Time Interval)

Expand Down
16 changes: 12 additions & 4 deletions docs/product/alerts/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,25 +27,33 @@ The **Alerts** page also displays a “History” tab where you can find a list

You can find a full list of issue alert triggers in [Issue Alert Configuration](/product/alerts/create-alerts/issue-alert-config/#when-conditions-triggers).

## Metric Alerts for Errors & Performance
## Performance Metric Alerts

[Metric alerts](/product/alerts/alert-types/#metric-alerts) trigger when a [metric](/product/insights/overview/metrics/) is breached for either error or transaction events. Use metric alerts to monitor a finite and known set of metrics and components you care about, such as error frequency or performance metrics in your entire project, on important pages, or with specific tags.
[Performance Metric alerts](/product/alerts/alert-types/#performance-metric-alerts) trigger when a [performance metric](/product/insights/overview/metrics/) is breached for either error or transaction events. Use performance metric alerts to monitor a finite and known set of metrics you care about, such as error frequency or crash-free session rate. Do this for your entire project, on important pages, or with specific tags.

Create alerts to monitor specific metrics, such as:
**Some examples of available performance metric alerts:**

- Total errors in your project
- [Latency](/product/insights/overview/metrics/#latency): min, max, average, percentile
- [Failure rate](/product/insights/overview/metrics/#failure-rate)
- Crash free session or user rate for monitoring release health
- Custom metrics

You can find a full list of available metric alerts in [Metric Alerts](/product/alerts/alert-types/#metric-alerts).
### Performance Metric Alerts create Issues

When you create a Performance Metric Alert, Sentry will automatically create an [Issue](/product/issues/) for you. This issue will be associated with the performance metric alert. You can see related Issues on the Alert Details page. You can find your alerts [here](https://sentry.io/orgredirect/organizations/:orgslug/issues/alerts/rules/).

Read more details about Performance Metric Alerts [here](/product/alerts/alert-types/#performance-metric-alerts). Check out the full list of available Performance Metrics on the [Alert Config page](https://sentry.io/orgredirect/organizations/:orgslug/issues/alerts/wizard/?referrer=alert_stream).

## Uptime Monitoring Alerts

[Uptime alerts](/product/uptime-monitoring/) are triggered when an uptime HTTP check request fails to meet the
[uptime check criteria](/product/uptime-monitoring/#uptime-check-criteria). You can customize when alerts are triggered using [thresholds](/product/alerts/create-alerts/uptime-alert-config/#4-thresholds) and define custom success criteria with [verification](/product/alerts/create-alerts/uptime-alert-config/#5-verification) (early access). Use uptime alerts to make sure a specific URL is constantly available, even during periods of low or no traffic.

## Cron Monitor Alerts

[Cron monitor alerts](/product/crons/) are triggered when a scheduled, recurring job misses a check-in, exceeds its maximum runtime, or reports a failure. You can view and manage cron monitors from the **Alerts** page by filtering by the "Cron Monitors" alert type. Use cron monitor alerts to ensure critical jobs run on schedule and complete successfully. Set up monitoring and configure alerts in [Cron Monitoring](/product/crons/getting-started/).

## Creating Alerts

When you create a new project in [sentry.io](https://sentry.io), you can select a default issue alert. However, you can also [create your own alerts](/product/alerts/create-alerts/) to suit your team’s needs, using these [alert best practices](/product/alerts/best-practices/) as a guide.
Expand Down
Loading