Prometheus qBittorrent exporter
A prometheus exporter for qBittorrent. Get metrics from a server and offers them in a prometheus format.
How to use it
You can install this exporter with the following command:
pip3 install prometheus-qbittorrent-exporter
Then you can run it with
qbittorrent-exporter
Another option is run it in a docker container.
docker run \
-e QBITTORRENT_PORT=8080 \
-e QBITTORRENT_HOST=myserver.local \
-p 8000:8000 \
ghcr.io/esanchezm/prometheus-qbittorrent-exporter
Add this to your prometheus.yml
- job_name: "qbittorrent_exporter"
static_configs:
- targets: ['yourqbittorrentexporter:port']
The application reads configuration using environment variables:
| Environment variable | Default | Description |
|---|---|---|
QBITTORRENT_HOST |
qbittorrent server hostname | |
QBITTORRENT_PORT |
qbittorrent server port | |
QBITTORRENT_SSL |
False |
Whether to use SSL to connect or not. Will be forced to True when using port 443 |
QBITTORRENT_URL_BASE |
"" |
qbittorrent server path or base URL |
QBITTORRENT_USER |
"" |
qbittorrent username |
QBITTORRENT_PASS |
"" |
qbittorrent password |
EXPORTER_ADDRESS |
0.0.0.0 |
Exporter listening IP address |
EXPORTER_PORT |
8000 |
Exporter listening port |
EXPORTER_LOG_LEVEL |
INFO |
Log level. One of: DEBUG, INFO, WARNING, ERROR, CRITICAL |
METRICS_PREFIX |
qbittorrent |
Prefix to add to all the metrics |
VERIFY_WEBUI_CERTIFICATE |
True |
Whether to verify SSL certificate when connecting to the qbittorrent server. Any other value but True will disable the verification |
EXPORT_METRICS_BY_TAG |
False |
Whether to export tag-based torrent count metrics |
Metrics
These are the metrics this program exports, assuming the METRICS_PREFIX is qbittorrent:
| Metric name | Type | Description |
|---|---|---|
qbittorrent_up |
gauge | Whether the qBittorrent server is answering requests from this exporter. A version label with the server version is added. |
qbittorrent_connected |
gauge | Whether the qBittorrent server is connected to the Bittorrent network. |
qbittorrent_firewalled |
gauge | Whether the qBittorrent server is connected to the Bittorrent network but is behind a firewall. |
qbittorrent_dht_nodes |
gauge | Number of DHT nodes connected to. |
qbittorrent_total_peer_connections |
gauge | Total number of peer connections. |
qbittorrent_dl_info_data |
counter | Data downloaded since the server started, in bytes. |
qbittorrent_up_info_data |
counter | Data uploaded since the server started, in bytes. |
qbittorrent_alltime_dl_total |
counter | Total historical data downloaded, in bytes. |
qbittorrent_alltime_ul_total |
counter | Total historical data uploaded, in bytes. |
qbittorrent_torrents_count |
gauge | Number of torrents for each category and status. Example: qbittorrent_torrents_count{category="movies",status="downloading"} |
qbittorrent_tagged_torrents_count |
gauge | Number of torrents for each tag and status. Enabled via EXPORT_METRICS_BY_TAG=True. Example: qbittorrent_tagged_torrents_count{tag="linux",status="downloading"} |
Screenshot
License
This software is released under the GPLv3 license.
Metadata
Release files for prometheus-qbittorrent-exporter 1.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| prometheus_qbittorrent_exporter-1.7.0.tar.gz | 22.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| prometheus_qbittorrent_exporter-1.7.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 41.5 kB
Release files / prometheus_qbittorrent_exporter-1.7.0.tar.gz
| Download URL | prometheus_qbittorrent_exporter-1.7.0.tar.gz |
|---|---|
| Size | 22.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1bd20117b650efda44bc10cc79b93096f07bb307faa8705e11a7e3a57794a771
|
|
BLAKE2b-256 checksum How to use checksums |
fdeb393141120e739dc3ffe7327a4ca9f52bcb108d543633a5d7007eb3ab1dc4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
pdm/2.26.9 CPython/3.11.15 Linux/7.0.9-102.fc43.x86_64
|
Release files / prometheus_qbittorrent_exporter-1.7.0-py3-none-any.whl
| Download URL | prometheus_qbittorrent_exporter-1.7.0-py3-none-any.whl |
|---|---|
| Size | 19.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f849b7e1a548850fc76ddc03cf8e362d5dc914adbdbc45360465d07d33d55337
|
|
BLAKE2b-256 checksum How to use checksums |
cfdf144b18e198465b8091112bff8d984f066b33b13c954a708ef8ec79f700db
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
pdm/2.26.9 CPython/3.11.15 Linux/7.0.9-102.fc43.x86_64
|