prometheus-borgmatic-exporter

A Prometheus metrics exporter for borgmatic, designed to be run via a systemd timer and consumed by the node exporter textfile collector.

Requirements

• Python 3.11+
• borgmatic

Installation

pip install prometheus-borgmatic-exporter

Usage

Usage: prometheus-borgmatic-exporter [OPTIONS]

  Collect borgmatic repository metrics and export them for Prometheus.

  Queries borgmatic for repository and archive statistics and writes them
  to a .prom file for consumption by the Prometheus node exporter textfile
  collector.

  By default only the latest archive is queried per repository. Use
  --all-archives to collect metrics for every archive, at the cost of
  a significantly longer runtime.

  Using --all-archives will create one time series per archive and may
  significantly increase Prometheus storage usage.

Options:
  --borgmatic-bin PATH           Path to the borgmatic executable.
                                 [default: /usr/bin/borgmatic]
  --borgmatic-config PATH        Configuration file or directory. Can be
                                 specified multiple times. If not
                                 specified, borgmatic's default
                                 configuration discovery is used.
  --textfile-collector-dir PATH  Directory where the Prometheus collector
                                 textfile file will be written.
                                 [default: /var/lib/prometheus/node-exporter]
  --all-archives                 Collect metrics for all archives instead
                                 of only the latest archive. This can
                                 significantly increase runtime and
                                 Prometheus storage usage.
  -q, --quiet                    Suppress all non-error output.
  -v, --verbose                  Enable verbose output.
  --version                      Show version information and exit.
  --color [auto|always|never]    Colorize the output. A bare --color is
                                 the same as --color=always.
                                 [default: auto]
  --no-color                     Disable colorization (alias of
                                 --color=never).
  -h, --help, -?                 Show this message and exit.

Metrics

All metrics carry the labels repository_id, repository_label, and location.

Repository metrics

Latest archive metrics

Per-archive metrics (--all-archives only)

These metrics additionally carry archive_id and archive_name labels.

License

BSD-3-Clause. See LICENSE for details.