brotandgames/ciao

ciao

镜像概述和主要用途

ciao是一款轻量级URL监控工具，专注于检查HTTP(S)端点的可用性与状态变化。它能够定期检测目标URL的HTTP状态码（如200、404、500等）或TCP传输层错误，并在端点状态发生变更时（如从正常变为异常或恢复正常）通过电子邮件或Webhook发送即时通知。工具采用Cron表达式定义检查频率，同时提供直观的Web用户界面(UI)和RESTful JSON API，方便用户配置监控任务、查看历史记录及管理通知规则。

核心功能和特性

• 全面的端点检查：支持HTTP(S)协议的URL端点状态码检测，同时覆盖TCP层连接错误（如无法建立连接、超时等），实现从应用层到传输层的深度监控。

• 灵活的调度机制：基于Cron语法配置检查频率，支持分钟、小时、日、周、月等多维度时间粒度，满足不同场景下的监控周期需求（如每5分钟检查一次关键API，每日检查一次静态资源）。

• 多渠道通知告警：当监控端点状态发生变化时，可通过电子邮件（SMTP协议）或Webhook（HTTP回调）发送通知，支持自定义通知内容模板，确保管理员及时掌握服务状态。

• 可视化与可编程管理：提供Web UI用于图形化配置监控任务、查看实时状态和历史趋势；同时内置RESTful JSON API，支持通过脚本或第三方系统集成，实现自动化配置与数据查询。

使用场景和适用范围

• 私有服务监控：适用于企业内部系统、私有API或局域网服务的可用性监控，如数据库接口、内部OA系统、微服务节点等，及时发现内部服务中断或性能退化。

• 公共资源跟踪：可监控第三方依赖服务（如支付网关、地图API）、公共网站或CDN静态资源的状态，确保外部依赖服务正常运行，避免业务受阻。

• 状态变更告警：针对需要关注状态切换的场景（如服务从正常变为不可用、临时维护后恢复），通过通知机制实现主动告警，减少人工巡检成本。

• 自动化运维集成：通过API与CI/CD管道、监控平台（如Prometheus）或运维工具链集成，构建端到端的服务健康度管理体系。

使用方法和配置说明

基本部署

ciao可通过Docker容器快速启动，基础运行命令如下（默认暴露Web UI端口3000，具体配置需根据实际需求调整）：

bash
docker run -d \
  --name ciao \
  -p 3000:3000 \
  brotandgames/ciao

启动后，Web UI可通过 http://localhost:3000 访问，初始配置需通过UI或API完成（如添加监控目标、设置通知参数等）。

核心配置项

ciao的配置通过环境变量、配置文件或Web UI/API动态设置，关键参数包括：

• 监控目标配置：需检查的URL列表，支持自定义请求头（如Authorization、User-Agent）、超时时间（默认10秒）、预期状态码（如期望200 OK）等。

• Cron调度规则：为每个监控目标单独配置Cron表达式，例如 */5 * * * * 表示每5分钟执行一次检查。

• 通知设置：

  • 邮件通知：需配置SMTP服务器地址、端口、认证信息（用户名/密码）、发件人***及收件人列表。
  • Webhook通知：配置接收回调的URL、请求方法（POST/GET）、请求头及 payload 模板。

扩展与集成

• 数据持久化：默认使用内存存储监控数据，生产环境建议通过Docker卷挂载持久化目录，或配置外部数据库（如SQLite、MySQL，具体支持需参考官方文档）。

• API使用示例：通过RESTful API添加监控任务（示例请求）：

  bash
  curl -X POST http://localhost:3000/api/checks \
    -H "Content-Type: application/json" \
    -d '{"url":"https://example.com","cron":"*/10 * * * *","expectedStatus":200,"notificationType":"webhook","webhookUrl":"https://alert-service.com/callback"}'
  

相关资源

• 官方网站：[***]
• 源代码与详细文档：https://github.com/brotandgames/ciao