PROMETHEUS-PGBACKREST-EXPORTER(1)

📦
version 0.23.0 · 3 versions
, in ubuntu stonking

💖 NAME 💖

okay so bestie, this is prometheus-pgbackrest-exporter — the Prometheus exporter for PgBackRest. that's the whole name, that's the whole vibe. ✨

🌸 SYNOPSIS 🌸

prometheus-pgbackrest-exporter [<flags>]

that's it. no subcommands, no positional args, just flags. she's simple like that. 🎀

🦋 DESCRIPTION 🦋

ngl the original page just... puts the heading here and dips. no description. iconic behavior honestly 💀 but everything you actually need lives down in OPTIONS, so let's go.

💅 OPTIONS 💅

  • -h, --help — shows context-sensitive help, aka help that knows where you are. also pls try --help-long and --help-man — she has range. 👑
  • --web.telemetry-path — the path where your metrics get exposed. that's where the good stuff lives. 🌈
  • --web.systemd-socket — use systemd socket activation listeners instead of port listeners. Linux only! 🐧
  • --web.listen-address=:9854 — the addresses where metrics and the web interface get exposed. she's repeatable, so you can stack multiple addresses if you want. examples: :9100 or [::1]:9100 for http, and vsock://:9100 for vsock. 🔥
  • --web.config.file — path to the config file that can turn on TLS or authentication. see: https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md 🎀
  • --collect.interval=600 — how often metrics get collected, in seconds. 📏
  • --backrest.config — full path to the pgBackRest configuration file. 🗂️
  • --backrest.config-include-path — full path to additional pgBackRest configuration files. ✨
  • --backrest.stanza-include — a specific stanza to collect metrics from. you can specify this several times, stack 'em up. 💜
  • --backrest.stanza-exclude — a specific stanza to exclude from collecting metrics. also repeatable, also stackable. 🙈
  • --backrest.backup-type — a specific backup type to collect metrics for. must be one of: [full, incr, diff]. 🍓
  • --backrest.database-count — exposes the number of databases in backups. 🔢
  • --backrest.database-parallel-processes=1 — number of parallel processes used for collecting info about databases. more processes, more multitasking energy. ⚡
  • --backrest.database-count-latest — exposes the number of databases in the latest backups. 🌟
  • --backrest.reference-count — exposes the number of references to other backups (the backup reference list). 🔗
  • --backrest.verbose-wal — exposes additional labels for WAL metrics. extra detail, extra slay. 🎀
  • --collector.pgbackrest — enables the pgBackRest collector. when disabled, only the pgBackRest version and exporter build info get collected — so like, barely anything. 😭
  • --log.level=info — only logs messages at this severity or above. one of: [debug, info, warn, error]. 🔊
  • --log.format=logfmt — the output format for log messages. one of: [logfmt, json]. 📝
  • --version — shows the application version. 💁♀️
reminder bestie: everything above is the real deal, verbatim flags and defaults included. no cap. 💖

and that's the whole page, fr fr. this was written for prometheus-pgbackrest-exporter and dated March 2026 — the man page source line is just prometheus-pgbackrest-exporter ... March 2026, so yes, i'm mentioning it, we stay thorough around here. 🫶🌸 go forth and export some metrics, you got this. 💜✨

📦 where this page comes from