Checkmate

一款开源的正常运行时间与基础设施监控应用

本仓库包含 Checkmate 的前端和后端代码。Checkmate 是一款开源自托管监控工具，用于实时跟踪服务器硬件、正常运行时间、响应时间和事件，并提供美观的可视化图表。Checkmate 定期检查服务器/网站是否可访问及性能是否最佳，实时提供受监控服务的可用性、停机时间和响应时间的警报与报告。

Checkmate 还提供名为 https://github.com/bluewave-labs/capture 的代理，用于从远程服务器检索数据。虽然运行 Checkmate 无需 Capture，但它能提供服务器 CPU、RAM、磁盘和温度状态的额外洞察。Capture 可在 Linux、Windows、Mac、树莓派或任何可运行 Go 的设备上运行。

Checkmate 已通过 1000+ 个活动监控器的压力测试，未发现任何特定问题或性能瓶颈。

如果您希望赞助某项功能，请参见此链接。

📚 目录

• 📦 演示
• 🔗 用户指南
• 🛠️ 安装
• 🚀 性能
• 💚 问题与想法
• 🧩 功能特性
• 🏗️ 截图
• 🏗️ 技术栈
• 🔗 相关链接
• 🤝 贡献指南
• 💰 赞助者

演示

您可以查看 Checkmate 的最新构建版本实际运行效果。

用户名是 ***，密码是 Demouser1!（请注意，我们会不时更新演示服务器，因此如果您无法登录，请在讨论频道联系我们）。

用户指南

使用说明可在 此处 找到。

前提条件

• 已安装 Docker
• 已安装 Git

安装

请参见 Checkmate 文档门户 中的安装说明。

使用自定义 CA

如果需要监控使用私有证书颁发机构（如 Smallstep）证书的内部 HTTPS 端点，请参见我们的 自定义 CA 信任指南 了解 Docker 配置选项。

更多文档，请参见 docs 目录。

性能

得益于大量优化，Checkmate 运行时内存占用极小，只需极少的内存和 CPU 资源。以下是在每分钟监控 323 台服务器的情况下，Node.js 实例的内存使用情况：

您还可以查看同一服务器上 MongoDB 和 Redis 的内存占用（分别为 398Mb 和 15Mb），监控相同数量的服务器。

问题与想法

如果您有任何问题、建议或意见，有以下几种方式可以联系我们：

• *** 频道（首选）
• https://github.com/bluewave-labs/Checkmate/discussions%EF%BC%88%E6%88%91%E4%BB%AC%E4%BC%9A%E5%AE%9A%E6%9C%9F%E6%9F%A5%E7%9C%8B%EF%BC%89

欢迎提问或分享您的想法——我们很乐意听取您的意见！

功能特性

• 完全开源，可部署在您的服务器或家庭设备上（例如 Raspberry Pi 4 或 5）
• 网站监控
• 页面速度监控
• 基础设施监控（内存、磁盘使用情况、CPU 性能、网络等）——需要 https://github.com/bluewave-labs/capture 代理
• 支持选择挂载点的选择性磁盘监控
• Docker 监控
• Ping 监控
• SSL 监控
• 端口监控
• 游戏服务器监控（3.0 版本）
• 事件概览
• 状态页面
• 电子邮件、Webhook、*** 和 Slack 通知
• 计划维护
• JSON 查询监控
• 多语言支持：英语、德语、日语、葡萄牙语（巴西）、俄语、土耳其语、乌克兰语、越南语、中文（繁体，***）

短期路线图：

• 插件功能，帮助 Checkmate 从远程服务（如数据库等）获取任何信息
• 更完善的通知功能
• 网络监控
• ...以及其他更多功能

如果您希望赞助额外功能，请参见此页面。

监控器生命周期

1. 监控器执行检查（HTTP / ping / 端口 / 通过 Capture 代理进行硬件检查）
2. 存储检查结果（成功/失败 + 响应时间）
3. 根据监控器配置的状态变更阈值评估最近的检查结果
4. 如果达到监控器的状态变更阈值且当前状态与之前状态不同，则监控器状态变更（例如 initializing、up、down、breached）
5. 状态变更时：根据监控器当前状态创建或解决事件
6. 根据配置触发通知

截图

技术栈

• ReactJs
• MUI（React 框架）
• Node.js
• MongoDB
• Recharts
• 以及许多其他开源组件！

相关链接

• 如果您想支持我们，请考虑给本仓库一个 ⭐ 并点击“关注”。
• 对路线图/功能集有问题或建议？请查看我们的 *** 频道 或 https://github.com/bluewave-labs/checkmate/discussions 论坛。
• 想在有新版本发布时收到提醒？使用 Newreleases，这是一个跟踪版本发布的免费服务。
• 观看 Checkmate 安装和使用视频

贡献指南

我们以与各级贡献者建立紧密联系为荣。尽管 Checkmate 是一个较新的项目，但已获得 7000+ 星标，并吸引了来自全球的 90+ 贡献者。

我们的仓库获得了来自 Google、Microsoft、Intel、Cisco、腾讯、Electronic Arts、字节跳动、摩根大通、德勤、埃森哲、富士康、博通、中国电信、巴克莱、凯捷、威普罗、Cloudflare、达索系统和 NEC 等公司员工的星标，所以请不要犹豫——加入我们，贡献代码并共同学习！

您可以通过以下方式贡献：

0. 给本仓库点个星标 :)
1. 查看 https://github.com/bluewave-labs/Checkmate/blob/develop/CONTRIBUTING.md%E3%80%82%E9%A6%96%E6%AC%A1%E8%B4%A1%E7%8C%AE%E8%80%85%E5%BB%BA%E8%AE%AE%E6%9F%A5%E7%9C%8B good-first-issue 标签。
2. 如果您想深入了解架构，请阅读 Checkmate 的详细结构。
3. 如果您认为遇到了 bug，请提交 issue。
4. 如果您是新手，请查看 good-first-issue。
5. 提交拉取请求（PR）以添加新功能/改进用户体验/修复 bug。
6. 在 CodeCanvas 上查看 Checkmate 代码库的交互式演练 此处。要优化现有数据流模拟或创建新模拟，请按照 快速教程 操作。

赞助者