github
/
prometheus
mirror of https://github.com/prometheus/prometheus
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Adds link to valid metric names (#6774) 

One of our users today asked us if dashes were allowed in recording rule names.
We asserted that they were not, but also that we could not remember for certain.
After determining empirically that they are _not_ allowed, I realized that the
documentation could be slightly clearer about valid rule names.

This PR simply adds a note to the documentation re-iterating that the rules must
be valid metric names - and more importantly, adds a link to where a user can
read what those *are*, in case they were not aware (or did not know where to find it).

Signed-off-by: Andrew Hayworth <ahayworth@gmail.com>
pull/6788/head
Andrew Hayworth 2020-02-07 01:32:15 -06:00 committed by GitHub
parent 1a18594176
commit a336908678
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/configuration/recording_rules.md
View File

@ -45,7 +45,8 @@ dashboards, which need to query the same expression repeatedly every time they
refresh.
Recording and alerting rules exist in a rule group. Rules within a group are
run sequentially at a regular interval.
run sequentially at a regular interval. The names of recording and alerting rules
must be [valid metric names](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels).
The syntax of a rule file is: