Prometheus exporter for qbittorrent
Project description
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 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_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 |
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_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_torrents_count |
gauge | Number of torrents for each category and status . Example: qbittorrent_torrents_count{category="movies",status="downloading"} |
Screenshot
License
This software is released under the GPLv3 license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for prometheus_qbittorrent_exporter-1.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc8ac01d5e2c230f7f73cef61662275fb03fe47f7a656e85ce5e156048725254 |
|
MD5 | b239614f5eb095f7dabd67ba41987927 |
|
BLAKE2b-256 | 669d3399ffc8b2cc0833300cac384d9a1535ff328b882f26a9583393a0deb3f6 |
Close
Hashes for prometheus_qbittorrent_exporter-1.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d75028d7f65bf63943fdc276b6f8039eceb62610adda56db314f869f78378560 |
|
MD5 | 21b3bdf69170d47918527b3cc5972529 |
|
BLAKE2b-256 | 5ca7058013615ebf127624d8f7e6637e2f6fd259126bfaabc036daf49b38091c |