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_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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7c6f46f9bd3c9f12c1eb098f40e3a113cb8936741c689e07b4388fcdf24c30b |
|
MD5 | d4455a4491179d046eea039b2cbf1120 |
|
BLAKE2b-256 | c4dd8e09a3fee1a658378f4bf6e5593bde9d260ff5e803d580a0f80b1035b0bf |
Close
Hashes for prometheus_qbittorrent_exporter-1.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01120fb6a7c00b4b4f608f6dc9f634295e9293b65ab2642036907021fc934237 |
|
MD5 | 66fe4a33a964ba29e050ac6095cbd860 |
|
BLAKE2b-256 | 6ca3d3b13a3da22138d2815dbe8aa35fdf68e63fc0a30f1ab1e035d8c73ec118 |