eithan1231/immich-exporter

Immich Exporter Docker镜像文档

镜像概述

Immich Exporter是一个专为Immich服务设计的指标导出工具，能够收集Immich的核心运行指标并转换为Prometheus兼容格式，使Immich服务的监控可通过Prometheus和Grafana等工具实现。该镜像旨在简化Immich监控指标的采集流程，帮助用户实时掌握Immich服务的运行状态和性能表现。

核心功能和特性

• 指标收集：支持采集Immich的关键指标，包括用户数量、相册数量、媒体文件数量、存储使用量、API请求频率等核心业务指标。
• Prometheus兼容：导出的指标符合Prometheus数据格式标准，可直接被Prometheus抓取和存储。
• 轻量集成：镜像体积小巧，配置简单，易于集成到现有基于Prometheus的监控体系中。
• 灵活配置：支持通过环境变量或配置文件自定义指标采集频率、API连接参数等。

使用场景和适用范围

• Immich服务监控：适用于部署了Immich个人照片管理服务的用户，需监控服务健康状态、资源使用情况及业务指标。
• Prometheus监控体系：特别适合已使用Prometheus+Grafana构建监控系统的环境，可无缝接入现有监控面板。
• 性能分析：帮助管理员识别Immich服务的性能瓶颈，如存储增长趋势、API响应延迟等。

使用方法和配置说明

前置要求

• 运行中的Immich服务实例，并已获取API访问密钥（可在Immich设置中生成）。
• 运行中的Prometheus服务（用于抓取导出的指标）。

基本使用步骤

1. 获取镜像：从Docker Hub或其他镜像仓库拉取最新版本（具体仓库地址请参考项目GitHub）。

2. 配置参数：通过环境变量或挂载配置文件设置必要参数（详细参数说明见GitHub README），核心参数包括：

   • IMMICH_URL：Immich服务的访问地址（如http://immich-server:3001）。
   • IMMICH_API_KEY：Immich的API访问密钥。
   • EXPORTER_PORT：导出器监听端口（默认通常为9898）。
   • SCRAPE_INTERVAL：指标采集间隔（默认通常为30秒）。

3. 启动容器：通过docker run命令或docker-compose配置启动容器。

4. 验证指标：访问http://<容器IP>:<EXPORTER_PORT>/metrics，确认指标正常导出。

5. 配置Prometheus：在Prometheus配置文件中添加对该导出器的抓取任务。

Docker部署示例

docker run命令示例

bash
docker run -d \
  --name immich-exporter \
  -p 9898:9898 \
  -e IMMICH_URL="http://immich-server:3001" \
  -e IMMICH_API_KEY="your_immich_api_key_here" \
  -e EXPORTER_PORT=9898 \
  -e SCRAPE_INTERVAL=30 \
  eithan1231/immich-exporter:latest

docker-compose配置示例

yaml
version: '3.8'
services:
  immich-exporter:
    image: eithan1231/immich-exporter:latest
    container_name: immich-exporter
    ports:
      - "9898:9898"
    environment:
      - IMMICH_URL=http://immich-server:3001
      - IMMICH_API_KEY=your_immich_api_key_here
      - EXPORTER_PORT=9898
      - SCRAPE_INTERVAL=30
    restart: unless-stopped

详细文档参考

完整的配置参数、指标列表、故障排除及高级用法，请参考项目GitHub README：
https://github.com/eithan1231/immich-exporter