diff --git a/docs/node-mixin/README.md b/docs/node-mixin/README.md index 492409c3..824385ec 100644 --- a/docs/node-mixin/README.md +++ b/docs/node-mixin/README.md @@ -10,33 +10,36 @@ 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 +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 +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 +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 +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. - +.