From 85429f7bd0e06ee7bdca8f450d1391025a6a7051 Mon Sep 17 00:00:00 2001 From: brendamuir <100768211+brendamuir@users.noreply.github.com> Date: Thu, 25 Jan 2024 12:02:35 +0100 Subject: [PATCH] Alerting docs: swap alert steps (#81249) * Alerting docs: swap annotation and notification steps * Updates data source managed rule steps --- .../create-grafana-managed-rule.md | 46 +++++++++---------- .../create-mimir-loki-managed-rule.md | 46 +++++++++---------- 2 files changed, 46 insertions(+), 46 deletions(-) diff --git a/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md b/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md index fcf95f3467a..4ab1fa8330f 100644 --- a/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md +++ b/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md @@ -121,29 +121,6 @@ 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 - -Add [annotations][annotation-label]. to provide more context on the alert in your alert notifications. - -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. - -1. [Optional] Add a summary. - - Short summary of what happened and why. - -2. [Optional] Add a description. - - Description of what the alert rule does. - -3. [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. - - 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. @@ -162,6 +139,29 @@ All alert rules and instances, irrespective of their labels, match the default n 1. Click **See details** to view alert routing details and an email preview. +## Add annotations + +Add [annotations][annotation-label]. to provide more context on the alert in your alert notification message. + +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. + +1. [Optional] Add a summary. + + Short summary of what happened and why. + +1. [Optional] Add a description. + + Description of what the alert rule does. + +1. [Optional] Add a Runbook URL. + + Webpage where you keep your runbook for the alert + +1. [Optional] Add a custom annotation +1. [Optional] Add a dashboard and panel link. + + Links alerts to panels in a dashboard. + 1. Click **Save rule**. ### Single and multi-dimensional rule diff --git a/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md index 496f96728ca..c52d77b7be8 100644 --- a/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md +++ b/docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md @@ -90,29 +90,6 @@ 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. -## Add annotations - -Add [annotations][annotation-label]. to provide more context on the alert in your alert notifications. - -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. - -1. [Optional] Add a summary. - - Short summary of what happened and why. - -2. [Optional] Add a description. - - Description of what the alert rule does. - -3. [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. - - 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. @@ -123,6 +100,29 @@ All alert rules and instances, irrespective of their labels, match the default n 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. + +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. + +1. [Optional] Add a summary. + + Short summary of what happened and why. + +1. [Optional] Add a description. + + Description of what the alert rule does. + +1. [Optional] Add a Runbook URL. + + Webpage where you keep your runbook for the alert + +1. [Optional] Add a custom annotation +1. [Optional] Add a dashboard and panel link. + + Links alerts to panels in a dashboard. + 1. Click **Save rule**. {{% docs/reference %}}