prometheus/documentation/prometheus-mixin
Julien Pivotto 7a07a279c9
Merge pull request #10721 from ncauchois/fix_prometheus_remote_write_dashboard
mixin: Use url filter on Remote Write dashboard
2023-11-03 15:49:42 -04:00
..
.gitignore
Makefile Use Go 1.16+ install for mixin tests 2021-10-23 22:52:16 +02:00
README.md docs: Replace `go get` with `go install` for command installation (#9098) 2021-08-27 11:08:21 +02:00
alerts.jsonnet
alerts.libsonnet add alert for sd refresh failure (#12410) 2023-06-07 14:28:13 +02:00
config.libsonnet documentation/prometheus-mixin: fix comment typo 2022-09-09 17:03:53 +02:00
dashboards.jsonnet
dashboards.libsonnet Merge pull request #10721 from ncauchois/fix_prometheus_remote_write_dashboard 2023-11-03 15:49:42 -04:00
jsonnetfile.json
mixin.libsonnet

README.md

Prometheus Mixin

This is work in progress. We aim for it to become a good role model for alerts and dashboards eventually, but it is not quite there yet.

The Prometheus Mixin is a set of configurable, reusable, and extensible alerts and dashboards for Prometheus.

To use them, you need to have jsonnet (v0.13+) and jb installed. If you have a working Go development environment, it's easiest to run the following:

$ go install github.com/google/go-jsonnet/cmd/jsonnet@latest
$ go install github.com/google/go-jsonnet/cmd/jsonnetfmt@latest
$ go install github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb@latest

Note: The make targets lint and fmt need the jsonnetfmt binary, which is available from v.0.16.0 in the Go implementation of jsonnet. If your jsonnet version is older than 0.16.0 you have to either upgrade or install the C++ version of jsonnetfmt if you want to use make lint or make fmt.

Next, install the dependencies by running the following command in this directory:

$ jb install

You can then build a prometheus_alerts.yaml with the alerts and a directory dashboards_out with the Grafana dashboard JSON files:

$ make prometheus_alerts.yaml
$ make dashboards_out

For more advanced uses of mixins, see https://github.com/monitoring-mixins/docs.