2016-04-23 22:31:00 +02:00
|
|
|
# Borg exporter
|
|
|
|
|
|
|
|
|
|
Export borg information to prometheus.
|
|
|
|
|
|
|
|
|
|
## Dependencies
|
|
|
|
|
|
2018-09-05 17:00:25 +02:00
|
|
|
* [Dateutils](http://www.fresse.org/dateutils/)
|
2016-04-23 22:31:00 +02:00
|
|
|
* Prometheus (obviously)
|
|
|
|
|
* Node Exporter with textfile collector
|
2018-09-05 17:00:25 +02:00
|
|
|
* [Borg](https://github.com/borgbackup/borg)
|
2016-04-23 22:31:00 +02:00
|
|
|
|
|
|
|
|
## Install
|
|
|
|
|
|
2018-09-05 17:00:25 +02:00
|
|
|
### Manually
|
|
|
|
|
Copy `borg_exporter.sh` to `/usr/local/bin`.
|
2016-04-23 22:31:00 +02:00
|
|
|
|
|
|
|
|
Copy `borg.env` to `/etc/borg` 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.
|
|
|
|
|
|
2018-09-05 17:00:25 +02:00
|
|
|
## Exported metrics
|
2016-04-23 22:31:00 +02:00
|
|
|
|
|
|
|
|
```
|
2018-09-05 17:00:25 +02:00
|
|
|
borg_extract_exit_code
|
2018-09-06 11:46:15 +02:00
|
|
|
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
|
2016-04-23 22:31:00 +02:00
|
|
|
```
|
2017-02-23 10:56:43 +01:00
|
|
|
|
|
|
|
|
### Grafana dashboard
|
|
|
|
|
|
2018-09-06 14:53:39 +02:00
|
|
|
See [here](https://grafana.com/dashboards/7856) for a sample grafana dashboard.
|
