node_exporter/docs/node-mixin
Frederic Hemberger 5bee84f30d docs: Replace go get with go install for command installation
`go get` is deprecated for installation of commands as of go v1.17
Ref: https://go.googlesource.com/go/+/ced0fdbad0655d63d535390b1a7126fd1fef8348

Signed-off-by: Frederic Hemberger <mail@frederic-hemberger.de>
2021-07-20 12:16:46 +02:00
..
alerts feat(rules): add NodeFileDescriptorLimit kernel exhaustion alert 2021-04-30 12:40:09 +02:00
dashboards fix interval in graphs panels of node dashboard 2021-04-26 11:14:30 +02:00
rules Make interval configurable 2021-04-07 09:37:04 +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 Make interval configurable 2021-04-07 09:37:04 +02:00
dashboards.jsonnet Create jsonnet files to create output files 2019-07-06 20:11:27 +02:00
go.mod *: add mixin tests to CI 2020-08-25 10:03:46 +02:00
go.sum *: add mixin tests to CI 2020-08-25 10:03:46 +02:00
jsonnetfile.json Use absolute jsonnet import paths 2020-10-20 11:34:43 +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 docs: Replace go get with go install for command installation 2021-07-20 12:16:46 +02:00
rules.jsonnet Create jsonnet files to create output files 2019-07-06 20:11:27 +02:00
tools.go *: add mixin tests to CI 2020-08-25 10:03:46 +02:00

Node Mixin

This is a 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 creates recording and alerting rules for Prometheus and suitable dashboard descriptions for Grafana.

To use them, you need to have jsonnet (v0.16+) 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

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

Note that some of the generated dashboards require recording rules specified in the previously generated node_rules.yaml.

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