From 35fba3833be1ad76f1de880920cdccdd409daddb Mon Sep 17 00:00:00 2001 From: Pepe Cano <825430+ppcano@users.noreply.github.com> Date: Thu, 13 Jun 2024 10:08:15 +0200 Subject: [PATCH] Alerting docs: fix example (#89132) * Fix matching label example * Update some wording * Update docs/sources/alerting/fundamentals/notifications/notification-policies.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Minor Timing options summary clarification * Clarify `Disable grouping` --------- Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> --- .../notifications/group-alert-notifications.md | 8 ++++---- .../fundamentals/notifications/notification-policies.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md b/docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md index 749b23c209c..eecbad7f530 100644 --- a/docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md +++ b/docs/sources/alerting/fundamentals/notifications/group-alert-notifications.md @@ -33,7 +33,7 @@ refs: # Group alert notifications -Grouping is an important feature of Grafana Alerting as it allows you to batch relevant alerts together into a smaller number of notifications. This is particularly important if notifications are delivered to first-responders, such as engineers on-call, where receiving lots of notifications in a short period of time can be overwhelming and in some cases can negatively impact a first-responders ability to respond to an incident. For example, consider a large outage where many of your systems are down. In this case, grouping can be the difference between receiving 1 phone call and 100 phone calls. +Grouping in Grafana Alerting allows you to batch relevant alerts together into a smaller number of notifications. This is particularly important if notifications are delivered to first-responders, such as engineers on-call, where receiving lots of notifications in a short period of time can be overwhelming. In some cases, it can negatively impact a first-responders ability to respond to an incident. For example, consider a large outage where many of your systems are down. In this case, grouping can be the difference between receiving 1 phone call and 100 phone calls. ## Group notifications @@ -42,7 +42,7 @@ Grouping combines similar alert instances within a specific period into a single In the notification policy, you can configure how to group multiple alerts into a single notification: - The `Group by` option specifies the criteria for grouping incoming alerts within the policy. The default is by alert rule. -- [Timing options](#timing-options) determine when to sent the notification. +- [Timing options](#timing-options) determine when and how often to send the notification. {{< figure src="/media/docs/alerting/alerting-notification-policy-diagram-with-labels-v3.png" max-width="750px" alt="A diagram about the components of a notification policy, including labels and groups" >}} @@ -65,7 +65,7 @@ If you want to group all alerts handled by the notification policy in a single g ### Disable grouping -If you want to receive every alert as a separate notification, you can do so by grouping by a special label called `...`. +If you want to receive every alert as a separate notification, you can do so by grouping by a special label called `...`, ensuring that other labels are not present. ## Timing options @@ -101,7 +101,7 @@ The longer the group wait, the more time other alerts have to be included in the Consider a notification policy that: -- Matches all alert instances with the `team` label—matching labels equals to `team=~".*"`. +- Matches all alert instances with the `team` label—matching labels equals to `team=~.+`. - Groups notifications by the `team` label—one group for each distinct `team`. - Sets the Group wait timer to `30s`. diff --git a/docs/sources/alerting/fundamentals/notifications/notification-policies.md b/docs/sources/alerting/fundamentals/notifications/notification-policies.md index 80eae663429..ab1200a2f68 100644 --- a/docs/sources/alerting/fundamentals/notifications/notification-policies.md +++ b/docs/sources/alerting/fundamentals/notifications/notification-policies.md @@ -88,7 +88,7 @@ The `team=security` policy is not a match and **Continue matching siblings** was {{< /collapse >}} -This routing and tree structure make it easy to organize and handle alerts for dedicated teams, while also narrowing down specific cases within the team by applying additional labels. +This routing and tree structure makes it convenient to organize and handle alerts for dedicated teams, while also narrowing down specific cases within the team by applying additional labels. ## Inheritance