postgres_exporter/postgres_mixin/README.md
Camille Louédoc-Eyriès 88c3350232
docs(mixin): go get -> go install
> Starting in Go 1.17, installing executables with go get is deprecated. go install may be used instead.
>
> In Go 1.18, go get will no longer build packages; it will only be used to add, update, or remove dependencies in go.mod. Specifically, go get will always act as if the -d flag were enabled.

More information: https://go.dev/doc/go-get-install-deprecation

Signed-off-by: Camille Louédoc-Eyriès <clouedoc@tutanota.com>
2023-10-04 21:10:51 +02:00

27 lines
964 B
Markdown

# Postgres 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 Postgres Mixin is a set of configurable, reusable, and extensible alerts and
dashboards based on the metrics exported by the Postgres Exporter. The mixin creates
recording and alerting rules for Prometheus and suitable dashboard descriptions
for Grafana.
To use them, you need to have `mixtool` and `jsonnetfmt` installed. If you
have a working Go development environment, it's easiest to run the following:
```bash
$ go install github.com/monitoring-mixins/mixtool/cmd/mixtool
$ go install github.com/google/go-jsonnet/cmd/jsonnetfmt
```
You can then build the Prometheus rules files `alerts.yaml` and
`rules.yaml` and a directory `dashboard_out` with the JSON dashboard files
for Grafana:
```bash
$ make build
```
For more advanced uses of mixins, see
https://github.com/monitoring-mixins/docs.