Sign inSign up

esanchezm/prometheus-qbittorrent-exporter

By esanchezm

Updated 4 months ago

Get metrics from a server and offers them in a prometheus format.

Image
3

500K+

esanchezm/prometheus-qbittorrent-exporter repository overview

Prometheus qBittorrent exporter

A prometheus exporter for qBitorrent. Get metrics from a server and offers them in a prometheus format.

How to use it

You can run it with the following command:

docker run -e QBITTORRENT_PORT=8080 -e QBITTORRENT_HOST=myserver.local -p 8000:8000 esanchezm/prometheus-qbittorrent-exporter

The application reads configuration using environment variables:

Environment variableDefaultDescription
QBITTORRENT_HOSTqbittorrent server hostname
QBITTORRENT_PORTqbittorrent server port
QBITTORRENT_USER""qbittorrent username
QBITTORRENT_PASS""qbittorrent password
EXPORTER_PORT8000Exporter listening port
EXPORTER_LOG_LEVELINFOLog level. One of: DEBUG, INFO, WARNING, ERROR, CRITICAL
METRICS_PREFIXqbittorrentPrefix to add to all the metrics

Metrics

These are the metrics this program exports, assuming the METRICS_PREFIX is qbittorrent:

Metric nameTypeDescription
qbittorrent_upgaugeWhether if the qBittorrent server is answering requests from this exporter. A version label with the server version is added
qbittorrent_connectedgaugeWhether if the qBittorrent server is connected to the Bittorrent network.
qbittorrent_firewalledgaugeWhether if the qBittorrent server is connected to the Bittorrent network but is behind a firewall.
qbittorrent_dht_nodesgaugeNumber of DHT nodes connected to
qbittorrent_dl_info_datacounterData downloaded since the server started, in bytes
qbittorrent_up_info_datacounterData uploaded since the server started, in bytes
qbittorrent_torrents_countgaugeNumber of torrents for each category and status. Example: qbittorrent_torrents_count{category="movies",status="downloading"}

Screenshot

Grafana dashboard screenshot

More info

License

This software is released under the GPLv3 license.

Tag summary

Content type

Image

Digest

sha256:41a7030be

Size

17.7 MB

Last updated

4 months ago

docker pull esanchezm/prometheus-qbittorrent-exporter