Browse Source

Merge pull request #8493 from prometheus/beorn7/doc

Recommend to get promtool from a binary distribution.
pull/8496/head
Julien Pivotto 4 years ago committed by GitHub
parent
commit
6393b48929
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 8
      docs/configuration/recording_rules.md

8
docs/configuration/recording_rules.md

@ -20,14 +20,16 @@ process. The changes are only applied if all rule files are well-formatted.
## Syntax-checking rules
To quickly check whether a rule file is syntactically correct without starting
a Prometheus server, install and run Prometheus's `promtool` command-line
utility tool:
a Prometheus server, you can use Prometheus's `promtool` command-line utility
tool:
```bash
go get github.com/prometheus/prometheus/cmd/promtool
promtool check rules /path/to/example.rules.yml
```
The `promtool` binary is part of the `prometheus` archive offered on the
project's [download page](https://prometheus.io/download/).
When the file is syntactically valid, the checker prints a textual
representation of the parsed rules to standard output and then exits with
a `0` return status.

Loading…
Cancel
Save