mudhorn/node_exporter
1
0
Fork 0
mirror of https://github.com/prometheus/node_exporter.git synced 2024-12-26 22:19:44 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity
node_exporter/docs/node-mixin
History
Sven Kieske d64766f43d
fix the following markdownlint issues (#2362) 
fix the following markdownlint errors (and some more):

[..]mixins/node-exporter/README.md:13: MD031 Fenced code blocks should be surrounded by blank lines
[..]mixins/node-exporter/README.md:21: MD031 Fenced code blocks should be surrounded by blank lines
[..]mixins/node-exporter/README.md:27: MD031 Fenced code blocks should be surrounded by blank lines
[..]mixins/node-exporter/README.md:33: MD031 Fenced code blocks should be surrounded by blank lines
[..]mixins/node-exporter/README.md:41: MD034 Bare URL used
A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md

Signed-off-by: Sven Kieske <s.kieske@mittwald.de>
2022-06-28 05:50:06 +02:00
..
alerts Reverse fsSpaceAvailableCriticalThreshold and fsSpaceAvailableWarningThreshold 2022-04-21 11:34:54 -05:00
dashboards Add darwin dashboard to mixin 2022-04-20 15:18:43 +04:00
lib Change disk graph to disk table 2022-04-27 19:15:50 +04:00
rules mixin: exclude iowait and steal from CPU Utilisation (#2194) 2021-11-04 11:03:27 +01: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 node-mixins/config: Switch fsAvailable warning and critical thresholds 2022-06-07 12:10:48 +02:00
dashboards.jsonnet Create jsonnet files to create output files 2019-07-06 20:11:27 +02:00
jsonnetfile.json Add darwin dashboard to mixin 2022-04-20 15:18:43 +04:00
Makefile Fix up mixin tests (#2167) 2021-10-14 11:06:01 +02:00
mixin.libsonnet Move node-mixin into docs directory 2019-07-05 19:38:03 +02:00
README.md fix the following markdownlint issues (#2362) 2022-06-28 05:50:06 +02:00
rules.jsonnet Create jsonnet files to create output files 2019-07-06 20:11:27 +02:00

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.