mirror of
https://github.com/prometheus/node_exporter.git
synced 2025-08-20 18:33:52 -07:00
d64766f43d
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>
46 lines
1.3 KiB
Markdown
46 lines
1.3 KiB
Markdown
# 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:
|
|
|
|
```bash
|
|
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:
|
|
|
|
```bash
|
|
jb install
|
|
```
|
|
|
|
You can then build the Prometheus rules files `node_alerts.yaml` and
|
|
`node_rules.yaml`:
|
|
|
|
```bash
|
|
make node_alerts.yaml node_rules.yaml
|
|
```
|
|
|
|
You can also build a directory `dashboard_out` with the JSON dashboard files
|
|
for Grafana:
|
|
|
|
```bash
|
|
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>.
|