homeylab/tdarr-exporter

tdarr-exporter

概述

tdarr-exporter是针对https://github.com/HaveAGitGat/Tdarr%E7%9A%84Prometheus%E6%8C%87%E6%A0%87%E6%94%B6%E9%9B%86%E5%99%A8%EF%BC%8C%E8%83%BD%E5%A4%9F%E5%B0%86Tdarr%E7%9A%84%E5%85%B3%E9%94%AE%E8%BF%90%E8%A1%8C%E6%95%B0%E6%8D%AE%E8%BD%AC%E6%8D%A2%E4%B8%BAPrometheus%E5%8F%AF%E9%87%87%E9%9B%86%E7%9A%84%E6%8C%87%E6%A0%87%E3%80%82%E5%85%B6%E6%A0%B8%E5%BF%83%E7%94%A8%E9%80%94%E6%98%AF%E5%AE%9E%E7%8E%B0Tdarr%E5%AE%9E%E4%BE%8B%E7%9A%84%E9%9B%86%E4%B8%AD%E5%8C%96%E7%9B%91%E6%8E%A7%EF%BC%8C%E5%8C%85%E6%8B%AC%E5%AE%9E%E4%BE%8B%E7%BB%9F%E8%AE%A1%E3%80%81%E9%98%9F%E5%88%97%E7%8A%B6%E6%80%81%E3%80%81%E8%BD%AC%E7%A0%81%E5%8F%8A%E5%81%A5%E5%BA%B7%E6%A3%80%E6%9F%A5%E8%BF%9B%E5%BA%A6%E7%AD%89%EF%BC%8C%E6%94%AF%E6%8C%81%E9%80%9A%E8%BF%87Grafana%E5%8F%AF%E8%A7%86%E5%8C%96%E5%B1%95%E7%A4%BA%EF%BC%8C%E9%81%BF%E5%85%8D%E7%94%A8%E6%88%B7%E5%9C%A8%E5%A4%9A%E4%B8%AA%E5%B9%B3%E5%8F%B0%E9%97%B4%E5%88%87%E6%8D%A2%E6%9F%A5%E7%9C%8B%E6%95%B0%E6%8D%AE%E3%80%82

核心功能和特性

• 通用统计：采集Tdarr统计页面展示的实例及库级别统计数据（如文件总数、转码数等）。
• 队列监控：实时获取当前转码队列、健康检查队列的任务数量及状态。
• 进度跟踪：针对以下作业类型提供CPU/GPU进度更新：
  • CPU/GPU Flow插件作业
  • CPU/GPU Classic插件作业
  • CPU/GPU健康检查作业

使用场景

适用于需要对Tdarr媒体转码系统进行精细化监控的场景，尤其是：

• 使用Prometheus+Grafana构建监控体系的用户
• 需要实时掌握转码任务进度、资源占用情况的媒体服务器管理员
• 希望通过统一仪表盘监控多个Tdarr实例或库的运维人员

使用方法

二进制运行

从项目https://github.com/homeylab/tdarr-exporter/releases%E7%9A%84%60assets%60%E4%B8%AD%E4%B8%8B%E8%BD%BD%E5%AF%B9%E5%BA%94%E5%B9%B3%E5%8F%B0%EF%BC%88darwin%E3%80%81linux%E3%80%81freebsd%E3%80%81openbsd%EF%BC%8C%E6%94%AF%E6%8C%81386%E3%80%81amd64%E3%80%81arm64%E6%9E%B6%E6%9E%84%EF%BC%89%E7%9A%84%E5%8F%AF%E6%89%A7%E8%A1%8C%E6%96%87%E4%BB%B6%EF%BC%8C%E7%9B%B4%E6%8E%A5%E8%BF%90%E8%A1%8C%EF%BC%9A

bash
./tdarr-exporter -url=example.com

Docker部署

提供linux/amd64和linux/arm64架构镜像，标签说明如下：

运行示例：

bash
docker run -e TDARR_URL=example.com -p 9090:9090 homeylab/tdarr-exporter:latest

需通过环境变量或命令行参数提供Tdarr实例URL等必要配置（详见配置说明）。

Helm部署

可通过Helm chart部署至Kubernetes集群，chart位于独立仓库：https://github.com/homeylab/helm-charts/tree/main/charts/tdarr-exporter%E3%80%82

配置说明

tdarr-exporter支持通过命令行参数或环境变量配置，以下是详细参数说明：

命令行参数示例

bash
$ ./tdarr-exporter -h
  -api_key string
        api token for tdarr instance if authentication is enabled
  -http_max_concurrency int
        maximum number of concurrent http requests to make when requesting per Library stats (default 3)
  -log_level string
        log level to use, see link for possible values: https://pkg.go.dev/github.com/rs/zerolog#Level (default "info")
  -prometheus_path string
        path to use for prometheus exporter (default "/metrics")
  -prometheus_port string
        port for prometheus exporter (default "9090")
  -url string
        valid url for tdarr instance, ex: https://tdarr.somedomain.com
  -verify_ssl
        verify ssl certificates from tdarr (default true)

配置参数表格

缓存与并发

缓存和并发机制仅适用于Tdarr 2.24.01 [2024年8月11日]及以上版本，因该版本后Tdarr库统计API需手动触发计算，可能导致指标采集延迟。

缓存逻辑

若以下计数自上次采集后未变化，将使用缓存数据以减少API调用：

• 总文件数
• 总转码数
• 总健康检查数

并发优化

http_max_concurrency参数控制并发请求库统计的数量。对于库数量较多的场景，可适当增加该值（建议接近库数量）以加速指标采集，最大值为“库数量+1”。若库数量极多，建议谨慎调整并适当增加Prometheus的采集间隔，减少API调用压力。

Grafana仪表盘

可通过以下方式导入Tdarr监控仪表盘：

通过Grafana官网导入

1. 访问Grafana仪表盘页面：https://grafana.com/grafana/dashboards/20388
2. 复制仪表盘ID 20388，在Grafana中通过“导入”功能粘贴ID完成导入。

通过JSON文件导入

若官网仪表盘不可用，可使用项目中的examples/dashboard.json文件：

1. 在Grafana中创建新仪表盘
2. 选择“导入”，粘贴dashboard.json文件内容完成导入。