Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/WillFantom/overseerr-exporter
Prometheus exporter for the Overseerr media requests management tool
https://github.com/WillFantom/overseerr-exporter
overseerr prometheus prometheus-exporter
Last synced: about 2 months ago
JSON representation
Prometheus exporter for the Overseerr media requests management tool
- Host: GitHub
- URL: https://github.com/WillFantom/overseerr-exporter
- Owner: WillFantom
- License: gpl-3.0
- Created: 2021-05-06T19:50:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-19T21:07:09.000Z (11 months ago)
- Last Synced: 2024-06-21T15:31:11.679Z (3 months ago)
- Topics: overseerr, prometheus, prometheus-exporter
- Language: Go
- Homepage:
- Size: 525 KB
- Stars: 20
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Overseerr Exporter  
Export media request data from an [Oversseerr](https://overseerr.dev) instance to a [Prometheus](https://prometheus.io) instance.
---
## Usage
```bash
docker run --rm -p 9850:9850 ghcr.io/willfantom/overseerr-exporter:latest \
"--overseerr.address=https://overseerr.example.com" \
"--overseerr.api-key=examplesecretapikey"
```
---
### Dashboard
---
## Exporter Metrics
Two main metric groups are exported: Requests and Users.
#### Requests
The requests on the Overseerr server are counted. Request counts have the following labels:
| Label | Description | Configurable |
| :--------------- | :----------------------------------------------------: | -----------: |
| `request_status` | The approval status for the requests (e.g. Approved) | no |
| `media_status` | The media status for requested items (e.g. Available) | no |
| `media_type` | The category of request media (e.g. movie) | no |
| `is_4k` | Requested on a 4k tagged service (e.g. true) | no |
| `genre` | The main genre for a requested media item | yes |
| `company` | The production company or network for a requested item | yes |
> ⚠️ Collecting Genre/Company info can take a lot of time with large request quantities
#### Users
User request counts of an Overseerr server are collected with the following labels:
| Label | Description | Configurable |
| :------ | :---------------------------: | -----------: |
| `email` | The email address of the user | no |
## Configuration
| Flag | Description | Default |
| :--------------------------- | :-----------------------------------------: | :--------- |
| `log` | Sets the logging level for the exporter | `fatal` |
| `web.listen-address` | The address for the exporter to listen on | `:9850` |
| `web.telemetry-path` | The path to expose the metrics | `/metrics` |
| `overseerr.address` | The URI of the Overseerr instance | |
| `overseerr.api-key` | The admin API key of the Overseerr instance | |
| `overseerr.locale` | The locale of the Overseerr instance | `en` |
| `overseerr.scrape.genres` | Collect genre information for requests | `true` |
| `overseerr.scrape.companies` | Collect company information for requests | `true` |
You **must** provide the Overseerr address and API key!
---
## Build the Container
```bash
docker build --rm -f Dockerfile \
--build-arg EXPORTER_VERSION=local \
-t overseerr-exporter:latest .
```
---
### TODO
- Improve dashboard (more graphs!)
- Export version metrics
- Include issue counters