Updates to alerting rules docs (#3381)

1. Added a further explanation of the for clause.
2. Added further clarification of non identifying labels.
This commit is contained in:
James Turnbull 2017-10-31 15:19:17 -04:00 committed by Brian Brazil
parent 8cf279efb1
commit 3701a827cf

View file

@ -32,18 +32,13 @@ groups:
``` ```
The optional `for` clause causes Prometheus to wait for a certain duration The optional `for` clause causes Prometheus to wait for a certain duration
between first encountering a new expression output vector element (like an 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.
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.
The `labels` clause allows specifying a set of additional labels to be attached 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 to the alert. Any existing conflicting labels will be overwritten. The label
values can be templated. values can be templated.
The `annotations` clause specifies another set of labels that are not 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.
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.
#### Templating #### Templating