-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Documentation for Monitors and Alerts #15041
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
base: master
Are you sure you want to change the base?
Changes from 5 commits
dac8a7c
e4d18ac
c17bd4d
90479af
9526e38
f58091d
3027a01
9ff2d31
10181db
c844fe5
829e0ef
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| title: Automations | ||
| description: Create custom automations to pair with monitors. | ||
| sidebar_order: 80 | ||
| --- | ||
|
|
||
| Sentry's Automations help you take action when issues occur in your project. When an issue changes state, is created, or passes a threshold, an automation is triggered to perform external actions like sending notifications, creating tickets, or calling webhooks and integrations. Automations must be paired with [Monitors](/product/monitors/) to run. | ||
|
|
||
| ### Some examples of when you could use an Automation | ||
| - Send a notification to your team's Slack channel when a new error occurs in an existing issue | ||
| - Create a ticket in JIRA when an issue is created and a team member is assigned | ||
| - Call a webhook or integration when an issue is created | ||
|
|
||
| [!automation-config](./img/automation-config.png) | ||
|
|
||
| ## Creating an Automation | ||
|
|
||
| To create an Automation, navigate to the [Automations](https://sentry.io/issues/automations/new/) page and click **Create Automation**. | ||
|
|
||
| {/* <Arcade src="https://demo.arcade.software/YOUR_ARCADE_ID?embed" /> */} | ||
|
|
||
| ### Set Triggers | ||
|
|
||
| A trigger is an action that must occur for the Automation to run. All trigger actions are issue state based. For example, you may want to send a notification to your team's Slack channel _when an issue is created_. You can select multiple triggers in a single Automation. They will run under an `ANY` condition, meaning that if any one of the triggers happen, the Automation will run. | ||
|
|
||
| ### Set Filters | ||
|
|
||
| Filters are conditions that must be met for the Automation to run. For example, you may want to create a ticket _only for issues that are assigned to a specific team_ and _at a certain severity_. You can create multiple filters in a single Automation, and group them under either `ANY` or `ALL` conditions. For `ANY` conditions, if any one of the filters are true, the Automation will run. For `ALL` conditions, only if all of the filters are true, the Automation will run. | ||
|
|
||
| ### Add Actions | ||
|
|
||
| Actions are the events that will be executed when the Automation is run. You can send notifications on any channel you're integrated with, create tickets, for example, in JIRA, or call a webhook or integration. You can set multiple actions in a single Automation. | ||
|
|
||
| ## Connecting Automations to Monitors | ||
|
|
||
| In order for Automations to run, you need to connect them to Monitors. To do so, navigate to the [Monitors](https://sentry.io/issues/monitors/) page and click on the monitor you want to connect the Automation to. Scroll to the **Automations** section and click **Connect Automation**. You can select the Automation you want to connect to the Monitor, or create a new one. | ||
|
|
||
| **Note**: If you set particular Environments as a filter in your Automation, it will only run for issues in those Environments, even if the Automation is connected to a Monitor that is filtered to different environments. | ||
|
|
||
| [!monitor-automations](./img/monitor-automations.png) | ||
|
|
||
| ## Managing Automations | ||
|
|
||
| You can see a list of all your Automations on the [Automations](https://sentry.io/issues/automations/) page. By default, Automations are filtered down to your projects. | ||
|
|
||
| <Alert> | ||
|
|
||
| Automations are an Organization-level feature. By default, only owners, managers, and team admins can create, update, and delete Automations. | ||
|
|
||
| </Alert> | ||
|
|
||
| By clicking on an Automation, you can view the details, edit the Automation, or turn it on or off. | ||
|
|
||
| The details page will show a high level chart of how often the Automation has run, a list of the most recent runs, the configuration, and connected monitors. | ||
|
|
||
| [!automation-details](./img/automation-details.png) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| --- | ||
| title: Monitors and Automations | ||
| sidebar_order: 10 | ||
| description: "Learn how Monitors and Automations help you customize your issue management process." | ||
| --- | ||
|
|
||
| [Monitors](/product/monitors/) and [Automations](/product/automations/) work together to help you create issues and take action when problems occur in your project. While they serve different purposes, they're designed to work as a team. | ||
|
|
||
| ## How They Work Together | ||
|
|
||
| **Monitors** are the "detectors" - they watch for specific conditions and create issues when those conditions are met. **Automations** are the "responders" - they take action when issues are created or change state and meet the filter criteria of the Automation. | ||
|
|
||
| Here's the typical flow: | ||
|
|
||
| 1. **Monitor detects a problem** → Creates an issue | ||
| 2. **Issue triggers Automation** → Takes external action (sends notifications, creates tickets, calls webhooks) | ||
|
|
||
| [!monitors-and-automations-flow-chart](./img/monitors-and-automations-flow-chart.png) | ||
|
|
||
| ## Monitors: Creating Issues | ||
|
|
||
| Monitors customize when errors and performance problems become issues. They can track: | ||
|
|
||
| - **Custom metrics** and span attributes | ||
| - **Scheduled jobs** (cron monitors) | ||
| - **HTTP endpoints** (uptime monitors) | ||
| - **Default behaviors** (errors, replays, traces, profiles) | ||
|
|
||
| [See all Monitor types](/product/monitors/#types-of-monitors) | ||
|
|
||
| When a monitor's conditions are met, it automatically creates an issue with the specified priority, assignee, and other attributes. | ||
|
|
||
| ## Automations: Taking Action | ||
|
|
||
| Automations respond to issue state changes by performing external actions like: | ||
|
|
||
| - Sending notifications to Slack, email, or other channels | ||
| - Creating tickets in JIRA or other project management tools | ||
| - Calling webhooks or integrations | ||
|
|
||
| ## The Connection | ||
|
|
||
| Automations must be connected to Monitors to run. This connection ensures that: | ||
|
|
||
| - Issues created by Monitors can trigger appropriate responses | ||
| - You have full control over both detection and response | ||
| - Actions are taken only for the issues you care about | ||
|
|
||
| ## Getting Started | ||
|
|
||
| 1. **Create a Monitor** to define when issues should be created | ||
| 2. **Create an Automation** to define what actions to take | ||
| 3. **Connect them** so the Automation responds to issues from that Monitor | ||
|
|
||
| Using Monitors and Automations gives you a complete workflow from problem detection to team notification, ticket creation, and more. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| --- | ||
| title: Monitors | ||
| description: Create custom monitors to track errors, performance, metrics, and more, as issues. | ||
| sidebar_order: 70 | ||
| --- | ||
|
|
||
| Sentry's Monitors are used to customize when to turn errors and performance problems into issues. They can be configured using conditional rules to create issues when specific criteria are met. For example, you could monitor when the duration of a transaction takes longer than 3 seconds on a particular browser. Further automate your issue creation experience using Monitors to automatically add assignees and set different priorities based on severity. | ||
|
|
||
| ## Types of Monitors | ||
|
|
||
| ### Custom Monitors | ||
|
|
||
| You can use Custom Monitors to track errors based on span attributes and custom metrics, the uptime and performance of any scheduled, recurring job, or the uptime and performance of any HTTP request. | ||
|
|
||
| - [Metric Monitors](#metric-monitor-settings): Track for errors based on span attributes and custom metrics. | ||
| - [Cron Monitors](/product/monitors/crons/): Track the uptime and performance of any scheduled, recurring job. | ||
| - [Uptime Monitors](placeholder): Track the uptime and performance of any HTTP request. | ||
|
|
||
| ### Default Monitors | ||
|
|
||
| Sentry also provides default monitors that are automatically created for you when you create a new project. | ||
|
|
||
| - **Error Monitor**: The default monitor based on [issue grouping/fingerprint rules](/concepts/data-management/event-grouping/) | ||
| - **Replay Monitor**: Once you've configured [Session Replay](/product/explore/session-replay/), issues will be created via the Replay Monitor | ||
| - **Trace Monitor**: Once you've configured [Tracing](/product/tracing/), issues will be created via the Trace Monitor | ||
| - **Profile Monitor**: Once you've configured [Profiling](/product/explore/profiling/), issues will be created via the Profile Monitor | ||
|
|
||
| ## Creating a Monitor | ||
|
|
||
| To create a Monitor, navigate to the [Monitors](https://sentry.io/issues/monitors/new/) page and click **Create Monitor**. You can choose between the three types of Monitors. Each one will have a separate configuration process. | ||
|
|
||
| ### General Settings | ||
|
|
||
| Monitors are made of attributes that define when to create an issue, and actions that define what to do when an issue is created. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Is this referring to assigning the issue, setting a priority, etc? Just to refresh my memory, are we differentiating these actions from alerts/automation Actions through capitalization?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, that's what it's referring to. Do we officially want to call these capital A actions? Happy to update. |
||
|
|
||
| - Name the Monitor | ||
| - Select the project, and in some cases, the environment | ||
| - Select attributes based on the Monitor type | ||
| - Set priority based on attributes | ||
| - Set the assignee | ||
| - Set auto-resolve based on attributes | ||
| - Connect [Custom Automations](/product/automations/custom-automations/) like notifications and ticket creation | ||
| to pair with your Monitor | ||
|
|
||
| <Alert type="note"> | ||
|
|
||
| Assignees set by [ownership rules](/product/issues/ownership-rules/) will override assignees set by Monitors. | ||
|
|
||
| </Alert> | ||
|
|
||
| {/* <Arcade src="https://demo.arcade.software/YOUR_ARCADE_ID?embed" /> */} | ||
|
|
||
| ### Metric Monitor Settings | ||
|
|
||
| Metric Monitors are used to track errors based on span attributes and custom metrics. | ||
|
|
||
| [!metric-monitor-config](./img/metric-monitor-config.png) | ||
|
|
||
| Choose the metric, the interval for how often to check, and the way you want to monitor for changes. You can choose an absolute number threshold, a percentage change, or dynamic anomaly detection. | ||
|
|
||
| ### Cron Monitor Settings | ||
|
|
||
| Cron Monitors are used to track the uptime and performance of any scheduled, recurring job. | ||
|
|
||
| [!cron-monitor-config](./img/cron-monitor-config.png) | ||
|
|
||
| Choose the schedule for how often to check, set the check-in margin, the max runtime, and failure tollerance. | ||
|
|
||
| ### Uptime Monitor Settings | ||
|
|
||
| Uptime Monitors are used to track the uptime and performance of any HTTP request. | ||
|
|
||
| [!uptime-monitor-config](./img/uptime-monitor-config.png) | ||
|
|
||
| Choose the URL and HTTP request you wish to monitor. Set the interval, timeout, and any headers you wish to include. | ||
|
|
||
| ## Managing Monitors | ||
|
|
||
| You can see a list of all your Monitors on the [Monitors](https://sentry.io/issues/monitors/) page. Select a Monitor type at the top of the page to narrow down the list. By default, Monitors are filtered down to your projects. | ||
|
|
||
| <Alert> | ||
|
|
||
| Monitors are a Project-level feature. By default, only owners, managers, and team admins can create, update, and delete Monitors. | ||
|
||
|
|
||
| </Alert> | ||
|
|
||
| By clicking on a Monitor, you can view the details, edit the Monitor, or disable it. | ||
|
|
||
| The details page will show a high level chart of the Monitor's performance, the configuration, created issue, and connected automations. | ||
|
|
||
| [!monitor-details](./img/monitor-details.png) | ||

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should remove "team admins" from this list, since automations are org-scoped so there are no teams that own the automations.
By default, the org setting "Let Members Create and Edit Alerts" is actually ON, so all members can create automations. Would it worth pointing out where you can change this behavior in settings?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to know! I'll update to mention where to change those settings.