Repolode
Submit
thecfu

thecfu/scraparr

A Prometheus exporter that scrapes the *arr suite (Sonarr, Radarr, Lidarr, etc.) so their health and performance can be monitored and graphed.

View on GitHub
Stars
426
Forks
18
Open issues
0
Last commit
2 months ago

What is it?

Scraparr is a Prometheus exporter for the *arr suite of media management applications such as Sonarr, Radarr and Lidarr. It polls the APIs of these services and exposes the results as metrics on an HTTP endpoint (port 7100 by default), which Prometheus can scrape and Grafana can chart.

Configuration is done through a config.yaml file or environment variables, with each service specifying its URL and API key. Multiple instances of the same service are supported by giving each one an alias so their metrics do not overwrite each other. API keys can also be loaded from Docker secret files.

The project is distributed as a Docker image on GitHub Container Registry and Docker Hub, and can also be run directly with Python. A community-maintained Helm chart and Unraid template are available, and a Grafana dashboard is published for the metrics.

Key features

  • 01Exposes *arr service metrics in Prometheus format on port 7100 by default
  • 02Supports multiple instances of the same service via aliases
  • 03Configurable through config.yaml or environment variables
  • 04Reads API keys from Docker secret files
  • 05Available as a Docker image and runnable with Python

Use cases

  • Monitoring the health and activity of Sonarr, Radarr and Lidarr with Prometheus and Grafana
  • Tracking several *arr instances in one monitoring stack by using aliases
  • Deploying the exporter alongside a media server stack with Docker Compose or Kubernetes

Quick start

  1. 1

    Create a config.yaml with your *arr service URLs and API keys

  2. 2

    Run the Docker image from the GitHub Registry and expose port 7100

    docker run -v ./config.yaml:/scraparr/config/config.yaml -p 7100:7100 ghcr.io/thecfu/scraparr

Things to know

  • Licensed under GPL-3.0, a copyleft license that requires derivative works to remain open source.
  • Main development has moved to Codeberg, so issues and contributions should go there.
  • When running in Docker, you must use the host IP or configure the host.docker.internal:host-gateway extra host to reach services on the host.

In collections

OpenTelemetry & observability platforms

Topics

#prometheus#monitoring#metrics#sonarr#radarr#lidarr#grafana#exporter#giveupgithub

FAQ

What is scraparr?
A Prometheus exporter that scrapes the *arr suite (Sonarr, Radarr, Lidarr, etc.) so their health and performance can be monitored and graphed. Scraparr is a Prometheus exporter for the *arr suite of media management applications such as Sonarr, Radarr and Lidarr. It polls the APIs of these services and exposes the results as metrics on an HTTP endpoint (port 7100 by default), which Prometheus can scrape and Grafana can chart.
Is scraparr free to use? What license does it have?
scraparr is open source under the GPL-3.0 license. Check the license terms before using it in commercial products.
Is scraparr still maintained?
Updated within 6 months. The last commit to scraparr was on Aug 26, 2026.
What can I use scraparr for?
Monitoring the health and activity of Sonarr, Radarr and Lidarr with Prometheus and Grafana Tracking several *arr instances in one monitoring stack by using aliases Deploying the exporter alongside a media server stack with Docker Compose or Kubernetes
How do I install scraparr?
Create a config.yaml with your *arr service URLs and API keys Run the Docker image from the GitHub Registry and expose port 7100: docker run -v ./config.yaml:/scraparr/config/config.yaml -p 7100:7100 ghcr.io/thecfu/scraparr
Where can I get scraparr?
The source code and installation instructions are on GitHub: https://github.com/thecfu/scraparr

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects