ngosang/restic-exporter

ngosang/restic-exporter

Docker镜像源代码：https://github.com/ngosang/restic-exporter

https://github.com/restic/restic%E5%A4%87%E4%BB%BD%E7%B3%BB%E7%BB%9F%E7%9A%84Prometheus%E5%AF%BC%E5%87%BA%E5%99%A8%E3%80%82

镜像概述和主要用途

该镜像提供Restic备份系统的Prometheus指标导出功能，可监控Restic仓库的关键状态，如备份检查结果、快照数量、备份时间戳、文件总数、备份大小等。支持多种存储后端（本地、REST Server、Amazon S3、Backblaze B2等），适用于需要对Restic备份进行可视化监控和告警的场景。

核心功能和特性

• 监控Restic仓库检查结果（restic check）
• 统计快照总数、锁数量
• 记录每个备份的时间戳、文件数、总大小
• 支持多种Restic兼容的存储后端
• 可配置指标刷新间隔、监听端口、日志级别
• 支持按备份路径、标签、客户端信息等维度细分指标
• 兼容Prometheus、Alertmanager和Grafana，便于构建监控告警体系

支持的架构

该镜像支持以下架构：

• linux/386
• linux/amd64
• linux/arm/v6
• linux/arm/v7
• linux/arm64/v8
• linux/ppc64le
• linux/s390x

使用方法

镜像拉取

镜像可从GHCR或DockerHub拉取：

bash
# 从GHCR拉取
docker pull ***-ghcr.xuanyuan.run/ngosang/restic-exporter

# 或从DockerHub拉取
docker pull docker.xuanyuan.run/ngosang/restic-exporter

Docker Compose配置

兼容docker-compose v2架构：

yaml
---
version: '2.1'
services:
  restic-exporter:
    image: docker.xuanyuan.run/ngosang/restic-exporter
    container_name: restic-exporter
    environment:
      - TZ=Europe/Madrid  # 时区
      - RESTIC_REPOSITORY=/data  # Restic仓库路径或URL
      - RESTIC_PASSWORD=<password_here>  # 仓库密码（明文）
      # - RESTIC_PASSWORD_FILE=</file_with_password_here>  # 密码文件路径（二选一）
      - REFRESH_INTERVAL=1800  # 指标刷新间隔（秒，默认60）
    volumes:
      - /host_path/restic/data:/data  # 挂载本地仓库路径（如使用本地后端）
    ports:
      - "8001:8001"  # 默认监听端口
    restart: unless-stopped

Docker CLI命令

bash
docker run -d \
  --name=restic-exporter \
  -e TZ=Europe/Madrid \
  -e RESTIC_REPOSITORY=/data \
  -e RESTIC_PASSWORD=<password_here> \
  -e REFRESH_INTERVAL=1800 \
  -p 8001:8001 \
  --restart unless-stopped \
  docker.xuanyuan.run/ngosang/restic-exporter

配置说明

所有配置通过环境变量实现，支持Restic的https://restic.readthedocs.io/en/latest/030_preparing_a_new_repo.html%EF%BC%8C%E9%83%A8%E5%88%86%E5%90%8E%E7%AB%AF%E9%9C%80%E9%A2%9D%E5%A4%96%E9%85%8D%E7%BD%AE%E5%AF%86%E9%92%A5%E3%80%82

核心环境变量

存储后端专用变量

Rclone配置

Docker镜像不包含Rclone，若使用Rclone后端（rclone:remote:/path），需挂载主机的Rclone可执行文件和配置文件：

yaml
version: '2.1'
services:
  restic-exporter:
    image: docker.xuanyuan.run/ngosang/restic-exporter
    container_name: restic-exporter
    environment:
      - TZ=Europe/Madrid
      - RESTIC_REPOSITORY=rclone:gd-backup:/restic  # Rclone远程仓库
      - RESTIC_PASSWORD=<password_here>
      - REFRESH_INTERVAL=1800
    volumes:
      - /usr/bin/rclone:/usr/bin/rclone:ro  # 挂载主机Rclone可执行文件
      - /host_path/rclone.conf:/root/.config/rclone/rclone.conf:ro  # 挂载Rclone配置文件
    ports:
      - "8001:8001"
    restart: unless-stopped

导出指标

Prometheus配置

采集配置示例

yaml
scrape_configs:
  - job_name: 'restic-exporter'
    static_configs:
      - targets: ['192.168.1.100:8001']  # restic-exporter实例地址

告警规则示例

yaml
  - alert: ResticCheckFailed
    expr: restic_check_success == 0
    for: 5m
    labels:
      severity: critical
    annotations:
      summary: Restic检查失败（实例 {{ $labels.instance }}）
      description: Restic仓库检查失败\n  VALUE = {{ $value }}\n  LABELS = {{ $labels }}

  - alert: ResticOutdatedBackup
    expr: time() - restic_backup_timestamp > 1209600  # 15天（1209600秒）
    for: 0m
    labels:
      severity: critical
    annotations:
      summary: Restic {{ $labels.client_hostname }} / {{ $labels.client_username }} 备份过期
      description: Restic备份已过期\n  VALUE = {{ $value }}\n  LABELS = {{ $labels }}

Grafana仪表盘

提供参考Grafana仪表盘：https://github.com/ngosang/restic-exporter/blob/main/grafana/grafana_dashboard.json?raw=true

!https://github.com/ngosang/restic-exporter/blob/main/grafana/grafana_dashboard.png?raw=true