All apps · 0 apps
sabnzbd_exporter
Docker app from wupasscat's Repository
Overview
This is a metrics exporter for sending statistics from sabnzbd (https://sabnzbd.org/) to prometheus (http://prometheus.io).
Readme
View on GitHubsabnzbd_exporter
This is a metrics exporter for sending statistics from sabnzbd (https://sabnzbd.org/) to prometheus (http://prometheus.io). Example scrape configurations and a grafana dashboard can be found in Examples
Configuration
This exporter is configured by environment variables. There are 2 required environment variables
- SABNZBD_BASEURLS - Comma seperated list of sabnzbd servers to connect to in the fomat http://<sabnzbd host/ip>:<port>/sabnzbd
- SABNZBD_APIKEYS - Comma seperated list of API keys. Positionally each API key must be for the same server as in the equivilent position of the SABNZBD_BASEURLS
(Previously this module only supported a single server and so the environment variables were not pluralized SABNZBD_BASEURL & SABNZBD_APIKEY these values are still supported for backwards compatibility but the plural versions are preferred)
Running/Developing
- Create a new python virtual env
python3 -m venv .venv - Install the required modules into your venv
./.venv/bin/pip3 install -r requirements.txt - Start the server locally
SABNZBD_BASEURLS=http://<sabnzbd host/ip>:<port>/sabnzbd SABNZBD_APIKEYS=<apikey> ./.venv/bin/python3 sabnzbd_exporter.py
Running using docker
docker run \
-e SABNZBD_BASEURLS=http://<sabnzbd host/ip>:<port>/sabnzbd \
-e SABNZBD_APIKEYS=<apikey> \
-p 9387:9387 \
-d --restart=always \
-n sabnzbd_exporter \
msroest/sabnzbd_exporter
Exported Metrics
Common Labels
- sabnzbd_instance
| Name | Description | Metric Type | Labels |
|---|---|---|---|
| sabnzbd_download_bytes | Total data download | Gauge | period |
| sabnzbd_server_download_bytes | Data download quantity by server | Gauge | server, period |
| sabnzbd_queue_size | Length of the current download queue | Gauge | |
| sabnzbd_queue_download_rate_bytes_per_second | Curent download rate | Gauge | |
| sabnzbd_queue_remaining_bytes | Queue bytes remaining | Gauge | |
| sabnzbd_queue_total_size_bytes | Queue total size bytes | Gauge | |
| sabnzbd_queue_remaining_seconds | Estimated queue time remaining | Gauge | |
| sabnzbd_paused | Is sabnzbd paused | Guage |
- Period label values (total,day,week,month)
Categories
Download Statistics
2,265,573
Total Downloads
27,705
This Month
11,453
Avg / Month
Total Downloads Over Time
Loading chart...
Related apps
Explore more like this
Explore allLinks
Details
Repository
msroest/sabnzbd_exporterLast Updated2025-11-07
First Seen2023-02-19
Runtime arguments
- Network
bridge- Shell
sh- Privileged
- false
Template configuration
Sabnzbd URL(s)Variable
example: http://192.168.1.100:8080/sabnzbd
- Target
- SABNZBD_BASEURLS
Sabnzbd API key(s)Variable
- Target
- SABNZBD_APIKEYS
Listen PortPorttcp
Exporter port
- Target
- 9387
- Default
- 9387
- Value
- 9387