logicify/healthcheckbot

Healthcheck Bot

Healthcheck Bot是一款独立、高可配置且可扩展的应用，用于验证软件产品的状态。用户可自由配置监控目标、监控指标及结果存储方式，还支持通过自定义Python断言处理复杂检查场景。

核心功能

• 可灵活配置监控目标与关键指标
• 支持将检查结果存储到多种基础设施（如Graylog、Nagios）
• 允许编写自定义Python断言实现复杂状态验证
• 支持扩展输出、触发器、监控器等模块，适配不同场景需求

使用场景

• 需要主动监控现有软件，定期捕获状态并与预期对比
• 希望将健康检查结果集成到现有运维基础设施
• 系统状态验证需要比DSL/Yaml/JSON更复杂的逻辑表达
• 熟悉Python并需要定制化检查能力

配置说明

Docker部署示例

基础运行（使用默认配置文件）

bash
docker run --rm -it -v $PWD/myconfigs:/srv/config logicify/healthcheckbot

需将配置文件命名为config.yaml并放在主机./myconfigs目录下。

指定自定义配置文件

bash
docker run --rm -it -v $PWD/myconfigs:/srv/config -e CONFIG_FILE=/srv/config/advanced.yaml logicify/healthcheckbot

Docker Compose示例（含自定义模块）

yaml
healthcheckbot:
  image: logicify/healthcheckbot
  volumes:
    - ./myconfig:/srv/config
    - ./mydata:/srv/data
  environment:
    CONFIG_FILE: /srv/config/my_config_name.yaml

配置文件示例

yaml
app:
  classpath:
    - /srv/data  # 自定义模块所在目录

outputs:
  console:
    provider: healthcheckbot.outputs.ConsoleOutput  # 控制台输出

triggers:
  each_1_minute:
    provider: healthcheckbot.triggers.SimpleTimer  # 定时触发器
    interval: 60  # 间隔60秒

watchers:
  google_home:
    provider: healthcheckbot.watchers.HttpRequest  # HTTP监控器
    url: http://google.com
    assert_response_time: 2  # 响应时间断言（≤2秒）
    assert_status: 200  # 状态码断言
    triggers:
      - each_1_minute  # 绑定触发器
    custom_assertions:
      check_something_interesting:
        provider: mypackage.assertions.CustomAssert  # 自定义断言
        my_param: 'val1'

该配置会每分钟检查Google主页的响应状态与时间，并执行自定义断言，结果输出到控制台。自定义模块需放在./mydata目录下，通过classpath引入即可使用。