Alerting docs: update Configure alert rules (#97430)

* Simplify a bit more Intro to Alert rules * Update `Configure alert rules` docs * Configure Grafana-managed alert rules * Update `Configure data source-managed alert rules` * fix mispelled word * fix grammar error * remove unnecessary space * remove whitespace * address brand name convention
2024-12-09 09:43:19 +01:00
parent 3dc2bdfb20
commit 7f99388576
12 changed files with 392 additions and 317 deletions
@@ -386,7 +386,7 @@ To reset the notification policy tree to the default and unlock it for editing i

 ## Data source-managed resources

-The Alerting Provisioning HTTP API can only be used to manage Grafana-managed alert resources. To manage resources related to [data source-managed alerts](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/alerting/alerting-rules/create-mimir-loki-managed-rule/), consider the following tools:
+The Alerting Provisioning HTTP API can only be used to manage Grafana-managed alert resources. To manage resources related to [data source-managed alerts](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/alerting/alerting-rules/create-data-source-managed-rule/), consider the following tools:

 - [mimirtool](https://grafana.com/docs/mimir/<GRAFANA_VERSION>/manage/tools/mimirtool/): to interact with the Mimir alertmanager and ruler configuration.
 - [cortex-tools](https://github.com/grafana/cortex-tools#cortextool): to interact with the Cortex alertmanager and ruler configuration.
@@ -0,0 +1,13 @@
+---
+labels:
+  products:
+    - oss
+title: 'Set alert rule name'
+---
+
+## Set alert rule name
+
+1. Click **Alerts & IRM** -> **Alert rules** -> **+ New alert rule**.
+1. Enter a name to identify your alert rule.
+
+   This name is displayed in the alert rule list. It is also the `alertname` label for every alert instance that is created from this rule.
@@ -0,0 +1,36 @@
+---
+labels:
+  products:
+    - oss
+title: 'Configure notification message'
+---
+
+## Configure notification message
+
+Use [annotations](ref:shared-annotations) to add information to alert messages that can help respond to the alert.
+
+Annotations are included by default in notification messages, and can use text or [templates](ref:shared-alert-rule-template) to display dynamic data from queries.
+
+Grafana provides several optional annotations.
+
+1. Optional: Add a summary.
+
+   Short summary of what happened and why.
+
+1. Optional: Add a description.
+
+   Description of what the alert rule does.
+
+1. Optional: Add a Runbook URL.
+
+   Webpage where you keep your runbook for the alert
+
+1. Optional: Add a custom annotation.
+
+   Add any additional information that could help address the alert.
+
+1. Optional: **Link dashboard and panel**.
+
+   [Link the alert rule to a panel](ref:shared-link-alert-rules-to-panels) to facilitate alert investigation.
+
+1. Click **Save rule**.
@@ -0,0 +1,12 @@
+---
+labels:
+  products:
+    - oss
+title: 'Provisioning'
+---
+
+### Provisioning
+
+Note that if you delete an alert resource created in the UI, you can no longer retrieve it.
+
+To backup and manage alert rules, you can [provision alerting resources](ref:shared-provision-alerting-resources) using options such as configuration files, Terraform, or the Alerting API.
@@ -0,0 +1,14 @@
+---
+labels:
+  products:
+    - oss
+title: 'Table configure no data and error'
+---
+
+| Configure    | Set alert state | Description                                                                                                                                                                                                                                                          |
+| ------------ | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| NoData       | No Data         | The default option for **No Data** events.<br/>Sets alert instance state to `No data`. <br/> The alert rule also creates a new alert instance `DatasourceNoData` with the name and UID of the alert rule, and UID of the datasource that returned no data as labels. |
+| Error        | Error           | The default option for **Error** events.<br/>Sets alert instance state to `Error`. <br/> The alert rule also creates a new alert instance `DatasourceError` with the name and UID of the alert rule, and UID of the datasource that returned no data as labels.      |
+| NoData/Error | Alerting        | Sets the alert instance state to `Pending` and then transitions to `Alerting` once the pending period ends. If you sent the pending period to 0, the alert instance state is immediately set to `Alerting`.                                                          |
+| NoData/Error | Normal          | Sets alert instance state to `Normal`.                                                                                                                                                                                                                               |
+| NoData/Error | Keep Last State | Maintains the alert instance in its last state. Useful for mitigating temporary issues.                                                                                                                                                                              |