Skip to content

Commit

Permalink
Merge pull request prometheus#8491 from prometheus/beorn7/doc
Browse files Browse the repository at this point in the history
Recommend to get promtool from a binary distribution.
  • Loading branch information
roidelapluie authored Feb 15, 2021
2 parents adcc5b5 + ae900a1 commit eae197c
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/configuration/recording_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit eae197c

Please sign in to comment.