{"id":13620398,"url":"https://github.com/WillFantom/overseerr-exporter","last_synced_at":"2025-04-14T19:32:00.763Z","repository":{"id":52092813,"uuid":"365021326","full_name":"WillFantom/overseerr-exporter","owner":"WillFantom","description":"Prometheus exporter for the Overseerr media requests management tool","archived":false,"fork":false,"pushed_at":"2023-10-19T21:07:09.000Z","size":538,"stargazers_count":25,"open_issues_count":3,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-08T06:41:38.790Z","etag":null,"topics":["overseerr","prometheus","prometheus-exporter"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WillFantom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-05-06T19:50:38.000Z","updated_at":"2024-10-31T18:51:21.000Z","dependencies_parsed_at":"2024-02-26T00:44:22.654Z","dependency_job_id":null,"html_url":"https://github.com/WillFantom/overseerr-exporter","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WillFantom%2Foverseerr-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WillFantom%2Foverseerr-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WillFantom%2Foverseerr-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WillFantom%2Foverseerr-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WillFantom","download_url":"https://codeload.github.com/WillFantom/overseerr-exporter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248945985,"owners_count":21187422,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["overseerr","prometheus","prometheus-exporter"],"created_at":"2024-08-01T21:00:55.364Z","updated_at":"2025-04-14T19:31:58.720Z","avatar_url":"https://github.com/WillFantom.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# Overseerr Exporter    ![GitHub release (latest SemVer)](https://img.shields.io/github/v/tag/willfantom/overseerr-exporter?display_name=tag\u0026label=%20\u0026sort=semver)  ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/willfantom/overseerr-exporter/release.yml?label=%20\u0026logo=github)\n\nExport media request data from an [Oversseerr](https://overseerr.dev) instance to a [Prometheus](https://prometheus.io) instance.\n\n---\n\n## Usage\n\n```bash\ndocker run --rm -p 9850:9850 ghcr.io/willfantom/overseerr-exporter:latest \\\n  \"--overseerr.address=https://overseerr.example.com\" \\\n  \"--overseerr.api-key=examplesecretapikey\"\n```\n\n---\n\n### Dashboard\n\n![example-dash](./grafana/dashboard.png)\n\n---\n\n## Exporter Metrics\n\nTwo main metric groups are exported: Requests and Users.\n\n#### Requests\n\nThe requests on the Overseerr server are counted. Request counts have the following labels:\n\n| Label            |                      Description                       | Configurable |\n| :--------------- | :----------------------------------------------------: | -----------: |\n| `request_status` |  The approval status for the requests (e.g. Approved)  |           no |\n| `media_status`   | The media status for requested items (e.g. Available)  |           no |\n| `media_type`     |       The category of request media (e.g. movie)       |           no |\n| `is_4k`          |      Requested on a 4k tagged service (e.g. true)      |           no |\n| `genre`          |       The main genre for a requested media item        |          yes |\n| `company`        | The production company or network for a requested item |          yes |\n\n\u003e ⚠️  Collecting Genre/Company info can take a lot of time with large request quantities\n\n#### Users\n\nUser request counts of an Overseerr server are collected with the following labels:\n\n| Label   |          Description          | Configurable |\n| :------ | :---------------------------: | -----------: |\n| `email` | The email address of the user |           no |\n\n\n## Configuration\n\n| Flag                         |                 Description                 | Default    |\n| :--------------------------- | :-----------------------------------------: | :--------- |\n| `log`                        |   Sets the logging level for the exporter   | `fatal`    |\n| `web.listen-address`         |  The address for the exporter to listen on  | `:9850`    |\n| `web.telemetry-path`         |       The path to expose the metrics        | `/metrics` |\n| `overseerr.address`          |      The URI of the Overseerr instance      |            |\n| `overseerr.api-key`          | The admin API key of the Overseerr instance |            |\n| `overseerr.locale`           |    The locale of the Overseerr instance     | `en`       |\n| `overseerr.scrape.genres`    |   Collect genre information for requests    | `true`     |\n| `overseerr.scrape.companies` |  Collect company information for requests   | `true`     |\n\nYou **must** provide the Overseerr address and API key!\n\n---\n\n## Build the Container\n\n```bash\ndocker build --rm -f Dockerfile \\\n  --build-arg EXPORTER_VERSION=local \\\n  -t overseerr-exporter:latest .\n```\n\n---\n\n### TODO\n\n - Improve dashboard (more graphs!)\n - Export version metrics\n - Include issue counters\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWillFantom%2Foverseerr-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FWillFantom%2Foverseerr-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWillFantom%2Foverseerr-exporter/lists"}