Alerting docs: swap alert steps (#81249)

* Alerting docs: swap annotation and notification steps

* Updates data source managed rule steps
pull/81349/head
brendamuir 2 years ago committed by GitHub
parent c58dc09e84
commit 85429f7bd0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 42
      docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md
  2. 28
      docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md

@ -121,46 +121,46 @@ To do this, you need to make sure that your alert rule is in the right evaluatio
Use the guidelines in [No data and error handling](#configure-no-data-and-error-handling).
## Add annotations
## Configure notifications
Add [annotations][annotation-label]. to provide more context on the alert in your alert notifications.
Add labels to your alert rules to set which notification policy should handle your firing alert instances.
Annotations add metadata to provide more information on the alert in your alert notifications. For example, add a **Summary** annotation to tell you which value caused the alert to fire or which server it happened on.
All alert rules and instances, irrespective of their labels, match the default notification policy. If there are no nested policies, or no nested policies match the labels in the alert rule or alert instance, then the default notification policy is the matching policy.
1. [Optional] Add a summary.
1. Add labels if you want to change the way your notifications are routed.
Short summary of what happened and why.
Add custom labels by selecting existing key-value pairs from the drop down, or add new labels by entering the new key or value.
2. [Optional] Add a description.
1. Preview your alert instance routing set up.
Description of what the alert rule does.
Based on the labels added, alert instances are routed to the following notification policies displayed.
3. [Optional] Add a Runbook URL.
Expand each notification policy below to view more details.
Webpage where you keep your runbook for the alert
1. Click **See details** to view alert routing details and an email preview.
4. [Optional] Add a custom annotation
5. [Optional] Add a dashboard and panel link.
## Add annotations
Links alerts to panels in a dashboard.
Add [annotations][annotation-label]. to provide more context on the alert in your alert notification message.
## Configure notifications
Annotations add metadata to provide more information on the alert in your alert notification message. For example, add a **Summary** annotation to tell you which value caused the alert to fire or which server it happened on.
Add labels to your alert rules to set which notification policy should handle your firing alert instances.
1. [Optional] Add a summary.
All alert rules and instances, irrespective of their labels, match the default notification policy. If there are no nested policies, or no nested policies match the labels in the alert rule or alert instance, then the default notification policy is the matching policy.
Short summary of what happened and why.
1. Add labels if you want to change the way your notifications are routed.
1. [Optional] Add a description.
Add custom labels by selecting existing key-value pairs from the drop down, or add new labels by entering the new key or value.
Description of what the alert rule does.
1. Preview your alert instance routing set up.
1. [Optional] Add a Runbook URL.
Based on the labels added, alert instances are routed to the following notification policies displayed.
Webpage where you keep your runbook for the alert
Expand each notification policy below to view more details.
1. [Optional] Add a custom annotation
1. [Optional] Add a dashboard and panel link.
1. Click **See details** to view alert routing details and an email preview.
Links alerts to panels in a dashboard.
1. Click **Save rule**.

@ -90,6 +90,16 @@ Use alert rule evaluation to determine how frequently an alert rule should be ev
Once a condition is met, the alert goes into the **Pending** state. If the condition remains active for the duration specified, the alert transitions to the **Firing** state, else it reverts to the **Normal** state.
## Configure notifications
Add labels to your alert rules to set which notification policy should handle your firing alert instances.
All alert rules and instances, irrespective of their labels, match the default notification policy. If there are no nested policies, or no nested policies match the labels in the alert rule or alert instance, then the default notification policy is the matching policy.
1. Add labels if you want to change the way your notifications are routed.
Add custom labels by selecting existing key-value pairs from the drop down, or add new labels by entering the new key or value.
## Add annotations
Add [annotations][annotation-label]. to provide more context on the alert in your alert notifications.
@ -100,29 +110,19 @@ Annotations add metadata to provide more information on the alert in your alert
Short summary of what happened and why.
2. [Optional] Add a description.
1. [Optional] Add a description.
Description of what the alert rule does.
3. [Optional] Add a Runbook URL.
1. [Optional] Add a Runbook URL.
Webpage where you keep your runbook for the alert
4. [Optional] Add a custom annotation
5. [Optional] Add a dashboard and panel link.
1. [Optional] Add a custom annotation
1. [Optional] Add a dashboard and panel link.
Links alerts to panels in a dashboard.
## Configure notifications
Add labels to your alert rules to set which notification policy should handle your firing alert instances.
All alert rules and instances, irrespective of their labels, match the default notification policy. If there are no nested policies, or no nested policies match the labels in the alert rule or alert instance, then the default notification policy is the matching policy.
1. Add labels if you want to change the way your notifications are routed.
Add custom labels by selecting existing key-value pairs from the drop down, or add new labels by entering the new key or value.
1. Click **Save rule**.
{{% docs/reference %}}

Loading…
Cancel
Save