borg_exporter

README

Borg exporter

This exporter exposes Prometheus metrics from Borg backup repositories.

Metrics

Installation

For pre-built binaries please take a look at the releases. https://github.com/raynigon/borg_exporter/releases

Docker

docker pull ghcr.io/raynigon/borg-exporter:latest
docker run --rm -p 9776:9776 ghcr.io/raynigon/borg-exporter:latest

Example docker-compose.yml:

borg_exporter:
    image: ghcr.io/raynigon/borg-exporter:latest
    command: 
        - '<TODO>'
    restart: always
    ports:
    - "127.0.0.1:9786:9786"

Kubernetes

You can find an deployment definition at: https://github.com/raynigon/borg_exporter/tree/main/examples/kubernetes/deployment.yaml .

Building and running

Build

make build

Running

Running using an environment variable:

export BORG_EXPORTER_<TODO>="<TODO>"
export BORG_EXPORTER_<TODO>="<TODO>"
export BORG_EXPORTER_<TODO>="<TODO>"
./borg_exporter

Running using args:

./borg_exporter \
    --repositories=... 

Metrics

Name	Labels	Type	Description
-	-	Gauge	-

Labels

All metrics contain the label repository.

Environment variables / args reference

Version	Env	Arg	Description	Default
>=0.0.1	BORG_EXPORTER_LISTEN_ADDRESS	--web.listen-address	Address on which to expose metrics.	:9786
>=0.0.1	BORG_EXPORTER_METRICS_PATH	--web.telemetry-path	Path under which to expose metrics.	/metrics
>=0.0.1	BORG_EXPORTER_LOG_LEVEL	--log.level	-	"info"
>=0.0.1	BORG_EXPORTER_LOG_FORMAT	--log.format	-	"logfmt"
>=0.0.1	BORG_EXPORTER_LOG_OUTPUT	--log.output	-	"stdout"