alertmanager/doc/alertmanager-mixin
janhorstmann bd70e73fc7
Update mixin dashboard (#4078)
Update and rewrite the mixin dashboard to use the grafonnet ([1])
library.
Grafana has deprecated angular plugins ([2]) as used by grafonnet-lib
([3]) with removal pending for grafana version 12.
Additionally grafonnet-lib is deprecated/unmaintained in favor of
grafonnet.
Therefore the mixin dashboard has been updated to use grafonnet.

[1]
https://github.com/grafana/grafonnet

[2]
https://grafana.com/docs/grafana/latest/developers/angular_deprecation/

[3]
https://github.com/grafana/grafonnet-lib

Signed-off-by: Jan Horstmann <horstmann@osism.tech>
2024-10-29 09:59:51 +00:00
..
dashboards Update mixin dashboard (#4078) 2024-10-29 09:59:51 +00:00
.gitignore
.lint Mixin: Fix mixin linting 2022-06-29 16:25:15 +01:00
Makefile Mixin: Pin the mixtool version in CircleCI 2023-08-03 16:15:26 +01:00
README.md
alerts.jsonnet
alerts.libsonnet fix label mismatch for alertmanager_notifications_failed_total 2023-11-11 22:26:38 +08:00
config.libsonnet
dashboards.jsonnet
dashboards.libsonnet
jsonnetfile.json Update mixin dashboard (#4078) 2024-10-29 09:59:51 +00:00
jsonnetfile.lock.json Update mixin dashboard (#4078) 2024-10-29 09:59:51 +00:00
mixin.libsonnet

README.md

Alertmanager Mixin

The Alertmanager Mixin is a set of configurable, reusable, and extensible alerts (and eventually dashboards) for Alertmanager.

The alerts are designed to monitor a cluster of Alertmanager instances. To make them work as expected, the Prometheus server the alerts are evaluated on has to scrape all Alertmanager instances of the cluster, even if those instances are distributed over different locations. All Alertmanager instances in the same Alertmanager cluster must have the same job label. In turn, if monitoring multiple different Alertmanager clusters, instances from different clusters must have a different job label.

The most basic use of the Alertmanager Mixin is to create a YAML file with the alerts from it. To do so, you need to have jsonnetfmt and mixtool installed. If you have a working Go development environment, it's easiest to run the following:

$ go get github.com/monitoring-mixins/mixtool/cmd/mixtool
$ go get github.com/google/go-jsonnet/cmd/jsonnetfmt

Edit config.libsonnet to match your environment and then build alertmanager_alerts.yaml with the alerts by running:

$ make build

For instructions on more advanced uses of mixins, see https://github.com/monitoring-mixins/docs.