adhocteam/script-exporter

Script Exporter

GitHub: https://github.com/adhocteam/script_exporter

镜像概述

Script Exporter是一款Prometheus exporter工具，专注于执行shell脚本并收集其退出状态（成功、失败、超时）和执行时长的指标。它旨在补充Prometheus Blackbox Exporter的不足，解决特定探针类型难以配置的问题，支持自定义脚本的监控需求。

核心功能

1. 执行预配置的shell脚本
2. 收集脚本的退出状态（成功/失败/超时）
3. 生成Prometheus直方图指标（成功/失败脚本的执行时长）
4. 支持自定义脚本超时时间设置

使用场景

• 监控自定义业务脚本的运行状态与执行效率
• 覆盖Blackbox Exporter无法支持的探针类型（如内部服务的自定义检查脚本）
• 收集脚本执行的性能数据，用于故障排查与优化

配置说明

示例配置（config.yml）

yaml
scripts:
  - name: success
    script: sleep 5  # 成功执行的脚本
  - name: failure
    script: sleep 2 && exit 1  # 执行失败的脚本
  - name: timeout
    script: sleep 5  # 超时的脚本
    timeout: 1  # 超时时间（秒）

Docker部署示例

bash
docker run -d -p 9172:9172 --name script-exporter \
  -v $(pwd)/config.yml:/etc/script-exporter/config.yml:ro \
  adhocteam/script-exporter:master \
  -config.file=/etc/script-exporter/config.yml \
  -web.listen-address=":9172" \
  -web.telemetry-path="/metrics" \
  -config.shell="/bin/sh"

说明：需将本地config.yml挂载到容器内指定路径；若需curl等工具，需自定义镜像或在宿主系统使用二进制文件。

输出示例

访问http://localhost:9172/metrics可获取指标，主要包括：

• script_success_duration_seconds：成功脚本的执行时长直方图
• script_failure_duration_seconds：失败/超时脚本的执行时长直方图

设计说明

Script Exporter在Prometheus的/metrics端点添加上述直方图指标。当Prometheus采集目标时，所有配置的脚本会通过sh执行，并将结果纳入输出。若需执行大量脚本，建议使用专门的exporter以避免进程启动带来的性能问题。