https://github.com/kafisatz/qbittorrentstats.jl

A tool to write qBittorrent statistics (upload, download) to InfluxDB
https://github.com/kafisatz/qbittorrentstats.jl

julia julia-language qbittorrent statistics stats webui

Last synced: 4 days ago
JSON representation

A tool to write qBittorrent statistics (upload, download) to InfluxDB

• Host: GitHub
• URL: https://github.com/kafisatz/qbittorrentstats.jl
• Owner: kafisatz
• License: mit
• Created: 2023-10-05T15:18:24.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-03-12T15:53:01.000Z (7 months ago)
• Last Synced: 2024-09-29T07:42:55.081Z (4 days ago)
• Topics: julia, julia-language, qbittorrent, statistics, stats, webui
• Language: Julia
• Homepage:
• Size: 179 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# qBittorrentStats

[![Build Status](https://github.com/kafisatz/qBittorrentStats.jl/actions/workflows/CI.yml/badge.svg?branch=master)](https://github.com/kafisatz/qBittorrentStats.jl/actions/workflows/CI.yml?query=branch%3Amaster)

## Purpose

* Gathers upload and download information (per torrent) from a qBittorrent client via WebUI API (https://github.com/qbittorrent/qBittorrent/wiki/#webui-api)

* Data is written to InfluxDBv2

## Requirements 

* InfluxDBv2 instance 

* A qBittorrent client with WebUI API enabled. I think this is usually the case when you have the WebUI enabled.

## Limitations 

* For me this is currently not working when I use a https URL (reverse proxy). Instead I am using the IP of the client

## Grafana Dashboard

* see [grafana_dashboard.json](graphana_dashboard.json) and [dashboard.png](img/dashboard.png)

## Usage

```julia

#you should make sure that https://github.com/kafisatz/InfluxDBClient.jl works properly for you

#see https://github.com/kafisatz/InfluxDBClient.jl#configuration

using InfluxDBClient

isettings = get_settings()

#check if the InfluxDB is reachable

bucket_names, json = get_buckets(isettings);

#if the above works, proceed as follows

using qBittorrentStats

#URL of the WebUI; this should show the Web UI login page of qBittorrent

baseurl = "http://10.14.15.205:8080"

#credentials and settins for InfluxDB

influxdbsettings = InfluxDBClient.get_settings()

#a bucket name in InfluxDB

#Make sure this bucket is first created. Otherwise you will get a warning message and no data will be written

influxdbbucketname = "qBittorrentStats"

#there is a single function which gathers the data from qBittorrent and writes it to InfluxDB

@time cookieDict,lastactivitydf = writestats(baseurl,influxdbbucketname,influxdbsettings)

#the data is gathered via https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-torrent-generic-properties

#see the property list on that page

#Notably only a subset of the properties is written to InfluxDB as the motivation for this package was upload and download volumes to manage storage tiering (and deletion) of torrents

```