From 3701a827cf5da595bd2366dad6e1b3c979a1009c Mon Sep 17 00:00:00 2001 From: James Turnbull Date: Tue, 31 Oct 2017 15:19:17 -0400 Subject: [PATCH] Updates to alerting rules docs (#3381) 1. Added a further explanation of the for clause. 2. Added further clarification of non identifying labels. --- docs/configuration/alerting_rules.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/docs/configuration/alerting_rules.md b/docs/configuration/alerting_rules.md index eab53baf6..fd7783e34 100644 --- a/docs/configuration/alerting_rules.md +++ b/docs/configuration/alerting_rules.md @@ -32,18 +32,13 @@ groups: ``` The optional `for` clause causes Prometheus to wait for a certain duration -between first encountering a new expression output vector element (like an -instance with a high HTTP error rate) and counting an alert as firing for this -element. Elements that are active, but not firing yet, are in pending state. +between first encountering a new expression output vector element and counting an alert as firing for this element. In this case, Prometheus will check that the alert continues to be active during each evaluation for 10 minutes before firing the alert. Elements that are active, but not firing yet, are in the pending state. The `labels` clause allows specifying a set of additional labels to be attached to the alert. Any existing conflicting labels will be overwritten. The label values can be templated. -The `annotations` clause specifies another set of labels that are not -identifying for an alert instance. They are used to store longer additional -information such as alert descriptions or runbook links. The annotation values -can be templated. +The `annotations` clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated. #### Templating