pint

README

pint

pint is a Prometheus rule linter.

Usage

There are three modes it works in:

• CI PR linting
• Ad-hoc linting of a selected files or directories
• A daemon that continuously checks selected files or directories and expose metrics describing all discovered problems.

Pull Requests

Run it with pint ci.

It currently supports git for which it will find all commits on the current branch that are not present in parent branch and scan all modified files included in those changes.

Results can optionally be reported using BitBucket API or GitHub API to generate a report with any found issues. If you are using BitBucket API then each issue will create an inline annotation in BitBucket with a description of the issue. If you are using GitHub API then each issue with appear as a comment on your pull request.

Exit code will be one (1) if any issues were detected with severity Bug or higher. This permits running pint in your CI system whilst at the same you will get detailed reports on your source control system.

Ad-hoc

Lint specified files and report any found issue.

You can lint selected files:

pint lint rules.yml

or directories:

pint lint path/to/dir

or both:

pint lint path/to/dir file.yml path/file.yml path/dir

Daemon

Run the daemon:

pint watch rules.yml

By default it will start a HTTP server on port 8080 and run all checks every 10 minutes. This can be customized by passing extra flags to the watch command. Run pint watch -h to see all available flags.

Query /metrics to see all expose metrics, example with default flags:

curl -s http://localhost:8080/metrics

Or setup Prometheus scrape job:

scrape_configs:
  - job_name: pint
    static_configs:
      - targets: ['localhost:8080']

Available metrics:

• pint_problem - exported for every problem detected by pint. To avoid exposing too many metrics at once pass --max-problems flag to watch command. When set pint will expose only up to --max-problems value number of pint_problem metrics.
• pint_problems - this metric is the total number of all problems detected by pint, including those not exported due to --max-problems flag.

Release Notes

See CHANGELOG.md for history of changes.

Quick start

Requirements:

• Git
• Go - current stable release

1. Build the binary:

   git clone https://github.com/cloudflare/pint.git
   cd pint
   make build
   

2. Run a simple syntax check on Prometheus alerting or recording rules file(s).

   ./pint lint /etc/prometheus/*.rules.yml
   

3. Configuration file is optional, but without it pint will only run very basic syntax checks. See CONFIGURATION.md for details on config syntax. Check examples dir for sample config files. By default pint will try to load configuration from .pint.hcl, you can specify a different path using --config flag:

   ./pint --config /etc/pint.hcl lint /etc/prometheus/rules/*.yml