hub / github.com/caseyscarborough/qbittorrent-exporter

github.com/caseyscarborough/qbittorrent-exporter @v1.3.5

Chat with this repo

repository ↗ · DeepWiki ↗ · release v1.3.5 ↗ · + Follow

501 symbols 621 edges 11 files 1 documented · 0% ● updated 2y agov1.3.5 · 2023-10-23★ 11013 open issues

Browse by type

⨍ Functions 490◇ Types & classes 11

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

qbittorrent-exporter

This app is a Prometheus exporter for the qBittorrent application. You must have version 4.1.0 of qBittorrent or higher for this plugin to work.

This is especially useful when integrated with the qbittorrent-grafana-dashboard.

See it on DockerHub.

Usage

docker

docker run \
    --name=qbittorrent-exporter \
    -e QBITTORRENT_USERNAME=username \
    -e QBITTORRENT_PASSWORD=password \
    -e QBITTORRENT_BASE_URL=http://localhost:8080 \
    -p 17871:17871 \
    caseyscarborough/qbittorrent-exporter:latest

Parameters

Parameter	Function	Default Value
`-p 17871`	The webservice port.	N/A
`-e QBITTORRENT_USERNAME`	The qBittorrent username.	`admin`
`-e QBITTORRENT_PASSWORD`	The qBittorrent password.	`adminadmin`
`-e QBITTORRENT_BASE_URL`	The qBittorrent base URL.	`http://localhost:8080`
`-e QBITTORRENT_HOST`	The qBittorrent host. Ignored when using `QBITTORRENT_BASE_URL`.	`localhost`
`-e QBITTORRENT_PORT`	The qBittorrent port. Ignored when using `QBITTORRENT_BASE_URL`.	`8080`
`-e QBITTORRENT_PROTOCOL`	The qBittorrent protocol. Ignored when using `QBITTORRENT_BASE_URL`.	`http`

Setup

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

scrape_configs:

  - job_name: 'qbittorrent'
    static_configs:

      # Update your IP address and port here
      - targets: [ '192.168.1.100:17871' ]

Building Locally

Build the app and the docker container using the following commands:

./gradlew build
docker build .

Extension points exported contracts — how you extend this code

QbtMetrics (Interface)

(no doc) [2 implementers]

src/main/java/qbittorrent/exporter/collector/QbtMetrics.java

Core symbols most depended-on inside this repo

getName

called by 15

src/main/java/qbittorrent/api/model/Torrent.java

getEnvironment

called by 6

src/main/java/qbittorrent/exporter/Application.java

getRequest

called by 4

src/main/java/qbittorrent/api/ApiClient.java

getVersion

called by 2

src/main/java/qbittorrent/api/ApiClient.java

getAmountLeft

called by 2

src/main/java/qbittorrent/api/model/Torrent.java

getNumSeeds

called by 2

src/main/java/qbittorrent/api/model/Torrent.java

getEta

called by 2

src/main/java/qbittorrent/api/model/Torrent.java

getNumLeechs

called by 2

src/main/java/qbittorrent/api/model/Torrent.java

Shape

Method 490

Class 10

Interface 1

Languages

Java100%

Modules by API surface

src/main/java/qbittorrent/api/model/Preferences.java268 symbols

src/main/java/qbittorrent/api/model/Torrent.java88 symbols

src/main/java/qbittorrent/api/model/ServerState.java50 symbols

src/main/java/qbittorrent/exporter/collector/QbtCollector.java37 symbols

src/main/java/qbittorrent/exporter/collector/QbtMetrics.java35 symbols

src/main/java/qbittorrent/api/ApiClient.java8 symbols

src/main/java/qbittorrent/api/model/MainData.java4 symbols

src/main/java/qbittorrent/exporter/handler/QbtHttpHandler.java3 symbols

src/main/java/qbittorrent/exporter/Application.java3 symbols

src/main/java/qbittorrent/api/gson/LongTypeAdapter.java3 symbols

src/main/java/qbittorrent/api/ApiException.java2 symbols

For agents

$ claude mcp add qbittorrent-exporter \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

github.com/caseyscarborough/qbittorrent-exporter @v1.3.5

qbittorrent-exporter

Usage

docker

Parameters

Setup

Building Locally

Extension points exported contracts — how you extend this code

Core symbols most depended-on inside this repo

Shape

Languages

Modules by API surface

For agents

Ask about this repo answers extend the page