mudhorn/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2025-03-05 20:59:13 -08:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Make README.md immediately useful

Browse source 
Signed-off-by: beorn7 <beorn@grafana.com>
This commit is contained in:
beorn7 2019-06-26 15:36:49 +02:00
parent ddfabda152
commit 5c04ef3935
1 changed files with 23 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
documentation/prometheus-mixin/README.md
View file

@ -3,11 +3,29 @@
The Prometheus Mixin is a set of configurable, reusable, and extensible alerts The Prometheus Mixin is a set of configurable, reusable, and extensible alerts
and dashboards for Prometheus. 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+ Next, install the dependencies by running the following command in this
TODO: add MAkefile, explain things. 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