mirror of
https://github.com/onedr0p/exportarr.git
synced 2026-02-06 10:57:32 +00:00
chore: update readme
Signed-off-by: Devin Buhl <devin@buhl.casa>
This commit is contained in:
Devin Buhl
parent
edd2536e6b
commit
fd93268bf3
177
README.md
177
README.md
@ -1,185 +1,56 @@
|
||||
# exportarr
|
||||
|
||||
AIO Prometheus Exporter for Sonarr, Radarr or Lidarr
|
||||
AIO Prometheus Exporter for Sonarr, Radarr, Lidarr, Prowlarr, Readarr, and Sabnzbd
|
||||
|
||||
[](https://goreportcard.com/report/github.com/onedr0p/exportarr)
|
||||
|
||||
This is Prometheus Exporter will export metrics gathered from Sonarr,
|
||||
Radarr, Lidarr, Prowlarr, and Readarr (experimental). This only supports v1 API of Lidarr, Prowlarr, and Readarr
|
||||
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.
|
||||
Note: This exporter will not gather metrics from all apps at once, and instead you an `exportarr` instance for each app. Be sure to see the examples below for more information.
|
||||
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
### Run with Docker Compose
|
||||
### Docker Compose
|
||||
|
||||
See examples in the [examples/compose](./examples/compose/) directory
|
||||
See examples in the [examples/compose](./examples/compose/) directory.
|
||||
|
||||
### Run with Kubernetes
|
||||
### Kubernetes
|
||||
|
||||
See examples in the [examples/kubernetes](./examples/kubernetes/)
|
||||
directory.
|
||||
See examples in the [examples/kubernetes](./examples/kubernetes/) directory.
|
||||
|
||||
This exporter is also included in the Lidarr, Radarr, Sonarr, and Prowlarr helm
|
||||
charts located over at
|
||||
[k8s-at-home/charts](https://github.com/k8s-at-home/charts)
|
||||
### Docker CLI
|
||||
|
||||
### Run with Docker CLI
|
||||
_Replace `$app`, `$port` and `$apikey` with one of the support apps, port and api key_
|
||||
|
||||
#### Sonarr
|
||||
```bash
|
||||
docker run --name exportarr_sonarr \
|
||||
```sh
|
||||
# PORT must be unique across all exportarr instances
|
||||
docker run --name exportarr_$app \
|
||||
-e PORT=9707 \
|
||||
-e URL="http://x.x.x.x:8989" \
|
||||
-e APIKEY="amlmndfb503rfqaa5ln5hj5qkmu3hy18" \
|
||||
-e URL="http://x.x.x.x:$port" \
|
||||
-e APIKEY="$apikey" \
|
||||
--restart unless-stopped \
|
||||
-p 9707:9707 \
|
||||
-d ghcr.io/onedr0p/exportarr:latest sonarr
|
||||
-d ghcr.io/onedr0p/exportarr:latest $app
|
||||
```
|
||||
|
||||
Visit http://127.0.0.1:9707/metrics to see Sonarr metrics
|
||||
Visit http://127.0.0.1:9707/metrics to see the app metrics
|
||||
|
||||
#### Radarr
|
||||
### CLI
|
||||
|
||||
```bash
|
||||
docker run --name exportarr_radarr \
|
||||
-e PORT=9708 \
|
||||
-e URL="http://x.x.x.x:7878" \
|
||||
-e APIKEY="zmlmndfb503rfqaa5ln5hj5qkmu3hy19" \
|
||||
--restart unless-stopped \
|
||||
-p 9708:9708 \
|
||||
-d ghcr.io/onedr0p/exportarr:v1.0.0 radarr
|
||||
```
|
||||
|
||||
Visit http://127.0.0.1:9708/metrics to see Radarr metrics
|
||||
|
||||
#### Lidarr
|
||||
|
||||
```bash
|
||||
docker run --name exportarr_lidarr \
|
||||
-e PORT=9709 \
|
||||
-e URL="http://x.x.x.x:8686" \
|
||||
-e APIKEY="zmlmndfb503rfqaa5ln5hj5qkmu3hy19" \
|
||||
--restart unless-stopped \
|
||||
-p 9709:9709 \
|
||||
-d ghcr.io/onedr0p/exportarr:v1.0.0 lidarr
|
||||
```
|
||||
|
||||
Visit http://127.0.0.1:9709/metrics to see Lidarr metrics
|
||||
|
||||
#### Prowlarr
|
||||
|
||||
```bash
|
||||
docker run --name exportarr_prowlarr \
|
||||
-e PORT=9710 \
|
||||
-e URL="http://x.x.x.x:9696" \
|
||||
-e APIKEY="zmlmndfb503rfqaa5ln5hj5qkmu3hy19" \
|
||||
--restart unless-stopped \
|
||||
-p 9710:9710 \
|
||||
-d ghcr.io/onedr0p/exportarr:v1.0.0 prowlarr
|
||||
```
|
||||
|
||||
Visit http://127.0.0.1:9710/metrics to see Prowlarr metrics
|
||||
|
||||
### Readarr (Experimental)
|
||||
|
||||
```bash
|
||||
docker run --name exportarr_readarr \
|
||||
-e PORT=9711 \
|
||||
-e URL="http://x.x.x.x:9797" \
|
||||
-e APIKEY="zmlmndfb503rfqaa5ln5hj5qkmu3hy19" \
|
||||
--restart unless-stopped \
|
||||
-p 9711:9711 \
|
||||
-d ghcr.io/onedr0p/exportarr:v1.0.0 readarr
|
||||
```
|
||||
|
||||
Visit http://127.0.0.1:9711/metrics to see Readarr metrics
|
||||
### Run from the CLI
|
||||
|
||||
#### Sonarr
|
||||
_Replace `$app`, `$port` and `$apikey` with one of the support apps, port and api key_
|
||||
|
||||
```sh
|
||||
./exportarr sonarr --help
|
||||
./exportarr $app --help
|
||||
|
||||
./exportarr sonarr \
|
||||
# --port must be unique across all exportarr instances
|
||||
./exportarr $app \
|
||||
--port 9707 \
|
||||
--url http://x.x.x.x:8989 \
|
||||
--api-key amlmndfb503rfqaa5ln5hj5qkmu3hy18
|
||||
--url "http://x.x.x.x:$port" \
|
||||
--api-key "$apikey"
|
||||
```
|
||||
|
||||
Visit http://127.0.0.1:9707/metrics to see Sonarr metrics
|
||||
Visit http://127.0.0.1:9707/metrics to see the app metrics
|
||||
|
||||
#### Radarr
|
||||
|
||||
```sh
|
||||
./exportarr radarr --help
|
||||
|
||||
./exportarr radarr \
|
||||
--port 9708 \
|
||||
--url http://x.x.x.x:7878 \
|
||||
--api-key amlmndfb503rfqaa5ln5hj5qkmu3hy18
|
||||
```
|
||||
|
||||
Visit http://127.0.0.1:9708/metrics to see Radarr metrics
|
||||
|
||||
#### Lidarr
|
||||
|
||||
```sh
|
||||
./exportarr lidarr --help
|
||||
|
||||
./exportarr lidarr \
|
||||
--port 9709 \
|
||||
--url http://x.x.x.x:8686 \
|
||||
--api-key amlmndfb503rfqaa5ln5hj5qkmu3hy18
|
||||
```
|
||||
|
||||
Visit http://127.0.0.1:9709/metrics to see Radarr metrics
|
||||
|
||||
#### Prowlarr
|
||||
|
||||
```sh
|
||||
./exportarr prowlarr --help
|
||||
|
||||
./exportarr prowlarr \
|
||||
--port 9710 \
|
||||
--url http://x.x.x.x:9696 \
|
||||
--api-key amlmndfb503rfqaa5ln5hj5qkmu3hy18 \
|
||||
--backfill \
|
||||
--backfill-since-date 2023-03-01
|
||||
```
|
||||
|
||||
Backfill options are optional.
|
||||
|
||||
Visit http://127.0.0.1:9710/metrics to see Prowlarr metrics
|
||||
|
||||
#### Readarr (Experimental)
|
||||
|
||||
```sh
|
||||
./exportarr readarr --help
|
||||
|
||||
./exportarr readarr \
|
||||
--port 9711 \
|
||||
--url http://x.x.x.x:9696 \
|
||||
--api-key amlmndfb503rfqaa5ln5hj5qkmu3hy18
|
||||
```
|
||||
|
||||
Visit http://127.0.0.1:9711/metrics to see Readarr metrics
|
||||
|
||||
#### SabnzbD
|
||||
|
||||
```sh
|
||||
./exportarr sabnzbd --help
|
||||
|
||||
./exportarr sabnzbd \
|
||||
--port 9712 \
|
||||
--url http://x.x.x.x:9696 \
|
||||
--api-key amlmndfb503rfqaa5ln5hj5qkmu3hy18
|
||||
```
|
||||
|
||||
Visit http://127.0.0.1:9712/metrics
|
||||
## Configuration
|
||||
|
||||
| Environment Variable | CLI Flag | Description | Default | Required |
|
||||
@ -208,4 +79,4 @@ To backill all Prowlarr Data, either use `PROWLARR__BACKFILL` or `--backfill`.
|
||||
|
||||
Note that the first request can be extremely slow, depending on how long your prowlarr instance has been running. You can also specify a start date to limit the backfill if the backfill is timing out:
|
||||
|
||||
`PROWLARR__BACKFILL_DATE_SINCE=2023-03-01` or `--backfill-date-since=2023-03-01`
|
||||
`PROWLARR__BACKFILL_DATE_SINCE=2023-03-01` or `--backfill-date-since=2023-03-01`
|
||||
|
||||
Loading…
Reference in New Issue
Block a user