You're reading an old version of this documentation. If you want up-to-date information, please have a look at stable.

Monitoring

Monitoring endpoints are configured in the global.monitoring section of the config file.

Prometheus & Grafana

zrepl can expose Prometheus metrics via HTTP. The listen attribute is a net.Listen string for tcp, e.g. :9091 or 127.0.0.1:9091. The listen_freebind attribute is explained here. The Prometheus monitoring job appears in the zrepl control job list and may be specified at most once.

zrepl also ships with an importable Grafana dashboard that consumes the Prometheus metrics: see dist/grafana. The dashboard also contains some advice on which metrics are important to monitor.

Note

At the time of writing, there is no stability guarantee on the exported metrics.

global:
  monitoring:
    - type: prometheus
      listen: ':9091'
      listen_freebind: true # optional, default false