You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/docs/product/alerts/create-alerts/index.mdx
-1Lines changed: 0 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,6 @@ The minimum role required to create alerts is member. Sentry users with manager
12
12
13
13
To create alerts:
14
14
1. Navigate to **Alerts** and click "Create Alert Rule".
15
-
1. Select your project.
16
15
1. Choose what you want to be alerted about. Selecting “Issues” creates an [issue alert](/product/alerts/alert-types/#issue-alerts), while selecting any other option creates a [metric alert](/product/alerts/alert-types/#metric-alerts).
17
16

Copy file name to clipboardExpand all lines: src/docs/product/alerts/create-alerts/issue-alert-config.mdx
+10-6Lines changed: 10 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -16,13 +16,9 @@ Specify which <PlatformLink to="/configuration/environments/">environment(s)</Pl
16
16
17
17
The “Environment” dropdown list here has the same environments that are available for the selected project in the common “Environment” filter dropdown (this does not include hidden environments). Selecting "All Environments" is equivalent to having no environment filter.
18
18
19
-
## Team
20
-
21
-
You can choose a team to associate with an alert so that members of that team can edit the alert. Note that you can only make this association if you are a member of the team. If no team is selected, anyone can edit the alert.
19
+
## Project
22
20
23
-
## Alert Name
24
-
25
-
Give your alert a descriptive name, such as the team affected and the topic of the alert. For example, "Frontend Latency", "Backend Failure Rate", or "Billing Apdex".
21
+
Specify which project will use this particular alert rule. The created alert rule will only process events from this project.
26
22
27
23
## "When" Conditions: Triggers
28
24
@@ -120,6 +116,14 @@ The available intervals are:
120
116
- Hours: 3, 12, 24
121
117
- Days: 7, 30
122
118
119
+
## Alert Name
120
+
121
+
Give your alert a descriptive name, such as the team affected and the topic of the alert. For example, "Frontend Latency", "Backend Failure Rate", or "Billing Apdex".
122
+
123
+
## Team
124
+
125
+
You can choose a team to associate with an alert so that members of that team can edit the alert. Note that you can only make this association if you are a member of the team. If no team is selected, anyone can edit the alert.
126
+
123
127
## Project-Level Alert Settings
124
128
125
129
In **[Project] > Settings > Alerts**, you can configure alert email subject templates and digest settings. Sentry users with owner, manager, or admin permissions and above can change these default notification settings.
Copy file name to clipboardExpand all lines: src/docs/product/alerts/create-alerts/metric-alert-config.mdx
+44-26Lines changed: 44 additions & 26 deletions
Original file line number
Diff line number
Diff line change
@@ -8,34 +8,25 @@ description: "Learn more about the options for configuring a metric alert."
8
8
9
9
Sentry provides several configuration options to create a metric alert based on your organization's needs.
10
10
11
-
## Filters
12
-
13
-
The following set of filters translates into a [Discover query](/product/discover-queries/) that is displayed in the chart at the top of the alert configuration page.
14
-
15
-
### Environment
16
-
17
-
Specify which <PlatformLinkto="/configuration/environments/">environment(s)</PlatformLink> will use this particular alert rule. This control filters on the `environment` tag in your events. This filter is helpful because the urgency and workflows you apply to production alerts might differ from those you apply to alerts originating from your QA environment, for example.
18
-
19
-
The “Env:” dropdown list here has the same environments that are available for the selected project in the common “Environment” filter dropdown (this does not include hidden environments). Selecting "All" is equivalent to having no environment filter.
20
-
21
-
### Event Type
22
-
23
-
For some metric alerts, you can set the event type that you want to be alerted about in the “Events” dropdown:
11
+
## Metric (Type + Function + Time Interval)
24
12
25
-
-`event.type:error` OR `event.type:default`
26
-
-`event.type:default`
27
-
-`event.type:error`
28
-
-`event.type:transaction`
13
+
To create a metric alert you first need to choose a metric type. For some alert types the function is built into the alert and for others you can choose functions and parameters to apply to it. For example, if you select “Users Experiencing Errors”, that translates to the function, `count_unique(user.id)`. Since editing this function would change the nature of the alert, it is not editable and thus hidden. On the other hand, if you select “Largest Contentful Paint” the measurement used is `measurement.lcp`, you also need to choose a function, e.g. `p75()`, for a combined metric function of `p75(measurement.lcp)`.
29
14
30
-
### Tags & Attributes
15
+
### Metrics Types for Alerting
31
16
32
-
Add filters in the field provided to narrow down what you'll be alerted about, such as URL, tags, or other event properties.
33
-
34
-
## Metric (Function + Time Interval)
35
-
36
-
Depending on the type of alert you’ve selected, you may be able to choose functions and parameters to apply to it. In other cases, the function is built into the alert and the settings aren't displayed. For example, if you select “Number of Users Affected”, that translates to the function, `count_unique(user.id)`. Since editing this function would change the nature of the alert, it is not editable and thus hidden.
17
+
- Number of Errors
18
+
- Users Experiencing Errors
19
+
- Crash Free Session Rate
20
+
- Crash Free User Rate
21
+
- Throughput
22
+
- Transaction Duration
23
+
- Apdex
24
+
- Failure Rate
25
+
- Largest Contentful Paint
26
+
- First Input Delay
27
+
- Cumulative Layout Shift
37
28
38
-
### Functions for Alerting
29
+
### Functions for Metric Types
39
30
40
31
-`count()`
41
32
-`count_unique(...)`
@@ -59,11 +50,38 @@ Choose the time period over which to evaluate your metric. Your choices range be
59
50
- At 3:02pm: 2:02pm - 3:02pm
60
51
- ...
61
52
53
+
## Filters
54
+
55
+
The following set of filters translates into a [Discover query](/product/discover-queries/) that is displayed in the chart at the top of the alert configuration page.
56
+
57
+
### Project
58
+
59
+
Specify which project will use this particular alert rule. Created alert rule will only process events from this project.
60
+
61
+
### Environment
62
+
63
+
Specify which <PlatformLinkto="/configuration/environments/">environment(s)</PlatformLink> will use this particular alert rule. This control filters on the `environment` tag in your events. This filter is helpful because the urgency and workflows you apply to production alerts might differ from those you apply to alerts originating from your QA environment, for example.
64
+
65
+
The “Environment” dropdown list here has the same environments that are available for the selected project in the common “Environment” filter dropdown (this does not include hidden environments). Selecting "All Environments" is equivalent to having no environment filter.
66
+
67
+
### Event Type
68
+
69
+
For some metric alerts, you can set the event type that you want to be alerted about in the “Events” dropdown:
70
+
71
+
-`event.type:error` OR `event.type:default`
72
+
-`event.type:default`
73
+
-`event.type:error`
74
+
-`event.type:transaction`
75
+
76
+
### Tags & Attributes
77
+
78
+
Add filters in the field provided to narrow down what you'll be alerted about, such as URL, tags, or other event properties.
79
+
62
80
## Thresholds
63
81
64
82
There are two threshold types:
65
83
66
-
-**Count**: A fixed threshold, such as when there are 100 errors in a period of time.
84
+
-**Static**: A fixed threshold, such as when there are 100 errors in a period of time.
67
85
-**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).
68
86
69
87
By default, metric alerts use a fixed threshold.
@@ -76,7 +94,7 @@ This feature is available only if your organization is on either a Business or T
76
94
77
95
</Note>
78
96
79
-
Change alerts, or alerts that use a percent change threshold, are useful when you want to know if a metric is significantly different from normal. To do this, you’ll need to set the time period to compare to. One example would be comparing the number of errors in the last hour to the same time period one week ago. If errors are 25% higher in the last hour than they were in the same period a week ago, then an alert will trigger.
97
+
Change alerts, or alerts that use a percent change threshold, are useful when you want to know if a metric is significantly different from normal. To do this, you’ll need to pick a metric interval (when you're selecting your metric type) and a time against which to compare. One example would be comparing the number of errors in the last hour to the same time period one week ago. If errors are 25% higher in the last hour than they were in the same period a week ago, then an alert will trigger.
80
98
81
99

0 commit comments