prometheus/documentation/prometheus-mixin
paulfantom 7321f1d227
documentation/prometheus-mixin: add dependency on grafonnet
Signed-off-by: paulfantom <pawel@krupa.net.pl>
2020-01-11 23:18:04 +01:00
..
.gitignore Add .gitignore file 2019-06-26 15:22:23 +02:00
Makefile Adjust to jsonnet v0.13 2019-06-26 16:22:21 +02:00
README.md Add a "work in progress" disclaimer. 2019-06-26 23:24:22 +02:00
alerts.jsonnet Add Makefile and suitable jsonnet files 2019-06-26 15:30:55 +02:00
alerts.libsonnet Fix the description template for PrometheusRemoteWriteDesiredShards 2019-10-30 13:27:37 +01:00
config.libsonnet Remove/improve unused variables and weird doc comments 2019-06-28 15:41:31 +02:00
dashboards.jsonnet Fix prometheus-mixin dashboards to use grafanaDashboards 2019-07-11 15:40:26 +02:00
dashboards.libsonnet Simplify remote write dashboard in mixin. 2019-11-18 19:58:07 -08:00
jsonnetfile.json documentation/prometheus-mixin: add dependency on grafonnet 2020-01-11 23:18:04 +01:00
mixin.libsonnet Basic Prometheus dashboard. 2018-11-16 17:17:47 +00:00

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 get github.com/google/go-jsonnet/cmd/jsonnet
$ go get github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb

Note: The make targets lint and fmt need the jsonnetfmt binary, which is currently not included in the Go implementation of jsonnet. For the time being, you have to 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.