mirror of https://github.com/grafana/grafana
docs(alerting): simplify Intro to Grafana Alerting docs (#106944)
* docs(alerting): improve `Intro > Alert rule evaluation` docs * Update Introduction to Grafana Alerting * Simplify `Intro > Alert rules` and related docs * minor copy change phrasing GMA and DS differences * fix vale errorpull/105632/head^2
Pepe Cano
19 hours ago
committed by
GitHub
parent
f8189eece9
commit
5c1b263664
@ -0,0 +1,58 @@ |
||||
--- |
||||
canonical: https://grafana.com/docs/grafana/latest/alerting/fundamentals/alert-rule-evaluation/alert-rule-state-and-health/ |
||||
description: An alert instance is considered stale when its series disappears for a number of consecutive evaluation intervals. Learn how Grafana resolves them. |
||||
keywords: |
||||
- grafana |
||||
- alerting |
||||
- guide |
||||
- state |
||||
labels: |
||||
products: |
||||
- cloud |
||||
- enterprise |
||||
- oss |
||||
title: Alert rule state and health |
||||
weight: 130 |
||||
refs: |
||||
example-multi-dimensional-alerts: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/best-practices/multi-dimensional-alerts/ |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana-cloud/alerting-and-irm/alerting/best-practices/multi-dimensional-alerts/ |
||||
alert-instance-states: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/fundamentals/alert-rule-evaluation/nodata-and-error-states/#alert-instance-states |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana-cloud/alerting-and-irm/alerting/fundamentals/alert-rule-evaluation/nodata-and-error-states/#alert-instance-states |
||||
--- |
||||
|
||||
# Alert rule state and health |
||||
|
||||
Each alert rule can generate one or more alert instances—one alert instance for each series or dimension, as shown in the [multi-dimensional alert example](ref:example-multi-dimensional-alerts). |
||||
|
||||
Each alert instance of the same alert rule represents a different target and can be in a different state; for example, one alert instance may be **Normal** while another is **Alerting**. |
||||
|
||||
{{< figure src="/media/docs/alerting/alert-rule-example-multiple-alert-instances.png" max-width="750px" alt="Multi dimensional alert rule. The alert rule state and alert rule health are determined by the state of the alert instances." >}} |
||||
|
||||
The alert rule state and alert rule health are determined by the [state of the alert instances](ref:alert-instance-states). |
||||
|
||||
## Alert rule states |
||||
|
||||
An alert rule can be in either of the following states: |
||||
|
||||
| State | Description | |
||||
| ----------- | ---------------------------------------------------------------------------------------------------- | |
||||
| **Normal** | None of the alert instances returned by the evaluation engine is in a `Pending` or `Alerting` state. | |
||||
| **Pending** | At least one alert instances returned by the evaluation engine is `Pending`. | |
||||
| **Firing** | At least one alert instances returned by the evaluation engine is `Alerting`. | |
||||
|
||||
## Alert rule health |
||||
|
||||
An alert rule can have one of the following health statuses: |
||||
|
||||
| State | Description | |
||||
| ---------------------- | -------------------------------------------------------------------------------------------------------- | |
||||
| **Ok** | No error when evaluating the alert rule. | |
||||
| **Error** | An error occurred when evaluating the alert rule. | |
||||
| **No Data** | The alert rule query returns no data. | |
||||
| **{status}, KeepLast** | The rule would have received another status but was configured to keep the last state of the alert rule. | |
||||
@ -0,0 +1,37 @@ |
||||
--- |
||||
canonical: https://grafana.com/docs/grafana/latest/alerting/fundamentals/alert-rule-evaluation/evaluation-within-a-group/ |
||||
description: An alert instance is considered stale when its series disappears for a number of consecutive evaluation intervals. Learn how Grafana resolves them. |
||||
keywords: |
||||
- grafana |
||||
- alerting |
||||
- guide |
||||
- state |
||||
labels: |
||||
products: |
||||
- cloud |
||||
- enterprise |
||||
- oss |
||||
title: How rules are evaluated within a group |
||||
menuTitle: Evaluation within a group |
||||
weight: 150 |
||||
refs: |
||||
import-ds-rules: |
||||
- pattern: /docs/grafana/ |
||||
destination: /docs/grafana/<GRAFANA_VERSION>/alerting/alerting-rules/alerting-migration/ |
||||
- pattern: /docs/grafana-cloud/ |
||||
destination: /docs/grafana-cloud/alerting-and-irm/alerting/alerting-rules/alerting-migration/ |
||||
--- |
||||
|
||||
# How rules are evaluated within a group |
||||
|
||||
Each evaluation group contains an **evaluation interval** that determines how frequently the rule is evaluated. For instance, the evaluation may occur every `10s`, `30s`, `1m`, `10m`, etc. |
||||
|
||||
Rules in different evaluation groups can be evaluated simultaneously. |
||||
|
||||
Rules within the same evaluation group can be evaluated simultaneously or sequentially, depending on the rule type: |
||||
|
||||
- **Grafana-managed** rules within the same group are evaluated concurrently—they are evaluated at different times over the same evaluation interval but display the same evaluation timestamp. |
||||
|
||||
- **Data source-managed** rules within the same group are evaluated sequentially, one after the other—this is useful to ensure that recording rules are evaluated before alert rules. |
||||
|
||||
- **Grafana-managed rules [imported from data source-managed rules](ref:import-ds-rules)** are also evaluated sequentially. |
||||
@ -1,10 +0,0 @@ |
||||
--- |
||||
labels: |
||||
products: |
||||
- oss |
||||
title: 'Note Prometheus data source-managed rules' |
||||
--- |
||||
|
||||
> Rules from a Prometheus data source appear in the **Data source-managed** section of the **Alert rules** page when [Manage alerts via Alerting UI](ref:shared-configure-prometheus-data-source-alerting) is enabled. |
||||
> |
||||
> However, Grafana can only create and edit data source-managed rules for Mimir and Loki, not for a Prometheus instance. |
||||
Loading…
Reference in new issue