From 029244b1d473acd0b5ea20ddedf0e80a83225a10 Mon Sep 17 00:00:00 2001 From: Taylan Gocmen Date: Wed, 1 Jun 2022 10:03:57 -0700 Subject: [PATCH] feat(alerts): Alert wizard v3 alert config docs --- .../product/alerts/create-alerts/index.mdx | 1 - .../create-alerts/issue-alert-config.mdx | 8 ++- .../create-alerts/metric-alert-config.mdx | 66 ++++++++++++------- 3 files changed, 48 insertions(+), 27 deletions(-) diff --git a/src/docs/product/alerts/create-alerts/index.mdx b/src/docs/product/alerts/create-alerts/index.mdx index 8435a72e19a14..899b4a32c9088 100644 --- a/src/docs/product/alerts/create-alerts/index.mdx +++ b/src/docs/product/alerts/create-alerts/index.mdx @@ -12,7 +12,6 @@ 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. Select your project. 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). ![Choice between alerts about Errors, Sessions, Performance, or a Custom Metric](create-new-alert-rule.png) diff --git a/src/docs/product/alerts/create-alerts/issue-alert-config.mdx b/src/docs/product/alerts/create-alerts/issue-alert-config.mdx index 607d91edc8511..933276ab5ee41 100644 --- a/src/docs/product/alerts/create-alerts/issue-alert-config.mdx +++ b/src/docs/product/alerts/create-alerts/issue-alert-config.mdx @@ -16,14 +16,18 @@ Specify which environment(s)environment(s) 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. - -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. - -### Event Type - -For some metric alerts, you can set the event type that you want to be alerted about in the “Events” dropdown: +## Metric (Type + Function + Time Interval) -- `event.type:error` OR `event.type:default` -- `event.type:default` -- `event.type:error` -- `event.type:transaction` +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)`. -### Tags & Attributes +### Metrics Types for Alerting -Add filters in the field provided to narrow down what you'll be alerted about, such as URL, tags, or other event properties. - -## Metric (Function + Time Interval) - -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. +- `Number of Errors` +- `Users Experiencing Errors` +- `Crash Free Session Rate` +- `Crash Free User Rate` +- `Throughput` +- `Transaction Duration` +- `Apdex` +- `Failure Rate` +- `Largest Contentful Paint` +- `First Input Delay` +- `Cumulative Layout Shift` -### Functions for Alerting +### Functions for Metric Types - `count()` - `count_unique(...)` @@ -59,6 +50,33 @@ Choose the time period over which to evaluate your metric. Your choices range be - At 3:02pm: 2:02pm - 3:02pm - ... +## Filters + +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. + +### Environment + +Specify which environment(s) 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. + +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. + +## Project + +Specify which project will use this particular alert rule. Created alert rule will only process events from this project. + +### Event Type + +For some metric alerts, you can set the event type that you want to be alerted about in the “Events” dropdown: + +- `event.type:error` OR `event.type:default` +- `event.type:default` +- `event.type:error` +- `event.type:transaction` + +### Tags & Attributes + +Add filters in the field provided to narrow down what you'll be alerted about, such as URL, tags, or other event properties. + ## Thresholds There are two threshold types: