Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/martabal/immich-exporter
Export your Immich stats to your prometheus instance
https://github.com/martabal/immich-exporter
Last synced: about 2 months ago
JSON representation
Export your Immich stats to your prometheus instance
- Host: GitHub
- URL: https://github.com/martabal/immich-exporter
- Owner: martabal
- License: mit
- Created: 2023-02-10T19:48:02.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-13T18:55:51.000Z (8 months ago)
- Last Synced: 2024-03-13T19:40:04.673Z (8 months ago)
- Language: Go
- Homepage:
- Size: 396 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# immich-exporter
[](https://github.com/martabal/immich-exporter/actions/workflows/docker.yml)
[](https://github.com/martabal/immich-exporter/actions/workflows/build.yml)
[](https://github.com/martabal/immich-exporter/actions/workflows/test.yml)
This app is a Prometheus exporter for immich.
This app is made to be integrated with the [immich-grafana-dashboard](https://github.com/martabal/immich-exporter/blob/main/grafana/dashboard.json)
## Run it
Create an API key in your Immich settings and set `IMMICH_API_KEY` to is value.
### Docker-cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
```sh
docker run --name=immich-exporter \
-e IMMICH_BASE_URL=http://192.168.1.10:8080 \
-e IMMICH_API_KEY= \
-p 8090:8090 \
ghcr.io/martabal/immich-exporter
```
### Docker-compose
```yaml
version: "2.1"
services:
immich:
image: ghcr.io/martabal/immich-exporter:latest
container_name: immich-exporter
environment:
- IMMICH_BASE_URL=http://192.168.1.10:8080
- IMMICH_API_KEY=
ports:
- 8090:8090
restart: unless-stopped
```
### Without docker
```sh
git clone https://github.com/martabal/immich-exporter.git
cd immich-exporter/
go get -d -v
cd src
go build -o ./immich-exporter
./immich-exporter
```
If you want to use an .env file, edit `.env.example` to match your setup, rename it `.env` then run it with :
```sh
./immich-exporter -e
```
## Parameters
### Environment variables
| Parameters | Function | Default Value |
| :------------------: | :-------------------------------------------------: | :-----------: |
| `-p 8090` | Webservice port | |
| `-e IMMICH_BASE_URL` | Immich base URL | |
| `-e IMMICH_API_KEY` | Immich API key | |
| `-e EXPORTER_PORT` | qbittorrent export port (optional) | `8090` |
| `-e LOG_LEVEL` | App log level (`DEBUG`, `INFO`, `WARN` and `ERROR`) | `INFO` |
### Arguments
| Arguments | Function |
| :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| -e | If qbittorrent-exporter detects a .env file in the same directory, the values in the .env will be used, `-e` forces the usage of environment variables |
### Setup
Add the target to your `scrape_configs` in your `prometheus.yml` file of your Prometheus instance.
```yaml
scrape_configs:
- job_name: 'immich'
static_configs:
- targets: [ ':8090' ]
```