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 esanchezm/prometheus-qbittorrent-exporter
The application reads configuration using environment variables:
Environment variable | Default | Description |
---|---|---|
QBITTORRENT_HOST |
qbittorrent server hostname | |
QBITTORRENT_PORT |
qbittorrent server port | |
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
These are the metrics this program exports:
Metric name | Type | Description |
---|---|---|
qbittorrent_up |
gauge | Whether if the qBittorrent server is answering requests from this exporter. A version label with the server version is added |
connected |
gauge | Whether if the qBittorrent server is connected to the Bittorrent network. |
firewalled |
gauge | Whether if the qBittorrent server is connected to the Bittorrent network but is behind a firewall. |
dht_nodes |
gauge | Number of DHT nodes connected to |
dl_info_data |
counter | Data downloaded since the server started, in bytes |
up_info_data |
counter | Data uploaded since the server started, in bytes |
torrents_count |
gauge | Number of torrents for each category and status . Example: torrents_count{category="movies",status="downloading"} |
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.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e61a033e72ba8c960d13c2253f590bddcb0c2fc993b0209660e43be0f76fd9a |
|
MD5 | d1fa6df2988b92fc71cecf1f936f709a |
|
BLAKE2b-256 | 737925ff2a2ca8e53bc786200180547e88cdcbd19d0cd8d4a71ac41f567bf83e |
Close
Hashes for prometheus_qbittorrent_exporter-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10e207805ce0e90d93d5179b30fa21e5929778d6c715f24baaaf96e6acc11fc5 |
|
MD5 | bdd5b24a07d1e3a08463c0395e751520 |
|
BLAKE2b-256 | 61ed39db18c62bd9c769210025996697ef48a8feaa919c62e59dcf530f9caf6f |