aauren/rtorrent-exporter

rtorrent-exporter 镜像文档

镜像概述

rtorrent-exporter是一个Prometheus导出器，专门用于收集rtorrent torrent客户端的运行指标，并将其暴露为Prometheus可抓取的格式，便于监控和分析rtorrent的性能和状态。

核心功能和特性

• 收集rtorrent客户端关键指标，包括种子数量、上传/下载速度、连接数等
• 支持HTTP基本认证，保护rtorrent XMLRPC接口访问安全
• 支持自签名证书，可配置跳过TLS证书验证
• 可调整连接和指标收集超时参数，适应不同网络环境
• 支持通过命令行参数或配置文件进行灵活配置
• 提供网络隔离配置，避免与现有网络冲突

使用场景和适用范围

适用于需要监控rtorrent客户端运行状态的场景，包括：

• 个人用户监控本地rtorrent实例
• 服务器管理员监控rtorrent服务运行状态
• 需要将rtorrent指标集成到Prometheus+Grafana监控系统的环境

使用方法和配置说明

Docker Compose部署

创建docker-compose.yml文件，内容如下：

yaml
---
services:
  rtorrent-exporter:
    image: "docker.xuanyuan.run/aauren/rtorrent-exporter:latest"
    container_name: rtorrent-exporter
    restart: unless-stopped
    ports:
      - 9135:9135
    command:
      # 注意：
      # - 172.28.1.0/24需为网络中未使用的子网（如有冲突，需修改此子网和下方IPAM配置）
      # - 确保主机防火墙不阻止此子网与rtorrent URL之间的流量
      - "-rtorrent.addr"
      - "https://172.28.1.1/RPC2"
      # 可选配置：
      # 若rtorrent XMLRPC使用HTTP基本认证
      # - "-rtorrent.username"
      # - "<用户名>"
      # - "-rtorrent.password"
      # - "<密码>"
      # 若rtorrent XMLRPC使用自签名证书
      # - "rtorrent.insecure"
      # - "true"
      # 若需调整超时时间
      # - "-rtorrent.timeout"
      # - "5s"
      # - "-telemetry.timeout"
      # - "5s"
      # 若需禁用高基数指标（会减少单个种子的可见性）
      # - "-rtorrent.collect.active"
      # - "false"
    # 如需使用配置文件
    # volumes:
    #   - "/path/to/rtorrent_exporter.yaml:/.rtorrent_exporter.yaml"
networks:
  rtorrent_exporter:
    ipam:
      driver: default
      config:
        - subnet: 172.28.1.0/24
          ip_range: 172.28.1.0/24
          gateway: 172.28.1.1

在文件所在目录执行以下命令启动服务：

sh
docker compose up -d

Docker Run部署

直接运行容器的示例命令：

sh
docker run -ti --rm -p 9135:9135 --add-host=host.docker.internal:host-gateway docker.xuanyuan.run/"aauren/rtorrent-exporter:latest" -rtorrent.addr https://host.docker.internal/RPC2 -rtorrent.username "<http_basic_auth_user>" -rtorrent.password "<http_basic_auth_pass>" "-rtorrent.insecure" true

配置参数说明

更多信息

详细文档和源码请参考https://github.com/aauren/rtorrent-exporter