Skip to content

Monitoring

Bram Gruneir edited this page May 15, 2024 · 24 revisions

Monitoring

Most Replicator commands support a --metricsAddr flag which will start an HTTP server to expose the following URLs. In the case of C2X modes, these endpoints are served automatically.

  • /debug/pprof for standard golang tooling
  • /_/diag to display internal state
  • /_/healthz for a basic 200 OK health check
  • /_/varz for Prometheus metrics

Prometheus Scrape

Here's an example Prometheus configuration to scrape Replicator:

global:
  scrape_interval: 5s

scrape_configs:
  - job_name: replicator
    metrics_path: /_/varz
    scheme: https # Change to http if not using a TLS-enabled server
    tls_config:
      insecure_skip_verify: true # Needed if using --tlsSelfSigned
    static_configs:
      - targets: [ '127.0.0.1:30004' ]

Grafana Pre-Built dashboard

See scripts/dashboard directory.

Clone this wiki locally