mirror of
https://github.com/grafana/grafana.git
synced 2025-07-29 22:02:22 +08:00
Docs: alerting refactor (#57804)
* Docs: alerting refactor * fixes broken relrefs
This commit is contained in:
brendamuir
@ -51,4 +51,4 @@ Watch this video to learn more about how to create a Mimir managed alert rule: {
|
||||
- Add Runbook URL, panel, dashboard, and alert IDs.
|
||||
- Add custom labels.
|
||||
1. Click **Save** to save the rule or **Save and exit** to save the rule and go back to the Alerting page.
|
||||
1. Next, create a [notification]({{< relref "../notifications/" >}}) for the rule.
|
||||
1. Next, create a notification for the rule.
|
||||
|
||||
@ -9,13 +9,13 @@ keywords:
|
||||
- tutorials
|
||||
- ha
|
||||
- high availability
|
||||
title: ' Alerting high availability'
|
||||
weight: 450
|
||||
title: Alerting high availability
|
||||
weight: 430
|
||||
---
|
||||
|
||||
# About alerting high availability
|
||||
# Alerting high availability
|
||||
|
||||
The Grafana Alerting system has two main components: a `Scheduler` and an internal `Alertmanager`. The `Scheduler` evaluates your [alert rules]({{< relref "../fundamentals/evaluate-grafana-alerts/" >}}), while the internal Alertmanager manages **routing** and **grouping**.
|
||||
The Grafana Alerting system has two main components: a `Scheduler` and an internal `Alertmanager`. The `Scheduler` evaluates your alert rules, while the internal Alertmanager manages **routing** and **grouping**.
|
||||
|
||||
When running Grafana Alerting in high availability, the operational mode of the scheduler remains unaffected, and each Grafana instance evaluates all alerts. The operational change happens in the Alertmanager when it deduplicates alert notifications across Grafana instances.
|
||||
|
||||
@ -30,4 +30,6 @@ The two types of messages gossiped between Grafana instances are:
|
||||
|
||||
The notification logs and silences are persisted in the database periodically and during a graceful Grafana shut down.
|
||||
|
||||
For configuration instructions, refer to [enable alerting high availability]({{< relref "enable-alerting-ha/" >}}).
|
||||
## Useful links
|
||||
|
||||
[Configure alerting high availability](https://grafana.com/docs/grafana/next/alerting/set-up/configure-high-availability)
|
||||
@ -11,11 +11,11 @@ keywords:
|
||||
- guide
|
||||
- notification policies
|
||||
- routes
|
||||
title: Create notification policies
|
||||
title: Manage notification policies
|
||||
weight: 300
|
||||
---
|
||||
|
||||
# Create notification policies
|
||||
# Manage notification policies
|
||||
|
||||
Notification policies determine how alerts are routed to contact points. Policies have a tree structure, where each policy can have one or more child policies. Each policy, except for the root policy, can also match specific alert labels. Each alert is evaluated by the root policy and subsequently by each child policy. If you enable the `Continue matching subsequent sibling nodes` option is enabled for a specific policy, then evaluation continues even after one or more matches. A parent policy’s configuration settings and contact point information govern the behavior of an alert that does not match any of the child policies. A root policy governs any alert that does not match a specific policy.
|
||||
|
||||
|
||||
@ -6,10 +6,11 @@ keywords:
|
||||
- alerting
|
||||
- images
|
||||
- notifications
|
||||
title: Images in notifications
|
||||
title: Use images in notifications
|
||||
weight: 460
|
||||
---
|
||||
|
||||
# Images in notifications
|
||||
# Use images in notifications
|
||||
|
||||
Images in notifications helps recipients of alert notifications better understand why an alert has fired or resolved by including an image of the panel associated with the Grafana managed alert rule.
|
||||
|
||||
@ -22,7 +23,7 @@ If Grafana is set up to send images in notifications, it takes a screenshot of t
|
||||
|
||||
Grafana does not support images for alert rules that are not associated with a panel. An alert rule is associated with a panel when it has both Dashboard UID and Panel ID annotations.
|
||||
|
||||
Images are stored in the [data]({{< relref "../setup-grafana/configure-grafana/#paths" >}}) path and so Grafana must have write-access to this path. If Grafana cannot write to this path then screenshots cannot be saved to disk and an error will be logged for each failed screenshot attempt. In addition to storing images on disk, Grafana can also store the image in an external image store such as Amazon S3, Azure Blob Storage, Google Cloud Storage and even Grafana where screenshots are stored in `public/img/attachments`. Screenshots older than `temp_data_lifetime` are deleted from disk but not the external image store. If Grafana is the external image store then screenshots are deleted from `data` but not from `public/img/attachments`.
|
||||
Images are stored in the [data]({{< relref "../../setup-grafana/configure-grafana/#paths" >}}) path and so Grafana must have write-access to this path. If Grafana cannot write to this path then screenshots cannot be saved to disk and an error will be logged for each failed screenshot attempt. In addition to storing images on disk, Grafana can also store the image in an external image store such as Amazon S3, Azure Blob Storage, Google Cloud Storage and even Grafana where screenshots are stored in `public/img/attachments`. Screenshots older than `temp_data_lifetime` are deleted from disk but not the external image store. If Grafana is the external image store then screenshots are deleted from `data` but not from `public/img/attachments`.
|
||||
|
||||
> **Note**: It is recommended that you use an external image store, as not all contact points support uploading images from disk. It is also possible that the image on disk is deleted before an alert notification is sent if `temp_data_lifetime` is less than the `group_wait` and `group_interval` options used in Alertmanager.
|
||||
|
||||
@ -32,7 +33,7 @@ To use images in notifications, Grafana must be set up to use [image rendering](
|
||||
|
||||
## Configuration
|
||||
|
||||
If Grafana has been set up to use [image rendering]({{< relref "../setup-grafana/image-rendering/" >}}) images in notifications can be turned on via the `capture` option in `[unified_alerting.screenshots]`:
|
||||
If Grafana has been set up to use image rendering, images in notifications can be turned on via the `capture` option in `[unified_alerting.screenshots]`:
|
||||
|
||||
# Enable screenshots in notifications. This option requires the Grafana Image Renderer plugin.
|
||||
# For more information on configuration options, refer to [rendering].
|
||||
@ -7,6 +7,7 @@ aliases:
|
||||
- /docs/grafana/latest/alerting/alert-groups/
|
||||
- /docs/grafana/latest/alerting/alert-groups/view-alert-grouping/
|
||||
- /docs/grafana/latest/alerting/unified-alerting/alert-groups/
|
||||
- -docs/grafana/latest/alerting/manage-notifications/view-alert-groups/
|
||||
description: Alert groups
|
||||
keywords:
|
||||
- grafana
|
||||
@ -14,7 +15,7 @@ keywords:
|
||||
- alerts
|
||||
- groups
|
||||
title: View and filter by alert groups
|
||||
weight: 445
|
||||
weight: 455
|
||||
---
|
||||
|
||||
# View and filter by alert groups
|
||||
@ -29,8 +29,7 @@ longer supported. We refer to these as [Differences]({{< relref "#differences" >
|
||||
|
||||
4. Notification channels are migrated to an Alertmanager configuration with the appropriate routes and receivers. Default notification channels are added as contact points to the default route. Notification channels not associated with any Dashboard alert go to the `autogen-unlinked-channel-recv` route.
|
||||
|
||||
5. Unlike legacy dashboard alerts where images in notifications are enabled per contact point, images in notifications for Grafana Alerting must be enabled in the Grafana configuration, either in the configuration file or environment variables, and are enabled for either all or no contact points. Please refer to the [documentation for images in notifications]({{< relref "../images-in-notifications" >}}).
|
||||
|
||||
5. Unlike legacy dashboard alerts where images in notifications are enabled per contact point, images in notifications for Grafana Alerting must be enabled in the Grafana configuration, either in the configuration file or environment variables, and are enabled for either all or no contact points. Refer to [images in notifications](https://grafana.com/docs/grafana/latest/alerting/manage-notifications/images-in-notifications/).
|
||||
6. Grafana Alerting does not support pausing the evaluation of alert rules. After migration, all paused alert rules will become active, which may cause unexpected notifications to be sent.
|
||||
|
||||
## Limitations
|
||||
|
||||
@ -2,6 +2,7 @@
|
||||
aliases:
|
||||
- /docs/grafana/latest/alerting/high-availability/enable-alerting-ha/
|
||||
- /docs/grafana/latest/alerting/unified-alerting/high-availability/
|
||||
- /docs/grafana/latest/alerting/set-up/configure-high-availability
|
||||
description: Enable alerting high availability
|
||||
keywords:
|
||||
- grafana
|
||||
@ -10,12 +11,12 @@ keywords:
|
||||
- ha
|
||||
- high availability
|
||||
title: Enable alerting high availability
|
||||
weight: 450
|
||||
weight: 300
|
||||
---
|
||||
|
||||
# Enable alerting high availability
|
||||
|
||||
You can enable [alerting high availability]({{< relref "_index.md" >}}) support by updating the Grafana configuration file. On Kubernetes, you can enable alerting high availability by updating the Kubernetes container definition.
|
||||
You can enable alerting high availability support by updating the Grafana configuration file. On Kubernetes, you can enable alerting high availability by updating the Kubernetes container definition.
|
||||
|
||||
## Update Grafana configuration file
|
||||
|
||||
@ -1311,7 +1311,7 @@ The interval string is a possibly signed sequence of decimal numbers, followed b
|
||||
|
||||
## [unified_alerting.screenshots]
|
||||
|
||||
For more information about screenshots, refer to [Images in notifications]({{< relref "../../alerting/images-in-notifications/" >}}).
|
||||
For more information about screenshots, refer to [Images in notifications(https://grafana.com/docs/grafana/latest/alerting/manage-notifications/images-in-notifications)].
|
||||
|
||||
### capture
|
||||
|
||||
@ -1329,7 +1329,7 @@ Uploads screenshots to the local Grafana server or remote storage such as Azure,
|
||||
|
||||
## [unified_alerting.reserved_labels]
|
||||
|
||||
For more information about Grafana Reserved Labels, refer to [Labels in Grafana Alerting]({{< relref "../../alerting/fundamentals/annotation-label/how-to-use-labels/#grafana-reserved-labels" >}}).
|
||||
For more information about Grafana Reserved Labels, refer to [Labels in Grafana Alerting](https://grafana.com/docs/grafana/next/alerting/fundamentals/annotation-label/how-to-use-labels/)
|
||||
|
||||
### disabled_labels
|
||||
|
||||
|
||||
@ -29,9 +29,9 @@ Grafana will now persist all long term data in the database. How to configure th
|
||||
|
||||
## Alerting high availability
|
||||
|
||||
Grafana Alerting provides a new [highly-available model]({{< relref "../alerting/high-availability/" >}}). It also preserves the semantics of legacy dashboard alerting by executing all alerts on every server and by sending notifications only once per alert. Load distribution between servers is not supported at this time.
|
||||
Grafana Alerting provides a new [high availability mode](https://grafana.com/docs/grafana/latest/alerting/fundamentals/high-availability). It also preserves the semantics of legacy dashboard alerting by executing all alerts on every server and by sending notifications only once per alert. Load distribution between servers is not supported at this time.
|
||||
|
||||
For instructions on setting up alerting high availability, see [Enable alerting high availability]({{< relref "../alerting/high-availability/enable-alerting-ha/" >}}).
|
||||
For instructions on setting up alerting high availability, refer to [Enable alerting high availability](https://grafana.com/docs/grafana/latest/alerting/set-up/configure-high-availability/).
|
||||
|
||||
**Legacy dashboard alerts**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user