prometheus/documentation/prometheus-mixin
Julien Pivotto d5676fb9e0
Merge pull request #9254 from prometheus/superq/go1.17
Build with Go 1.17 / npm 7 / node 16
2021-08-28 18:36:42 +02: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 docs: Replace `go get` with `go install` for command installation (#9098) 2021-08-27 11:08:21 +02:00
alerts.jsonnet Add Makefile and suitable jsonnet files 2019-06-26 15:30:55 +02:00
alerts.libsonnet Add `prometheus_tsdb_clean_start` metric (#8824) 2021-06-16 15:03:02 +05:30
config.libsonnet mixin: Scope grafana config 2020-12-30 17:50:34 +01:00
dashboards.jsonnet Fix prometheus-mixin dashboards to use grafanaDashboards 2019-07-11 15:40:26 +02:00
dashboards.libsonnet mixin: Filter instance by job for Prometheus overview dashboard 2021-07-28 14:34:26 +01:00
go.mod .circleci/config.yml: check mixins (#6895) 2020-08-25 15:59:41 +02:00
go.sum .circleci/config.yml: check mixins (#6895) 2020-08-25 15:59:41 +02:00
jsonnetfile.json Use absolute jsonnet import paths 2020-10-20 11:42:30 +02:00
mixin.libsonnet Basic Prometheus dashboard. 2018-11-16 17:17:47 +00:00
tools.go Add new Go build tags. 2021-08-27 10:24:14 +02: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 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.