Skip to content

Commit 64da3ae

Browse files
authored
Alerting docs: update annotations description (#1885)
1 parent 2c02167 commit 64da3ae

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/resources/rule_group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Required:
138138

139139
Optional:
140140

141-
- `annotations` (Map of String) Key-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing. Defaults to `map[]`.
141+
- `annotations` (Map of String) Key-value pairs of metadata to attach to the alert rule. They add additional information, such as a `summary` or `runbook_url`, to help identify and investigate alerts. The `dashboardUId` and `panelId` annotations, which link alerts to a panel, must be set together. Defaults to `map[]`.
142142
- `exec_err_state` (String) Describes what state to enter when the rule's query is invalid and the rule cannot be executed. Options are OK, Error, KeepLast, and Alerting. Defaults to `Alerting`.
143143
- `for` (String) The amount of time for which the rule must be breached for the rule to be considered to be Firing. Before this time has elapsed, the rule is only considered to be Pending. Defaults to `0`.
144144
- `is_paused` (Boolean) Sets whether the alert should be paused or not. Defaults to `false`.

internal/resources/grafana/resource_alerting_rule_group.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ This resource requires Grafana 9.1.0 or later.
187187
Type: schema.TypeMap,
188188
Optional: true,
189189
Default: map[string]interface{}{},
190-
Description: "Key-value pairs of metadata to attach to the alert rule that may add user-defined context, but cannot be used for matching, grouping, or routing.",
190+
Description: "Key-value pairs of metadata to attach to the alert rule. They add additional information, such as a `summary` or `runbook_url`, to help identify and investigate alerts. The `dashboardUId` and `panelId` annotations, which link alerts to a panel, must be set together.",
191191
Elem: &schema.Schema{
192192
Type: schema.TypeString,
193193
},

0 commit comments

Comments
 (0)