opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-31 09:32:40 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/alerting/fundamentals/annotation-label/_index.md
JitaC 6397b34f8b Docs: Move labels and annotations topic to alerting fundamentals section (#49283) 
* Moved annotation and labels topic to fundamentals and added label matching to the same section

* Cosmetic updates to "How label matching works topic"

* Few more changes to annotations and label section. Also added stem sentence to silences topics.

* Fixed one more broken relref.

* Update docs/sources/alerting/fundamentals/_index.md

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
2022-05-19 19:17:57 -04:00

1.8 KiB
Raw Blame History

+++ aliases = ["/docs/grafana/latest/alerting/alerting-rules/alert-annotation-label/", "/docs/grafana/latest/alerting/unified-alerting/alerting-rules/alert-annotation-label/"] description = "Annotations and labels for alerting" keywords = ["grafana", "alerting", "guide", "rules", "create"] title = "Annotations and labels for alerting rules" weight = 401 +++

Annotations and labels for alerting rules

Annotations and labels are key value pairs associated with alerts originating from the alerting rule, datasource response, and as a result of alerting rule evaluation. They can be used in alert notifications directly or in [templates]({{< relref "../../contact-points/message-templating/_index.md" >}}) and [template functions]({{< relref "../../contact-points/message-templating/template-functions" >}}) to create notification contact dynamically.

Annotations

Annotations are key-value pairs that provide additional meta-information about an alert. You can use the following annotations: description, summary, runbook_url, alertId, dashboardUid, and panelId. For example, a description, a summary, and a runbook URL. These are displayed in rule and alert details in the UI and can be used in contact point message templates.

Labels

Labels are key-value pairs that contain information about, and are used to uniquely identify an alert. The label set for an alert is generated and added to throughout the alerting evaluation and notification process.

Before you begin using annotations and labels, familiarize yourself with:

  • [Labels in Grafana alerting]({{< relref "./how-to-use-labels.md" >}})
  • [How label matching works]({{< relref "./how-to-use-labels.md" >}})
  • [Template variables for alerting rule labels and annotations]({{< relref "./variables-label-annotation.md" >}})