fluxrestic v1.1.1
Parse Restic status output and feed summary to a influxdb v2 db.
Tested with influxdb 2.3 and restic 0.1.3
requirements
requires python 3 and influxdb-client library
restic >= 0.13.1
influxdb >= 2.3
Install influxdb-client with this command:
$ pip install influxdb-client
usage
usage: fluxrestic [-h] [-t TOKEN] [-o organisation] [-b BUCKET] [-s HOST] [-m MEASUREMENT] [-r REPO] [-c REPOSERVER] [-i INTERVAL] [-d] [-p]
optional arguments:
-h, --help show this help message and exit
-t TOKEN, --token TOKEN
influx auth token
-o organisation, --org organisation
influx organisation
-b BUCKET, --bucket BUCKET
target bucket
-s HOST, --host HOST hostname
-m MEASUREMENT, --measurement MEASUREMENT
influx measurement, e.g. restic or restic_%type
-r REPO, --repository REPO
restic repository (optional)
-c REPOSERVER, --resticserver REPOSERVER
restic server (optional)
-i INTERVAL, --interval INTERVAL
status update interval (default: 5s)
-d, --debug output debug information
-p, --progress output restic backup progress
'influx host' defaults to http://localhost:8086 if omitted
full example
#!/bin/bash
export RESTIC_PASSWORD="MY-SECRET-RESTIC-PASSWORD"
export INFLUX_TOKEN="MY-SECRET-INFLUX-TOKEN"
restic --json -r sftp:me@myresticserver.com:/users/me/testrepo backup /mnt/mydata 2>&1 | ./fluxrestic -o mycompany -b mybucket -s https://www.myinfluxserver.com:8086 -r testrepo -c myresticserver.com -m restic_%type
# THE --json PARAMETER IS MANDATORY.
For hiding the influx token (--token), we make use of the fallback enviroment variable INFLUX_TOKEN here.
There are some more fallback enviroment variables:
INFLUX_ORG : influx organisation (--org)
INFLUX_BUCKET : influx bucket (--bucket)
RESTIC_REPOSITORY : restic repo (--repository)
permissions
make this script executable
e.g. using command line
chmod +x fluxrestic
feel free to copy it into directory in your PATH enviroment (e.g. /usr/local/bin, /usr/bin)
similar tools
restic2influx by Hajo Noerenberg (written in perl)
CHANGELOG
[1.1.1] - 2022-07-18
- handling of non json input
- handling of non-string values e.g. current_files, errors
- handling of status message_type error (needs to redirect restic stderr to stdout)
- fix: repo and server tags were not submitted to influx db
- fix: handling of status messages without total_files property
[1.1] - 2022-07-17
- new features: status update rate limit, progress bar, debug option
[1.0] - 2022-07-17
- initial release