AIO Prometheus Exporter for Bazarr, Prowlarr, Lidarr, Readarr, Radarr, and Sonarr
Go to file
Devin Buhl a2a66246bd
fix: double slash on api requests when no urlbase is defined
Signed-off-by: Devin Buhl <devin@buhl.casa>
2021-12-03 09:49:11 -05:00
.github Update release.yml 2021-03-17 10:50:10 -04:00
cmd/exportarr fix: clean up login in client 2021-03-17 20:25:05 -04:00
examples docs: update readme and examples 2021-03-17 20:30:01 -04:00
internal fix: double slash on api requests when no urlbase is defined 2021-12-03 09:49:11 -05:00
.dockerignore fix alpine name 2021-03-13 11:45:39 -05:00
.gitignore feat: read apikey and urlbase from arr config.xml 2021-03-17 19:25:36 -04:00
Dockerfile chore(deps): update alpine docker tag to v3.15 2021-11-19 01:31:14 +00:00
go.mod chore: set go version to 1.17 and tidy 2021-12-03 08:56:36 -05:00
go.sum chore: set go version to 1.17 and tidy 2021-12-03 08:56:36 -05:00
LICENSE initial commit 2020-04-12 08:21:46 -04:00
README.md fix: add dashboard image to readme 2021-03-22 09:03:38 -04:00
renovate.json Add renovate.json 2021-03-17 13:21:32 +00:00

exportarr

AIO Prometheus Exporter for Sonarr, Radarr or Lidarr

Go Report Card

This is Prometheus Exporter will export metrics gathered from Sonarr, Radarr, or Lidarr. This only supports v1 API of Lidarr and 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.

image

Usage

Run with Docker Compose

See examples in the examples/compose directory

Run with Kubernetes

See examples in the examples/kubernetes directory.

This exporter is also included in the Lidarr, Radarr, and Sonarr helm charts located over at k8s-at-home/charts

Run with Docker CLI

Sonarr

docker run --name exportarr_sonarr \
  -e PORT=9707 \
  -e URL="http://192.168.1.1:8989" \
  -e APIKEY="amlmndfb503rfqaa5ln5hj5qkmu3hy18" \
  --restart unless-stopped \
  -p 9707:9707 \
  -d ghcr.io/onedr0p/exportarr:latest exportarr sonarr

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

Radarr

docker run --name exportarr_radarr \
  -e PORT=9708 \
  -e URL="http://192.168.1.1:7878" \
  -e APIKEY="zmlmndfb503rfqaa5ln5hj5qkmu3hy19" \
  --restart unless-stopped \
  -p 9708:9708 \
  -d ghcr.io/onedr0p/exportarr:latest exportarr radarr

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

Lidarr

docker run --name exportarr_lidarr \
  -e PORT=9709 \
  -e URL="http://192.168.1.1:8686" \
  -e APIKEY="zmlmndfb503rfqaa5ln5hj5qkmu3hy19" \
  --restart unless-stopped \
  -p 9709:9709 \
  -d ghcr.io/onedr0p/exportarr:latest exportarr lidarr

Visit http://127.0.0.1:9709/metrics to see Lidarr metrics

Run from the CLI

go get github.com/onedr0p/exportarr

exportarr --help

Sonarr

./exportarr sonarr --help

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

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

Radarr

./exportarr radarr --help

./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

Lidarr

./exportarr lidarr --help

./exportarr lidarr \
  --port 9709 \
  --url http://127.0.0.1:8686 \
  --api-key amlmndfb503rfqaa5ln5hj5qkmu3hy18

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

Configuration

Environment Variable CLI Flag Description Default Required
PORT --port or -p The port exportarr will listen on
URL --url or -u The full URL to Sonarr, Radarr, or Lidarr
APIKEY --api-key or -a API Key for Sonarr, Radarr or Lidarr
CONFIG --config or -c Path to Sonarr, Radarr or Lidarr's config.xml (advanced)
INTERFACE --interface or -i The interface IP exportarr will listen on 0.0.0.0
LOG_LEVEL --log-level or -l Set the default Log Level INFO
DISABLE_SSL_VERIFY --disable-ssl-verify Set to true to disable SSL verification false
BASIC_AUTH_PASSWORD --basic-auth-password Set to your basic auth password
BASIC_AUTH_USERNAME --basic-auth-username Set to your basic auth username
ENABLE_ADDITIONAL_METRICS --enable-additional-metrics Set to true to enable gathering of additional metrics (slow) false
ENABLE_UNKNOWN_QUEUE_ITEMS --enable-unknown-queue-items Set to true to enable gathering unknown queue items false