parkr/checkup

Sourcegraph Checkup 镜像文档

镜像概述

本镜像基于GitHub开源项目sourcegraph/checkup的cmd/checkup组件构建，提供轻量级服务健康检查能力。该工具专注于通过可配置的检查规则，定期验证目标服务的可用性，并生成标准化健康状态报告，适用于各类服务监控场景。

核心功能与特性

• 多协议支持：支持HTTP(S)、TCP、ICMP（ping）等多种检查类型，覆盖常见服务通信方式
• 灵活配置：可自定义检查频率、超时时间、重试次数、健康阈值等参数
• 结构化报告：输出JSON或文本格式的健康报告，包含响应时间、成功率、错误详情等指标
• 轻量设计：镜像体积小，资源占用低，适合在容器化环境中部署
• 无状态运行：支持单次检查或持续监控模式，无需持久化存储

使用场景

• 微服务监控：定期检查微服务实例的健康状态，及时发现异常实例
• 外部依赖检查：监控第三方API、数据库等外部服务的可用性
• CI/CD集成：在部署流程中验证服务是否正常启动，确保部署质量
• 基础设施监控：检查服务器、网络设备的基础连接性（如TCP端口、ICMP响应）

使用方法

基本用法（单次检查）

通过命令行参数指定检查目标，执行单次健康检查：

bash
docker run --rm ghcr.io/sourcegraph/checkup/cmd/checkup:latest \
  check http --url https://example.com/health --timeout 5s

持续监控模式

挂载配置文件，启动持续监控（需提前创建checkup.yaml配置文件）：

bash
docker run -d \
  -v $(pwd)/checkup.yaml:/etc/checkup/checkup.yaml \
  --name checkup-monitor \
  ghcr.io/sourcegraph/checkup/cmd/checkup:latest \
  monitor --config /etc/checkup/checkup.yaml

配置文件示例（checkup.yaml）

yaml
checks:
  - name: "API Service"
    type: "http"
    target: "https://api.example.com/health"
    interval: "30s"       # 检查间隔
    timeout: "5s"         # 超时时间
    threshold: 3          # 连续失败阈值（超过则标记为不健康）
  - name: "Database TCP"
    type: "tcp"
    target: "db.example.com:5432"
    interval: "60s"
    timeout: "10s"
report:
  format: "json"          # 报告格式：json/text
  output: "/var/log/checkup/report.json"  # 报告输出路径

环境变量说明

查看检查报告

若配置文件中指定了报告输出路径，可通过以下命令查看：

bash
docker exec checkup-monitor cat /var/log/checkup/report.json

注意事项

• ICMP（ping）检查需要容器具备CAP_NET_RAW权限，启动时需添加--cap-add=NET_RAW参数
• 对于HTTPS检查，默认验证SSL证书，可通过--insecure参数禁用证书验证
• 配置文件需符合YAML规范，详细配置项可参考https://github.com/sourcegraph/checkup