Docs: updates to alert rule docs (#72313)

* Docs: updates to alert rule docs

* removes steps

* edits to numbering

* description parameter edit

* fixing description frontmatter
This commit is contained in:
brendamuir 2023-07-26 09:18:13 +02:00 committed by GitHub
parent 88988e4337
commit bf5fa18137
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 19 additions and 91 deletions

View File

@ -17,7 +17,7 @@ labels:
- enterprise
- oss
title: Configure Grafana-managed alert rules
weight: 400
weight: 100
---
# Configure Grafana-managed alert rules
@ -36,12 +36,6 @@ In the following sections, well guide you through the process of creating you
To create a Grafana-managed alert rule, use the in-product alert creation flow and follow these steps to help you.
1. Enter an alert rule name
1. Define query and alert condition
1. Set evaluation behavior
1. Add annotations
1. Configure notifications
## Set alert rule name
1. Click **Alerts & IRM** -> **Alert rules** -> **+ New alert rule**.
@ -140,15 +134,15 @@ All alert rules and instances, irrespective of their labels, match the default n
Add custom labels by selecting existing key-value pairs from the drop down, or add new labels by entering the new key or value.
2. Preview your alert instance routing set up.
1. Preview your alert instance routing set up.
Based on the labels added, alert instances are routed to the following notification policies displayed.
Expand each notification policy below to view more details.
3. Click **See details** to view alert routing details and an email preview.
1. Click **See details** to view alert routing details and an email preview.
4. Click **Save rule**.
1. Click **Save rule**.
### Single and multi-dimensional rule

View File

@ -17,7 +17,7 @@ labels:
- enterprise
- oss
title: Configure recording rules
weight: 400
weight: 300
---
# Configure recording rules
@ -46,8 +46,8 @@ This setting has precedence over each individual rule frequency. If a rule frequ
To create recording rules, follow these steps.
1. Click **Alerts & IRM** and then **Alerting**.
1. Click **Alert rules**.
1. Click **Alerts & IRM** -> **Alerting** ->
**Alert rules**.
1. Click the **More** dropdown and then **New recording rule**.
1. Set rule name.

View File

@ -17,7 +17,7 @@ labels:
- enterprise
- oss
title: Configure data source-managed alert rules
weight: 400
weight: 200
---
# Configure data source-managed alert rules
@ -48,12 +48,6 @@ In the following sections, well guide you through the process of creating you
To create a data source-managed alert rule, use the in-product alert creation flow and follow these steps to help you.
1. Enter an alert rule name
2. Define query and alert condition
3. Set evaluation behavior
4. Add annotations
5. Configure notifications
## Set alert rule name
1. Click **Alerts & IRM** -> **Alert rules** -> **+ New alert rule**.

View File

@ -1,63 +0,0 @@
---
aliases:
- ../unified-alerting/alerting-rules/edit-cortex-loki-namespace-group/
- ../unified-alerting/alerting-rules/edit-mimir-loki-namespace-group/
canonical: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/edit-mimir-loki-namespace-group/
description: Edit Grafana Mimir or Loki rule groups and namespaces
keywords:
- grafana
- alerting
- guide
- group
- namespace
- grafana mimir
- loki
labels:
products:
- cloud
- enterprise
- oss
title: Grafana Mimir or Loki rule groups and namespaces
weight: 405
---
# Grafana Mimir or Loki rule groups and namespaces
A namespace contains one or more groups. The rules within a group are run sequentially at a regular interval. The default interval is one (1) minute. You can rename Grafana Mimir or Loki rule namespaces and groups, and edit group evaluation intervals.
{{< figure src="/static/img/docs/alerting/unified/rule-list-edit-mimir-loki-icon-8-2.png" caption="Rule group list" alt="Group list" >}}
<!-- image is the same as above
{{< figure src="/static/img/docs/alerting/unified/rule-list-edit-mimir-loki-icon-8-2.png" max-width="550px" caption="Alert details" >}}
-->
## Rename a namespace
To rename a namespace:
1. In the left-side menu, click **Alerts & IRM** and then **Alerting**.
1. Click **Alert rules** to view the list of existing alerts.
1. Find a Grafana Mimir or Loki managed rule with the group that belongs to the namespace you want to edit.
1. Click the **Edit** (pen) icon.
1. Enter a new name in the **Namespace** field, then click **Save changes**.
A new namespace is created and all groups are copied into this namespace from the old one. The old namespace is deleted.
## Rename rule group or change the rule group evaluation interval
The rules within a group are run sequentially at a regular interval, the default interval is one (1) minute. You can modify this interval using the following instructions.
1. In the left-side menu, click the **Alerts & IRM** and then **Alerting**.
1. Click **Alert rules** to view the list of existing alerts.
1. Find a Grafana Mimir or Loki managed rule with the group you want to edit.
1. Click **Edit** (pen) icon.
1. Modify the **Rule group** and **Rule group evaluation interval** information as necessary.
1. Click **Save changes**.
When you rename the group, a new group with all the rules from the old group is created. The old group is deleted.
![Group edit modal](/static/img/docs/alerting/unified/rule-list-mimir-loki-edit-ns-group-8-2.png 'Rule group edit modal screenshot')
<!-- new image that displays current 9.4 state of modal below
{{< figure src="/media/docs/grafana/alerting/screenshot-rule-list-mimir-loki-edit-ns-group-9-4.png" max-width="550px" caption="Rule group edit modal" alt="Group edit modal" >}}
-->

View File

@ -1,6 +1,9 @@
---
aliases:
- ../unified-alerting/alerting-rules/edit-cortex-loki-namespace-group/
- ../unified-alerting/alerting-rules/edit-mimir-loki-namespace-group/
canonical: https://grafana.com/docs/grafana/latest/alerting/fundamentals/alert-rules/organising-alerts/
description: Learn how to organize alert rules
description: Namespaces, folders, and groups
keywords:
- grafana
- alerting
@ -10,22 +13,22 @@ labels:
- cloud
- enterprise
- oss
title: Organising alert rules
title: Namespaces, folders, and groups
weight: 105
---
## Namespaces and groups
## Namespaces, folders, and groups
Alerts can be organized using Folders for Grafana-managed rules and namespaces for Mimir or Loki rules and group names.
Alerts can be organized using folders for Grafana-managed rules and namespaces for Mimir or Loki rules and group names.
### Namespaces
### Namespaces and folders
When creating Grafana-managed rules, the folder can be used to perform access control and grant or deny access to all rules within a specific folder.
A namespace contains one or more groups. The rules within a group are run sequentially at a regular interval. The default interval is one (1) minute. You can rename Grafana Mimir or Loki rule namespaces and groups, and edit group evaluation intervals.
### Groups
All rules within a group are evaluated at the same **interval**.
Alert rules and recording rules within a group will always be evaluated **sequentially**, meaning no rules will be evaluated at the same time and in order of appearance.
The rules within a group are run sequentially at a regular interval, meaning no rules will be evaluated at the same time and in order of appearance.. The default interval is one (1) minute. You can rename Grafana Mimir or Loki rule namespaces and groups, and edit group evaluation intervals.
> **Note** If you want rules to be evaluated concurrently and with different intervals, consider storing them in different groups.