github
/
node_exporter
mirror of https://github.com/prometheus/node_exporter
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '0d3400ebc9'
${ noResults }
node_exporter/docs/node-mixin
History
looklose 7d4103c089
chore: fix typo in comment 		8 months ago
..
alerts Fix description for NodeDiskIOSaturation alert (#2929) 9 months ago
dashboards Replace mistaken ) with }, resulting in parsable promql 2 years ago
lib Add multi-cluster support for Nodes dashboard (#2945) 9 months ago
rules mixin: exclude iowait and steal from CPU Utilisation (#2194) 3 years ago
.gitignore Add Makefile to easily make output files and lint sources 5 years ago
Makefile Fix up mixin tests (#2167) 3 years ago
README.md fix the following markdownlint issues (#2362) 2 years ago
alerts.jsonnet Create jsonnet files to create output files 5 years ago
config.libsonnet chore: fix typo in comment 8 months ago
dashboards.jsonnet Create jsonnet files to create output files 5 years ago
jsonnetfile.json Add darwin dashboard to mixin 3 years ago
mixin.libsonnet Move node-mixin into docs directory 5 years ago
rules.jsonnet Create jsonnet files to create output files 5 years ago

README.md

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.