root
/
grafana
mirror of https://github.com/grafana/grafana.git
1
0
Fork 0
Code Issues Actions 266 Packages Projects Releases Wiki Activity

Alerting docs: changes alerting rules to alert rules (#82049) 

* Alerting docs: changes alerting rules to alert rules

* ran prettier
This commit is contained in:
brendamuir 2024-02-07 11:04:13 +01:00 committed by GitHub
parent 2679599968
commit 899e06b439
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/sources/alerting/fundamentals/alert-rules/_index.md
View File

@ -20,7 +20,7 @@ An alert rule is a set of evaluation criteria for when an alert rule should fire
While queries and expressions select the data set to evaluate, a condition sets the threshold that an alert must meet or exceed to create an alert. While queries and expressions select the data set to evaluate, a condition sets the threshold that an alert must meet or exceed to create an alert.
An interval specifies how frequently an alerting rule is evaluated. Duration, when configured, indicates how long a condition must be met. The alert rules can also define alerting behavior in the absence of data. An interval specifies how frequently an alert rule is evaluated. Duration, when configured, indicates how long a condition must be met. The alert rules can also define alerting behavior in the absence of data.
- [Alert rule types][alert-rule-types] - [Alert rule types][alert-rule-types]
- [Alert instances][alert-instances] - [Alert instances][alert-instances]

14
docs/sources/alerting/fundamentals/alert-rules/state-and-health.md
View File

@ -13,13 +13,13 @@ labels:
- cloud - cloud
- enterprise - enterprise
- oss - oss
title: State and health of alerting rules title: State and health of alert rules
weight: 405 weight: 405
--- ---
# State and health of alerting rules # State and health of alert rules
The state and health of alerting rules help you understand several key status indicators about your alerts. The state and health of alert rules help you understand several key status indicators about your alerts.
There are three key components: [alert rule state](#alert-rule-state), [alert instance state](#alert-instance-state), and [alert rule health](#alert-rule-health). Although related, each component conveys subtly different information. There are three key components: [alert rule state](#alert-rule-state), [alert instance state](#alert-instance-state), and [alert rule health](#alert-rule-health). Although related, each component conveys subtly different information.
@ -47,7 +47,7 @@ An alert instance can be in either of the following states:
| **Pending** | The state of an alert that has been active for less than the configured threshold duration. | | **Pending** | The state of an alert that has been active for less than the configured threshold duration. |
| **Alerting** | The state of an alert that has been active for longer than the configured threshold duration. | | **Alerting** | The state of an alert that has been active for longer than the configured threshold duration. |
| **NoData** | No data has been received for the configured time window. | | **NoData** | No data has been received for the configured time window. |
| **Error** | The error that occurred when attempting to evaluate an alerting rule. | | **Error** | The error that occurred when attempting to evaluate an alert rule. |
## Alert rule health ## Alert rule health
@ -55,13 +55,13 @@ An alert rule can have one the following health statuses:
| State | Description | | State | Description |
| ---------- | ---------------------------------------------------------------------------------- | | ---------- | ---------------------------------------------------------------------------------- |
| **Ok** | No error when evaluating an alerting rule. | | **Ok** | No error when evaluating an alert rule. |
| **Error** | An error occurred when evaluating an alerting rule. | | **Error** | An error occurred when evaluating an alert rule. |
| **NoData** | The absence of data in at least one time series returned during a rule evaluation. | | **NoData** | The absence of data in at least one time series returned during a rule evaluation. |
## Special alerts for `NoData` and `Error` ## Special alerts for `NoData` and `Error`
When evaluation of an alerting rule produces state `NoData` or `Error`, Grafana Alerting will generate alert instances that have the following additional labels: When evaluation of an alert rule produces state `NoData` or `Error`, Grafana Alerting will generate alert instances that have the following additional labels:
| Label | Description | | Label | Description |
| ------------------ | ---------------------------------------------------------------------- | | ------------------ | ---------------------------------------------------------------------- |