diff --git a/documentation/prometheus-mixin/README.md b/documentation/prometheus-mixin/README.md index 01a7aadeb9..1cb009f683 100644 --- a/documentation/prometheus-mixin/README.md +++ b/documentation/prometheus-mixin/README.md @@ -3,11 +3,29 @@ The Prometheus Mixin is a set of configurable, reusable, and extensible alerts and dashboards for Prometheus. -For instructions on how to use mixins, see https://github.com/monitoring-mixins/docs. +To use them, you need to have `jsonnet` (v0.10+) and `jb` installed. If you +have a working Go development environment, it's easiest to run the following: +```bash +$ 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` currently don't work with the Go +implementation of `jsonnet`. For the time being, you have to install the [C++ +version of jsonnet](https://github.com/google/jsonnet) if you want to use them._ -TODO: need jsonnet v0.10+ -TODO: add MAkefile, explain things. +Next, install the dependencies by running the following command in this +directory: +```bash +$ jb install +``` + +You can then build a `prometheus_alerts.yaml` with the alerts and a directory +`dashboards_out` with the Grafana dashboard JSON files: +```bash +$ make prometheus_alerts.yaml +$ make dashboards_out +``` + +For more advanced uses of mixins, see https://github.com/monitoring-mixins/docs. -go get github.com/google/go-jsonnet/cmd/jsonnet -go get github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb