Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/martabal/qbittorrent-exporter

A fast and lightweight prometheus exporter for qBittorrent
https://github.com/martabal/qbittorrent-exporter

dashboard exporter go grafana metrics prometheus qbittorrent

Last synced: 18 days ago
JSON representation

A fast and lightweight prometheus exporter for qBittorrent

Host: GitHub
URL: https://github.com/martabal/qbittorrent-exporter
Owner: martabal
License: mit
Created: 2023-01-27T01:52:50.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-10-07T18:00:35.000Z (29 days ago)
Last Synced: 2024-10-08T15:56:10.908Z (29 days ago)
Topics: dashboard, exporter, go, grafana, metrics, prometheus, qbittorrent
Language: Go
Homepage:
Size: 958 KB
Stars: 17
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# qbittorrent-exporter

[![Publish Release](https://github.com/martabal/qbittorrent-exporter/actions/workflows/docker.yml/badge.svg)](https://github.com/martabal/qbittorrent-exporter/actions/workflows/docker.yml)
[![Build](https://github.com/martabal/qbittorrent-exporter/actions/workflows/build.yml/badge.svg)](https://github.com/martabal/qbittorrent-exporter/actions/workflows/build.yml)
[![Test](https://github.com/martabal/qbittorrent-exporter/actions/workflows/test.yml/badge.svg)](https://github.com/martabal/qbittorrent-exporter/actions/workflows/test.yml)

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

## Credits

I was using an excellent [exporter](https://github.com/caseyscarborough/qbittorrent-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.

## About this App

This app is a lightweight and fast prometheus exporter for qBittorrent, made to be integrated with the [qbittorrent-grafana-dashboard](https://raw.githubusercontent.com/martabal/qbittorrent-exporter/main/grafana/dashboard.json).

## Run it

### Docker-cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))

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

### Docker-compose

```yaml
version: "2.1"
services:
immich:
image: ghcr.io/martabal/qbittorrent-exporter:latest
container_name: qbittorrent-exporter
environment:
- QBITTORRENT_BASE_URL=http://192.168.1.10:8080
- QBITTORRENT_PASSWORD=''
- QBITTORRENT_USERNAME=admin
ports:
- 8090:8090
restart: unless-stopped
```

### Without docker

```sh
git clone https://github.com/martabal/qbittorrent-exporter.git
cd qbittorent-exporter
go get -d -v
cd src
go build -o ./qbittorrent-exporter
./qbittorrent-exporter
```

```sh
git clone https://github.com/martabal/qbittorrent-exporter.git
cd qbittorent-exporter
go get -d -v
cd src
go run ./src
```

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 :

```sh
./qbittorrent-exporter -e
```

```sh
go run ./src -e
```

## Metrics

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

## Resources

This app uses ~20 times less RAM compared to the [original exporter](https://github.com/caseyscarborough/qbittorrent-exporter) for the same amount of torrents.
Docker compressed size is ~10 MB.

## Dashboard

![grafana-top](img/grafana-1.png)
![grafana-bottom](img/grafana-2.png)

## Parameters

### Environment variables

| Parameters | Function | Default Value |
| :-----------------------: | ----------------------------------------------------------- | ----------------------- |
| `-p 8090` | Webservice port | |
| `-e QBITTORRENT_USERNAME` | qBittorrent username | `admin` |
| `-e QBITTORRENT_PASSWORD` | qBittorrent password | `adminadmin` |
| `-e QBITTORRENT_BASE_URL` | qBittorrent base URL | `http://localhost:8090` |
| `-e QBITTORRENT_TIMEOUT` | duration before ending a request to qBittorrent | `30` |
| `-e EXPORTER_PORT` | qbittorrent export port (optional) | `8090` |
| `-e DISABLE_TRACKER` | get tracker infos (need an API request for each tracker) | `false` |
| `-e LOG_LEVEL` | App log level (`DEBUG`, `INFO`, `WARN` and `ERROR`) | `INFO` |
| `-e ENABLE_HIGH_CARDINALITY` | enable high cardinality metric (`qbittorrent_torrent_info`) | `false` |

### Arguments

| Arguments | Function |
| :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| -e | If qbittorrent-exporter detects a .env file in the same directory, the values in the .env will be used, `-e` forces the usage of environment variables |

### Setup

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

```yaml
scrape_configs:
- job_name: "qbittorrent"
static_configs:
- targets: [":8090"]
```