Borg exporter

Export borg information to prometheus.

Dependencies

• Dateutils
• Prometheus (obviously)
• Node Exporter with textfile collector
• Borg

Install

You must install this node exporter in each host that you want to monitor.

With the Makefile

For convenience, you can install this exporter with the command line make install or follow the process described in the next paragraph.

Manually

Copy borg_exporter.sh to /usr/local/bin.

Copy borg_exporter.rc to /etc/borg_exporter.rc and replace your repokey and repository in it.

Copy the systemd unit to /etc/systemd/system and run

systemctl enable prometheus-borg-exporter.timer
systemctl start prometheus-borg-exporter.timer

Alternative: Use ExecStartPost in your borg backupt timer itself to write our the metrics.

Configuration options

• By default, borg_exporter will be quiet if no errors occur. You can use the -v or --verbose option get a progress log as the program runs. If using systemd, you can use journalctl to view the log.
• Using the -x or --no-extract option will prevent the exporter from running the borg extract command. This is useful if running against a remote or very large repository, as the extract command can take a long time to run.
• Use -c or --config to specify a different configuration file. The default is /etc/borg_exporter.rc file.
• Use -u or --user and -g or --group to specify the user and group of the file created by the exporter.

Configure your node exporter

You must start the node exporter service with the following parameter: --collector.textfile.directory=/var/lib/node_exporter/textfile_collector

Exported metrics

borg_extract_exit_code
borg_hours_from_last_backup
borg_archives_count
borg_files_count
borg_chunks_unique
borg_chunks_total
borg_last_size
borg_last_size_compressed
borg_last_size_dedup
borg_total_size
borg_total_size_compressed
borg_total_size_dedup

Grafana dashboard

See here for a sample grafana dashboard.