Docs alerting: copy edit terraform provisioning (#55978) (#57068)

pull/57067/head^2
brendamuir 3 years ago committed by GitHub
parent 0abf04a20f
commit ecc252429e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 23
      docs/sources/alerting/alerting-rules/_index.md
  2. 4
      docs/sources/alerting/alerting-rules/create-mimir-loki-managed-recording-rule.md
  3. 4
      docs/sources/alerting/alerting-rules/create-mimir-loki-managed-rule.md
  4. 19
      docs/sources/alerting/view-alert rules/_index.md
  5. 71
      docs/sources/alerting/view-state-health/_index.md

@ -4,21 +4,26 @@ aliases:
- /docs/grafana/latest/alerting/old-alerting/create-alerts/
- /docs/grafana/latest/alerting/rules/
- /docs/grafana/latest/alerting/unified-alerting/alerting-rules/
title: Create and manage rules
title: Create alert rules
weight: 130
---
# Create and manage Grafana Alerting rules
# Create alert rules
An alerting rule is a set of evaluation criteria that determines whether an alert will fire. The rule consists of one or more queries and expressions, a condition, the frequency of evaluation, and optionally, the duration over which the condition is met.
An alert rule is a set of evaluation criteria that determines whether an alert will fire. The alert rule consists of one or more queries and expressions, a condition, the frequency of evaluation, and optionally, the duration over which the condition is met.
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 rules can also define alerting behavior in the absence of data.
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 alert rule is evaluated. Duration, when configured, indicates how long a condition must be met. Alert rules can also define alerting behavior in the absence of data.
You can:
- [Create Grafana Mimir or Loki managed alert rule]({{< relref "create-mimir-loki-managed-rule/" >}})
- [Create Grafana Mimir or Loki managed recording rule]({{< relref "create-mimir-loki-managed-recording-rule/" >}})
- [Create Grafana Mimir or Loki managed alert rules]({{< relref "create-mimir-loki-managed-rule/" >}})
- [Create Grafana Mimir or Loki managed recording rules]({{< relref "create-mimir-loki-managed-recording-rule/" >}})
- [Edit Grafana Mimir or Loki rule groups and namespaces]({{< relref "edit-mimir-loki-namespace-group/" >}})
- [Create Grafana managed alert rule]({{< relref "create-grafana-managed-rule/" >}})
- [State and health of alerting rules]({{< relref "../fundamentals/state-and-health/" >}})
- [Manage alerting rules]({{< relref "rule-list/" >}})
- [Create Grafana managed alert rules]({{< relref "create-grafana-managed-rule/" >}})
- [View the state and health of alert rules]({{< relref "../fundamentals/state-and-health/" >}})
- [View and filter alert rules]({{< relref "rule-list/" >}})
**Note:**
Grafana managed alert rules can only be edited or deleted by users with Edit permissions for the folder storing the rules.
Alert rules for an external Grafana Mimir or Loki instance can be edited or deleted by users with Editor or Admin roles.

@ -11,11 +11,11 @@ keywords:
- rules
- recording rules
- create
title: Create Grafana Mimir or Loki managed recording rule
title: Create Grafana Mimir or Loki managed recording rules
weight: 400
---
# Create a Grafana Mimir or Loki managed recording rule
# Create Grafana Mimir or Loki managed recording rules
You can create and manage recording rules for an external Grafana Mimir or Loki instance. Recording rules calculate frequently needed expressions or computationally expensive expressions in advance and save the result as a new set of time series. Querying this new time series is faster, especially for dashboards since they query the same expression every time the dashboards refresh.

@ -11,11 +11,11 @@ keywords:
- guide
- rules
- create
title: Create Grafana Mimir or Loki managed alert rule
title: Create Grafana Mimir or Loki managed alert rules
weight: 400
---
# Create a Grafana Mimir or Loki managed alerting rule
# Create a Grafana Mimir or Loki managed alerting rules
Grafana allows you to create alerting rules for an external Grafana Mimir or Loki instance that has ruler API enabled. For information on Grafana Alerting, see [About Grafana Alerting]({{< relref "../" >}}) which explains the various components of Grafana Alerting. We also recommend that you familiarize yourself with some of the [fundamental concepts]({{< relref "../fundamentals/" >}}) of Grafana Alerting.

@ -2,6 +2,7 @@
aliases:
- /docs/grafana/latest/alerting/alerting-rules/rule-list/
- /docs/grafana/latest/alerting/unified-alerting/alerting-rules/rule-list/
- /docs/grafana/latest/alerting/view-alert-rules/
description: Manage alerting rules
keywords:
- grafana
@ -9,22 +10,21 @@ keywords:
- guide
- rules
- view
title: Manage alert rules
weight: 402
title: View and filter alert rules
weight: 140
---
# Manage alert rules
# View and filter alert rules
The Alerting page lists all existing alert rules. By default, rules are grouped by types of data sources. The Grafana section lists all Grafana managed rules. Alert rules for Prometheus compatible data sources are also listed here. You can view alert rules for Prometheus compatible data sources but you cannot edit them.
The Mimir/Cortex/Loki rules section lists all rules for Mimir, Cortex, or Loki data sources. Cloud alert rules are also listed in this section.
- [Manage alert rules](#manage-alert-rules)
- [View and filter alert rules](#view-and-filter-alert-rules)
- [View alert rules](#view-alert-rules)
- [Grouped view](#grouped-view)
- [State view](#state-view)
- [Filter alert rules](#filter-alert-rules)
- [Edit or delete an alert rule](#edit-or-delete-an-alert-rule)
## View alert rules
@ -55,12 +55,3 @@ To filter alert rules:
- From **Select data sources**, select a data source. You can see alert rules that query the selected data source.
- In the **Search by label**, enter search criteria using label selectors. For example, `environment=production,region=~US|EU,severity!=warning`.
- From **Filter alerts by state**, select an alerting state you want to see. You can see alerting rules that match the state. Rules matching other states are hidden.
## Edit or delete an alert rule
Grafana managed alert rules can only be edited or deleted by users with Edit permissions for the folder storing the rules. Alert rules for an external Grafana Mimir or Loki instance can be edited or deleted by users with Editor or Admin roles.
To edit or delete a rule:
1. Expand a rule row until you can see the rule controls of **View**, **Edit**, and **Delete**.
1. Click **Edit** to open the create rule page. Make updates following instructions in [Create a Grafana managed alerting rule]({{< relref "create-grafana-managed-rule/" >}}) or [Create a Grafana Mimir or Loki managed alerting rule]({{< relref "create-mimir-loki-managed-rule/" >}}).
1. Click **Delete** to delete an alert rule.

@ -0,0 +1,71 @@
---
aliases:
- /docs/grafana/latest/alerting/fundamentals/state-and-health/
- /docs/grafana/latest/alerting/unified-alerting/alerting-rules/state-and-health/
- /docs/grafana/latest/alerting/view-state-health/
description: State and Health of alerting rules
keywords:
- grafana
- alert rules
- guide
- state
- health
title: View the state and health of alert rules
weight: 150
---
# View the state and health of alert rules
The state and health of alert rules helps 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.
To view the state and health of your alert rules:
1. Navigate to Alerting > Alert rules.
2. Click an alert rule to view its state, health and state history.
## Alert rule state
An alert rule can be in either of the following states:
| State | Description |
| ----------- | ---------------------------------------------------------------------------------------------- |
| **Normal** | None of the time series returned by the evaluation engine is in a `Pending` or `Firing` state. |
| **Pending** | At least one time series returned by the evaluation engine is `Pending`. |
| **Firing** | At least one time series returned by the evaluation engine is `Firing`. |
> **Note:** Alerts will transition first to `pending` and then `firing`, thus it will take at least two evaluation cycles before an alert is fired.
## Alert instance state
An alert instance can be in either of the following states:
| State | Description |
| ------------ | --------------------------------------------------------------------------------------------- |
| **Normal** | The state of an alert that is neither firing nor pending, everything is working correctly. |
| **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. |
| **NoData** | No data has been received for the configured time window. |
| **Error** | The error that occurred when attempting to evaluate an alerting rule. |
## Alert rule health
An alert rule can have one the following health statuses:
| State | Description |
| ---------- | ---------------------------------------------------------------------------------- |
| **Ok** | No error when evaluating an alerting rule. |
| **Error** | An error occurred when evaluating an alerting rule. |
| **NoData** | The absence of data in at least one time series returned during a rule evaluation. |
## 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:
| Label | Description |
| ------------------ | ---------------------------------------------------------------------- |
| **alertname** | Either `DatasourceNoData` or `DatasourceError` depending on the state. |
| **datasource_uid** | The UID of the data source that caused the state. |
You can handle these alerts the same way as regular alerts by adding a silence, route to a contact point, and so on.
Loading…
Cancel
Save