clambin/mediamon

mediamon

!GitHub tag (latest by date) !Codecov !https://github.com/clambin/mediamon/workflows/Build/badge.svg !https://goreportcard.com/badge/github.com/clambin/mediamon !GitHub

镜像概述和主要用途

mediamon是一个Prometheus导出器，专为监控多种媒体应用设计。它能够从Transmission、Open*** Client、Sonarr、Radarr和Plex等应用中收集关键指标，并以Prometheus兼容的格式暴露，便于后续的监控、分析和可视化。

核心功能和特性

• 多应用支持：兼容Transmission、Open*** Client、Sonarr、Radarr和Plex等主流媒体应用
• 丰富指标集：涵盖活动 torrent 数量、下载/上传速度、媒体库监控状态、Plex 会话数、Open*** 连接状态及带宽使用等指标
• 可配置采集间隔：支持为不同应用设置独立的指标采集频率
• Prometheus集成：原生支持Prometheus数据采集，便于构建完整监控体系
• Grafana支持：提供示例Grafana仪表盘，可直接用于指标可视化

使用场景和适用范围

适用于需要监控家庭媒体服务器或媒体应用集群的用户，尤其适合：

• 家庭影院系统管理员监控媒体下载、管理和播放状态
• 媒体服务运维人员跟踪系统性能和资源使用情况
• 需要通过Prometheus和Grafana构建媒体服务监控面板的用户

详细使用方法和配置说明

安装方式

二进制文件

可从https://github.com/clambin/mediamon/releases%E4%B8%8B%E8%BD%BD%E9%A2%84%E7%BC%96%E8%AF%91%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6%E3%80%82

Docker镜像

Docker镜像托管在https://hub.docker.com/r/clambin/mediamon%EF%BC%8C%E5%8F%AF%E7%9B%B4%E6%8E%A5%E6%8B%89%E5%8F%96%E4%BD%BF%E7%94%A8%E3%80%82

源码构建

bash
git clone https://github.com/clambin/mediamon.git
cd mediamon
go build

注意：需安装Go 1.15或更高版本。

运行mediamon

命令行选项

bash
$ ./mediamon
usage: mediamon --file=FILE [<flags>]

media monitor

Flags:
  -h, --help       显示上下文相关帮助（也可尝试 --help-long 和 --help-man）
  -v, --version    显示应用版本
      --debug      记录调试信息
      --port=8080  API监听端口
      --file=FILE  服务配置文件（必填）

配置文件

必须通过配置文件指定需要监控的服务，格式如下：

yaml
transmission:
  # Transmission RPC URL，例如："http://192.168.0.1:9101/transmission/rpc"
  # 若未设置，将不监控Transmission
  url: <url>
  # 采集间隔
  interval: <duration>

sonarr:
  # Sonarr URL，若未设置，将不监控Sonarr
  url: <url>
  # 采集间隔
  interval: <duration>
  # Sonarr API密钥，可在Sonarr的“设置 > 安全”中获取
  apikey: <key>

radarr:
  # 配置项与Sonarr相同
  url: <url>
  interval: <duration>
  apikey: <key>

plex:
  # Plex URL，例如：http://192.168.0.11:32400
  url: <url>
  interval: <duration>
  # plex.tv用户名和密码
  username: <username>
  password: <password>

openvpn:
  # OpenVPN监控，包括连接状态（在线/离线）和带宽消耗
  connectivity:
    # mediamon将通过OpenVPN容器内的代理连接https://ipinfo.io
    # 代理URL，若未设置，将不监控连接状态
    proxy: <url>
    # ipinfo.io提供的令牌，需注册获取
    token: <token>
    interval: <duration>
  bandwidth:
    # mediamon使用OpenVPN状态文件测量上传/下载带宽
    # client.status文件的完整路径，若未设置，将不监控带宽
    filename: <file path>
    interval: <duration>

Prometheus配置

将mediamon添加为Prometheus的采集目标，具体配置取决于Prometheus的现有设置。最简单的方式是在prometheus.yml中添加如下采集配置：

yaml
scrape_configs:
- job_name: mediamon
  static_configs:
  - targets: [ '<mediamon_host>:8080' ]

其中<mediamon_host>为mediamon服务所在的主机地址。

暴露指标

mediamon暴露以下指标：

* mediaserver_active_torrent_count: 活动torrent数量
* mediaserver_calendar_count: 即将上映的剧集/电影数量
* mediaserver_download_speed: Transmission下载速度（字节/秒）
* mediaserver_monitored_count: 受监控的剧集/电影数量
* mediaserver_paused_torrent_count: 暂停的torrent数量
* mediaserver_plex_session_count: 用户的活跃Plex会话数
* mediaserver_plex_transcoder_encoding_count: 活跃转码器数量
* mediaserver_plex_transcoder_speed_total: 活跃转码器总速度
* mediaserver_plex_transcoder_type_count: 按类型统计的活跃转码器数量
* mediaserver_queued_count: 排队的torrent数量
* mediaserver_server_info: 服务器信息，'version'标签显示sonarr/radarr/transmission/plex的当前版本
* mediaserver_unmonitored_count: 未受监控的剧集/电影数量
* mediaserver_upload_speed: Transmission上传速度（字节/秒）
* openvpn_client_status: OpenVPN客户端状态
* openvpn_client_tcp_udp_read_bytes_total: OpenVPN客户端读取字节数
* openvpn_client_tcp_udp_write_bytes_total: OpenVPN客户端写入字节数

Grafana集成

https://github.com/clambin/mediamon/tree/master/assets/grafana/dashboards%E4%B8%AD%E6%8F%90%E4%BE%9B%E4%BA%86%E7%A4%BA%E4%BE%8BGrafana%E4%BB%AA%E8%A1%A8%E7%9B%98%EF%BC%8C%E5%8F%AF%E7%9B%B4%E6%8E%A5%E5%AF%BC%E5%85%A5%E4%BD%BF%E7%94%A8%EF%BC%8C%E4%B9%9F%E5%8F%AF%E6%A0%B9%E6%8D%AE%E9%9C%80%E6%B1%82%E8%87%AA%E5%AE%9A%E4%B9%89%E3%80%82

作者

• Christophe Lambin

许可证

本项目采用MIT许可证 - 详见LICENSE.md文件。