artin/exportarr
1
0
Fork 0
mirror of https://github.com/onedr0p/exportarr.git synced 2026-02-06 10:57:32 +00:00
Code Issues Packages Projects Releases Wiki Activity
AIO Prometheus Exporter for Bazarr, Prowlarr, Lidarr, Readarr, Radarr, and Sonarr
31 Commits 5 Branches 40 Tags 9.1 MiB
Go 98.5%
Python 0.8%
Dockerfile 0.5%
Makefile 0.2%
68c264e33c
Go to file
Devin Buhl 68c264e33c add sonarr missing metric
2020-08-26 10:05:24 -04:00
.github/workflows move args to serive subcommands 2020-04-13 13:00:08 -04:00
build/package add port back 2020-05-04 18:28:51 -04:00
cmd/exportarr implement enable-unknown-queue-items config option 2020-04-21 08:24:19 -04:00
examples Updated README and changed image tags in examples to master instead of latest. (#11) 2020-06-30 08:14:42 -04:00
internal add sonarr missing metric 2020-08-26 10:05:24 -04:00
.dockerignore initial commit 2020-04-12 08:21:46 -04:00
.gitignore initial commit 2020-04-12 08:21:46 -04:00
go.mod 🚀 2020-04-12 11:57:16 -04:00
go.sum 🚀 2020-04-12 11:57:16 -04:00
LICENSE initial commit 2020-04-12 08:21:46 -04:00
README.md Update README.md 2020-08-19 10:35:32 -04:00

README.md

exportarr

AIO Prometheus Exporter for Sonarr, Radarr or Lidarr(TBD)

Docker Pulls Go Report Card

This is Prometheus Exporter will export metrics gathered from Sonarr or Radarr. This only supports v3 APIs for Sonarr and Radarr. It will not gather metrics from all 3 at once, and instead you need to tell the exporter what metrics you want. Be sure to see the examples below for more information.

Usage

Run with Docker Compose

See examples in the examples/compose directory

Run with Kubernetes

See examples in the examples/kubernetes directory, or use the billimek-charts/sonarr or billimek-charts/radarr Helm charts.

Run with Docker CLI

Sonarr

sudo docker run --name exportarr_sonarr \
  --entrypoint "exportarr" \
  -e port=9707 \
  -e URL="http://192.168.1.1:8989" \
  -e APIKEY="amlmndfb503rfqaa5ln5hj5qkmu3hy18" \
  -e ENABLE_EPISODE_QUALITY_METRICS="false" \
  --restart unless-stopped \
  -p 9707:9707 \
  -d onedr0p/exportarr:master sonarr

Visit http://127.0.0.1:9707/metrics to see Sonarr metrics

Radarr

sudo docker run --name exportarr_radarr \
  --entrypoint "exportarr" \
  -e port=9708 \
  -e URL="http://192.168.1.1:7878" \
  -e APIKEY="amlmndfb503rfqaa5ln5hj5qkmu3hy18" \
  --restart unless-stopped \
  -p 9708:9708 \
  -d onedr0p/exportarr:master sonarr

Visit http://127.0.0.1:9708/metrics to see Radarr metrics

Run from the CLI

./exportarr --help
./exportarr sonarr --help
./exportarr radarr --help

Sonarr

./exportarr sonarr \
  --port 9707 \
  --url http://127.0.0.1:8989 \
  --api-key amlmndfb503rfqaa5ln5hj5qkmu3hy18 \
  --enable-episode-quality-metrics

Visit http://127.0.0.1:9707/metrics to see Sonarr metrics

Radarr

./exportarr radarr \
  --port 9708 \
  --url http://127.0.0.1:7878 \
  --api-key amlmndfb503rfqaa5ln5hj5qkmu3hy18

Visit http://127.0.0.1:9708/metrics to see Radarr metrics

Configuration

Environment Variable CLI Flag Description Default Required
Global
LOG_LEVEL --log-level or -l Set the default Log Level INFO ❌
Sonarr or Radarr
URL --url or -u The full URL to Sonarr or Radarr ✅
APIKEY --api-key or -a API Key for Sonarr or Radarr ✅
ENABLE_UNKNOWN_QUEUE_ITEMS --enable-unknown-queue-items Set to true to enable gathering unknown queue items in Queue metrics false ❌
BASIC_AUTH_ENABLED --basic-auth-enabled Set to true to enable Basic Auth false ❌
BASIC_AUTH_USERNAME --basic-auth-username Set to your username if enabled Basic Auth ❌
BASIC_AUTH_PASSWORD --basic-auth-password Set to your password if enabled Basic Auth ❌
DISABLE_SSL_VERIFY --disable-ssl-verify Set to true to disable SSL verification false ❌
PORT --port or -p The port the exporter will listen on ✅
INTERFACE --interface or -i The interface IP the exporter will listen on 0.0.0.0 ❌
Sonarr
ENABLE_EPISODE_QUALITY_METRICS --enable-episode-quality-metrics Set to true to enable gathering total episodes by qualities false ❌