Giter Club home page Giter Club logo

exportarr's Introduction

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

exportarr's People

Contributors

ichabond avatar kinduff avatar lutzky avatar onedr0p avatar renovate-bot avatar talziv avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.