Active development of this project has been retired in favor of ImmichStat

Prometheus Immich exporter

More info A prometheus exporter for Immich. Get metrics from a server and offers them in a prometheus format.

How to use it

Here is an example docker run command

docker run -e IMMICH_PORT=8080 -e IMMICH_HOST=192.168.178.1 -e IMMICH_API_TOKEN=YOUR_TOKEN_HERE -p 8000:8000 friendlyfriend/prometheus-immich-exporter

Or you can add the following to your immich docker-compose.yaml

  immich-exporter:
    image: friendlyfriend/prometheus-immich-exporter
    container_name: immich_exporter
    environment:
      - IMMICH_PORT=2283
      - IMMICH_HOST=immich-server
      - IMMICH_API_TOKEN=<TOKEN>
    ports:
      - 8000:8000
    restart: unless-stopped

Add this to your prometheus.yml

  - job_name: "immich_exporter"
    static_configs:
        - targets: ['yourimmichexporter:port']

In case if you run prometheus from the same docker-compose you can use this job

  - job_name: immich_exporter
    static_configs:
        - targets: ['immich-exporter:8000']

The application reads configuration using environment variables:

Metrics

These are the metrics this program exports, assuming the METRICS_PREFIX is immich:

Screenshot

More info

License

This software is released under the GPLv3 license.