node_exporter/docs/node-mixin
Björn Rabenstein 0f38d680b4
Merge pull request #1449 from prometheus/beorn7/mixin3
node-mixin: Make the severity of "critical" alerts configurable
2019-08-19 13:55:52 +02:00
..
alerts Make the severity of "critical" alerts configurable 2019-08-14 22:24:24 +02:00
dashboards Add line for number of cores to load graph 2019-08-15 16:43:57 +02:00
rules Added `_excluding_lo` to name of network rules that exclude lo 2019-07-22 20:21:52 +02:00
.gitignore Add Makefile to easily make output files and lint sources 2019-07-06 20:21:56 +02:00
Makefile Add Makefile to easily make output files and lint sources 2019-07-06 20:21:56 +02:00
README.md Add README.md 2019-07-06 20:30:40 +02:00
alerts.jsonnet
config.libsonnet Make the severity of "critical" alerts configurable 2019-08-14 22:24:24 +02:00
dashboards.jsonnet
jsonnetfile.json Use promgrafonnet as a vendored library from its source 2019-07-06 21:11:23 +02:00
mixin.libsonnet
rules.jsonnet

README.md

Node 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 Node Mixin is a set of configurable, reusable, and extensible alerts and dashboards based on the metrics exported by the Node Exporter. The mixin create recording and alerting rules for Prometheus and suitable dashboard descriptions for Grafana.

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 the Prometheus rules files node_alerts.yaml and node_rules.yaml:

$ make node_alerts.yaml node_rules.yaml

You can also build a directory dashboard_out with the JSON dashboard files for Grafana:

$ make dashboards_out

For more advanced uses of mixins, see https://github.com/monitoring-mixins/docs.