irrwitzer42 / prometheus-storagebox-exporter

Prometheus exporter for Hetzner storage boxes dockerized

prometheus-storagebox-exporter

This tool talks to the Hetzner API and gets a list of all Storage Boxes in your account and exports their statistics as Prometheus metrics on port <host>:9509/metrics.

Authentication

Sadly the old Hetzner API only accepts BasicAuth as an authenticaton method for their API so this exporter needs your customer number and password for your Hetzner account. These variables gets passed to the tool as environment variables: HETZNER_USER and HETZNER_PASS

Exported Metrics

# HELP storagebox_disk_quota Total diskspace in MB
# TYPE storagebox_disk_quota gauge
storagebox_disk_quota{id="1234",name="Backup",product="BX10",server="u12345.your-storagebox.de"} 102400
# HELP storagebox_disk_usage Total used diskspace in MB
# TYPE storagebox_disk_usage gauge
storagebox_disk_usage{id="1234",name="Backup",product="BX10",server="u12345.your-storagebox.de"} 23256
# HELP storagebox_disk_usage_data Used diskspace by files in MB
# TYPE storagebox_disk_usage_data gauge
storagebox_disk_usage_data{id="1234",name="Backup",product="BX10",server="u12345.your-storagebox.de"} 23256
# HELP storagebox_disk_usage_snapshots Used diskspace by snapshots in MB
# TYPE storagebox_disk_usage_snapshots gauge
storagebox_disk_usage_snapshots{id="1234",name="Backup",product="BX10",server="u12345.your-storagebox.de"} 0

Running as docker container

This exporter can be run as docker-image as well. Either build and run the image via the Dockerfile by running

docker build --tag storagebox-exporter .

then modify .env according to your user credentials and run the image:

docker run -d --name storagebox-exporter storagebox-exporter --env-file .env

or use:

docker-compose

After modifying .env to your needs, install and run the container by running:

docker compose up -d   # or 'docker-compose up -d' on older systems