...

Text file src/github.com/prometheus/alertmanager/doc/alertmanager-mixin/README.md

Documentation: github.com/prometheus/alertmanager/doc/alertmanager-mixin

     1# Alertmanager Mixin
     2
     3The Alertmanager Mixin is a set of configurable, reusable, and extensible
     4alerts (and eventually dashboards) for Alertmanager.
     5
     6The alerts are designed to monitor a cluster of Alertmanager instances. To make
     7them work as expected, the Prometheus server the alerts are evaluated on has to
     8scrape all Alertmanager instances of the cluster, even if those instances are
     9distributed over different locations. All Alertmanager instances in the same
    10Alertmanager cluster must have the same `job` label. In turn, if monitoring
    11multiple different Alertmanager clusters, instances from different clusters
    12must have a different `job` label.
    13
    14The most basic use of the Alertmanager Mixin is to create a YAML file with the
    15alerts from it. To do so, you need to have `jsonnetfmt` and `mixtool` installed. If you have a working Go development environment, it's
    16easiest to run the following:
    17
    18```bash
    19$ go get github.com/monitoring-mixins/mixtool/cmd/mixtool
    20$ go get github.com/google/go-jsonnet/cmd/jsonnetfmt
    21```
    22
    23Edit `config.libsonnet` to match your environment and then build
    24`alertmanager_alerts.yaml` with the alerts by running:
    25
    26```bash
    27$ make build
    28```
    29
    30For instructions on more advanced uses of mixins, see https://github.com/monitoring-mixins/docs.

View as plain text