You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
prometheus/documentation/prometheus-mixin
SuperQ 3cd2c033e2
Use Go 1.16+ install for mixin tests
3 years ago
..
.gitignore Add .gitignore file 6 years ago
Makefile Use Go 1.16+ install for mixin tests 3 years ago
README.md docs: Replace `go get` with `go install` for command installation (#9098) 3 years ago
alerts.jsonnet Add Makefile and suitable jsonnet files 6 years ago
alerts.libsonnet Add `prometheus_tsdb_clean_start` metric (#8824) 4 years ago
config.libsonnet mixin: Scope grafana config 4 years ago
dashboards.jsonnet Fix prometheus-mixin dashboards to use grafanaDashboards 5 years ago
dashboards.libsonnet mixin: Filter instance by job for Prometheus overview dashboard 3 years ago
jsonnetfile.json Use absolute jsonnet import paths 4 years ago
mixin.libsonnet Basic Prometheus dashboard. 6 years ago

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.