node_exporter/docs/node-mixin
beorn7 f331b308f3 Use promgrafonnet as a vendored library from its source
The only deviation that happened so far is to use format="percentunit"
in a Grafana gauge. This change wasn't even properly used in this repo
so far, so I opted to stick with "upstream" for now. If changes are
really needed, we can try to change upstream first.

Another change was done in parallal here and upstream, but it was
"more correct" in upstream. (Change datasource to $datasource
variable, only partially applied here.) Which is another point for
using the upstream and not copy it here.

Signed-off-by: beorn7 <beorn@grafana.com>
2019-07-06 21:11:23 +02:00
..
alerts Move node-mixin into docs directory 2019-07-05 19:38:03 +02:00
dashboards Use promgrafonnet as a vendored library from its source 2019-07-06 21:11:23 +02:00
rules Move node-mixin into docs directory 2019-07-05 19:38:03 +02:00
.gitignore Add Makefile to easily make output files and lint sources 2019-07-06 20:21:56 +02:00
alerts.jsonnet Create jsonnet files to create output files 2019-07-06 20:11:27 +02:00
config.libsonnet Move node-mixin into docs directory 2019-07-05 19:38:03 +02:00
dashboards.jsonnet Create jsonnet files to create output files 2019-07-06 20:11:27 +02:00
jsonnetfile.json Use promgrafonnet as a vendored library from its source 2019-07-06 21:11:23 +02:00
Makefile Add Makefile to easily make output files and lint sources 2019-07-06 20:21:56 +02:00
mixin.libsonnet Move node-mixin into docs directory 2019-07-05 19:38:03 +02:00
README.md Add README.md 2019-07-06 20:30:40 +02:00
rules.jsonnet Create jsonnet files to create output files 2019-07-06 20:11:27 +02:00

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.