This app is a Prometheus exporter for qBittorrent. You must have version 4.1.0 of qBittorrent or higher.

I was using an excellent exporter written in Java and I wanted to learn Go, that's how I got the idea to rewrite the exporter in Go.

Additionally, this project adds support for tags and categories. It tracks the categories and tags of each torrent and the global categories and tags.

This app is a lightweight and fast prometheus exporter for qBittorrent, made to be integrated with the qbittorrent-grafana-dashboard.

qBittorrent >= 5.2.0:

docker run --name=qbittorrent-exporter \
    -e QBITTORRENT_BASE_URL=http://192.168.1.10:8080 \
    -e QBITTORRENT_API_KEY='<your_api_key>' \
    -p 8090:8090 \
    ghcr.io/martabal/qbittorrent-exporter:latest

qBittorrent < 5.2.0:

docker run --name=qbittorrent-exporter \
    -e QBITTORRENT_BASE_URL=http://192.168.1.10:8080 \
    -e QBITTORRENT_PASSWORD='<your_password>' \
    -e QBITTORRENT_USERNAME=admin \
    -p 8090:8090 \
    ghcr.io/martabal/qbittorrent-exporter:latest

qBittorrent >= 5.2.0:

services:
  qbittorrent-exporter:
    image: ghcr.io/martabal/qbittorrent-exporter:latest
    container_name: qbittorrent-exporter
    environment:
      - QBITTORRENT_BASE_URL=http://192.168.1.10:8080
      - QBITTORRENT_API_KEY='<your_api_key>'
    ports:
      - 8090:8090
    restart: unless-stopped

qBittorrent < 5.2.0:

services:
  qbittorrent-exporter:
    image: ghcr.io/martabal/qbittorrent-exporter:latest
    container_name: qbittorrent-exporter
    environment:
      - QBITTORRENT_BASE_URL=http://192.168.1.10:8080
      - QBITTORRENT_PASSWORD='<your_password>'
      - QBITTORRENT_USERNAME=admin
    ports:
      - 8090:8090
    restart: unless-stopped

git clone https://github.com/martabal/qbittorrent-exporter.git
cd qbittorrent-exporter
go build -o ./qbittorrent-exporter
./qbittorrent-exporter

or

git clone https://github.com/martabal/qbittorrent-exporter.git
cd qbittorrent-exporter
go run .

If you want to use an .env file, edit .env.example to match your setup, rename it .env then run it in the same directory. If you want to force to use the environment variables use -e argument like :

./qbittorrent-exporter -e

or

go run . -e

You can find in the dashboard the following metrics:

• All time download/upload
• Session download/upload
• Cumulative upload/download speeds
• Global ratio/download speed/upload speed
• qBittorrent version
• Torrent list with statuses
• Total torrents/seeders/leechers
• Torrent state chart
• Amount remaining by torrent
• Incomplete torrent progress
• Download/upload speed by torrent
• Categories
• Tags
• Trackers

This app uses ~20 times less RAM compared to the original exporter for the same amount of torrents. Docker compressed size is ~10 MB.

For qBittorrent >= 5.2.0, you must specify either QBITTORRENT_API_KEY or QBITTORRENT_COOKIE_NAME.

Add the target to your scrape_configs in your prometheus.yml file of your Prometheus instance.

scrape_configs:
  - job_name: "qbittorrent"
    static_configs:
      - targets: ["<your_ip_address>:8090"]

Contributions are welcome! To get started, copy and rename the .env.example file to .env, and run just dev from the root directory.