Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pinpox/restic-exporter
Prometheus exporter for restic backups (https://restic.net)
https://github.com/pinpox/restic-exporter
metrics monitoring nix nixos prometheus prometheus-exporter
Last synced: 4 months ago
JSON representation
Prometheus exporter for restic backups (https://restic.net)
- Host: GitHub
- URL: https://github.com/pinpox/restic-exporter
- Owner: pinpox
- Created: 2022-06-21T09:16:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-28T09:49:16.000Z (11 months ago)
- Last Synced: 2024-09-27T09:21:38.182Z (4 months ago)
- Topics: metrics, monitoring, nix, nixos, prometheus, prometheus-exporter
- Language: Go
- Homepage:
- Size: 46.9 KB
- Stars: 10
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Metrics
The following metrics are exported for given host (target)
```
❯ curl 'localhost:8999/probe?target=ahorn'
# HELP restic_snapshots_latest_time Time of the latest snapshot
# TYPE restic_snapshots_latest_time gauge
restic_snapshots_latest_time{hostname="ahorn"} 1.655762407e+09
# HELP restic_stats_latest_total_nfiles Number of files
# TYPE restic_stats_latest_total_nfiles gauge
restic_stats_latest_total_nfiles{hostname="ahorn"} 480
# HELP restic_stats_latest_total_size Total Size
# TYPE restic_stats_latest_total_size gauge
restic_stats_latest_total_size{hostname="ahorn"} 686011
```
## Configuration
Configuration is done via environment variables.
```
# Exporter configuration
RESTIC_EXPORTER_BIN="restic"
RESTIC_EXPORTER_PORT=8999
RESTIC_EXPORTER_ADDRESS=127.0.0.1
# Restic configuration
RESTIC_REPOSITORY=s3:https://s3.myhost.com/restic
RESTIC_PASSWORD_FILE=/var/src/secrets/restic/repo-pw
# Optional: S3 credentials
AWS_ACCESS_KEY_ID=restic-ahorn
AWS_SECRET_ACCESS_KEY=aaaaaabbbbbcccccddddd
```
## Nix flake
A nix flake is provided exposing the application as package. It also provides a
nixos module.
```nix
services.restic-exporter = {
enable = true;
# Optional configuration
port = "8999";
address = "127.0.0.1";
user = "restic-exporter";
group = "restic-exporter";
environmentFile = "/path/to/envfile";
};
```
## Prometheus
``` yaml
- job_name: restic
metrics_path: /probe
relabel_configs:
- source_labels:
- "__address__"
target_label: "__param_target"
- source_labels:
- "__param_target"
target_label: target
- replacement: "127.0.0.1:8999"
target_label: "__address__"
scrape_interval: "10m"
scrape_timeout: "9m"
static_configs:
- targets:
- host1
```