victoriametrics/vmalert repository overview

⁠What is vmalert?

vmalert is a service that evaluates Prometheus-compatible alerting and recording rules. It periodically queries a VictoriaMetrics data source, evaluates the rules against the data, and if an alert's condition is met, it fires a notification to a configured Alertmanager instance.

⁠How to Use This Image

vmalert needs a configuration file for rules, a data source to query, and a notifier URL to send alerts.

Run vmalert with local rule files:

docker run -d --name vmalert -p 8880:8880\
  -v /path/to/rules:/etc/rules\
  victoriametrics/vmalert:latest\
  -rule=/etc/rules/*.yml\
  -datasource.url=http://<victoriametrics-addr>:8428\
  -notifier.url=http://<alertmanager-addr>:9093

⁠Configuration

• -rule: Path to a file or directory with alerting/recording rules in YAML format. Can be specified multiple times.

• -datasource.url: The URL of the VictoriaMetrics data source to query for rule evaluation.

• -notifier.url: The URL of the Alertmanager-compatible notifier to send alerts to.

• -httpListenAddr: The TCP address for vmalert's web interface. Default: :8880.

⁠Where to Get Help

⁠Source Code

The source code for vmalert is available in the VictoriaMetrics GitHub repository.