https://github.com/janstuemmel/qbit-exporter
A simple prometheus exporter for qbittorrent written in golang
https://github.com/janstuemmel/qbit-exporter
grafana prometheus prometheus-exporter prometheus-metrics qbittorrent qbittorrent-api qbittorrent-webui
Last synced: about 2 months ago
JSON representation
A simple prometheus exporter for qbittorrent written in golang
- Host: GitHub
- URL: https://github.com/janstuemmel/qbit-exporter
- Owner: janstuemmel
- License: mit
- Created: 2023-03-10T09:51:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-12T14:12:08.000Z (over 2 years ago)
- Last Synced: 2025-05-16T11:08:33.126Z (5 months ago)
- Topics: grafana, prometheus, prometheus-exporter, prometheus-metrics, qbittorrent, qbittorrent-api, qbittorrent-webui
- Language: Go
- Homepage:
- Size: 66.4 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# qbit exporter
A simple prometheus exporter for qbittorrent written in golang.
## Metrics
### Torrents
| Name | Type | Description |
| ---- | ---- | ----------- |
| `qbit_torrent_info` | gauge | Torrent general info |
| `qbit_torrent_uploaded_bytes_total` | gauge | Torrent total bytes uploaded |
| `qbit_torrent_uploaded_bytes_total` | gauge | Torrent total bytes downloaded |
| `qbit_torrent_ratio_total` | gauge | Torrent ratio |
| `qbit_torrent_seeds_total` | gauge | Torrent number of seeders connected to |
| `qbit_torrent_leechs_total` | gauge | Torrent number of leechers connected to |
| `qbit_torrent_upspeed_bytes` | gauge | Torrent upload speed in bytes |
| `qbit_torrent_dlspeed_bytes` | gauge | Torrent download speed in bytes |
Labels: `name`, `tracker`, `category`
## Usage
Make sure webui is enabled in qbittorrent settings.
### Environment
* `QB_USER` Your qbittorrent webui username
* `QB_PASS` Your qbittorrent webui password
* `QB_URL` Your qbittorrent webui url
### Build and run
```sh
CGO_ENABLED=0 go build
./qbit-exporter
```
### Docker
```sh
docker run \
-e QB_USER=admin \
-e QB_PASS=adminadmin \
-e QB_URL=http://localhost:8080 \
-p 9897:9897 \
ghcr.io/janstuemmel/qbit-exporter
```
For a `docker-compose` setup, see [example folder](./example)
### Prometheus
Add this to your prometheus configuration
```yml
scrape_configs:
- job_name: qbit
static_configs:
- targets: [ "localhost:9897" ]
```