alertmanager/doc/alertmanager-mixin
gotjosh 07b89eb117
Mixin: Pin the mixtool version in CircleCI
In mixtool, the tip of master broke for our mixin - I have managed to trace it down and opened a PR (see https://github.com/grafana/dashboard-linter/pull/143) but for now, let's pin the version to make sure our CI is not affected.

Signed-off-by: gotjosh <josue.abreu@gmail.com>
2023-08-03 16:15:26 +01:00
..
dashboards Mixin: Fix mixin linting 2022-06-29 16:25:15 +01:00
.gitignore [mixins] Alertmanager Overview dashboard (#2540) 2021-06-07 19:54:22 +02:00
.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 Beginnings of an Alertmanager mixin. (#1629) 2020-12-03 15:57:42 +01:00
alerts.jsonnet Beginnings of an Alertmanager mixin. (#1629) 2020-12-03 15:57:42 +01:00
alerts.libsonnet Improve the AlertmanagerMembersInconsistent alert 2021-06-22 08:21:02 +02:00
config.libsonnet [mixins] Alertmanager Overview dashboard (#2540) 2021-06-07 19:54:22 +02:00
dashboards.jsonnet [mixins] Alertmanager Overview dashboard (#2540) 2021-06-07 19:54:22 +02:00
dashboards.libsonnet [mixins] Alertmanager Overview dashboard (#2540) 2021-06-07 19:54:22 +02:00
jsonnetfile.json [mixins] Alertmanager Overview dashboard (#2540) 2021-06-07 19:54:22 +02:00
jsonnetfile.lock.json [mixins] Alertmanager Overview dashboard (#2540) 2021-06-07 19:54:22 +02:00
mixin.libsonnet [mixins] Alertmanager Overview dashboard (#2540) 2021-06-07 19:54:22 +02:00

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.