Checkmate

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

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

Checkmate还提供一个名为https://github.com/bluewave-labs/capture%E7%9A%84%E4%BB%A3%E7%90%86%EF%BC%8C%E7%94%A8%E4%BA%8E%E4%BB%8E%E8%BF%9C%E7%A8%8B%E6%9C%8D%E5%8A%A1%E5%99%A8%E6%A3%80%E7%B4%A2%E6%95%B0%E6%8D%AE%E3%80%82%E8%99%BD%E7%84%B6%E8%BF%90%E8%A1%8CCheckmate%E4%B8%8D%E9%9C%80%E8%A6%81Capture%EF%BC%8C%E4%BD%86%E5%AE%83%E8%83%BD%E6%8F%90%E4%BE%9B%E6%9C%89%E5%85%B3%E6%9C%8D%E5%8A%A1%E5%99%A8CPU%E3%80%81RAM%E3%80%81%E7%A3%81%E7%9B%98%E5%92%8C%E6%B8%A9%E5%BA%A6%E7%8A%B6%E6%80%81%E7%9A%84%E9%A2%9D%E5%A4%96%E6%B4%9E%E5%AF%9F%E3%80%82Capture%E5%8F%AF%E5%9C%A8Linux%E3%80%81Windows%E3%80%81Mac%E3%80%81%E6%A0%91%E8%8E%93%E6%B4%BE%EF%BC%88Raspberry Pi）或任何可运行Go的设备上运行。

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

如果您希望赞助某个功能，请查看此链接。

📚 目录

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

演示

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

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

用户指南

使用说明可在此处找到。

前提条件

• 已安装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

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

功能

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

短期路线图：

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

如果您希望赞助其他功能，请查看此页面。

监控生命周期

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

截图

技术栈

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

相关链接

• 如果您想支持我们，请考虑给它一个⭐并点击"watch"。
• 对路线图/功能集有问题或建议？请查看我们的***频道或https://github.com/bluewave-labs/checkmate/discussions%E8%AE%BA%E5%9D%9B%E3%80%82
• 希望在有新版本时收到通知？使用Newreleases，这是一个跟踪版本发布的免费服务。
• 观看Checkmate安装和使用视频

贡献

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

我们的仓库获得了来自Google、Microsoft、Intel、Cisco、Tencent、Electronic Arts、ByteDance、JP Morgan Chase、Deloitte、Accenture、Foxconn、Broadcom、China Telecom、Barclays、Capgemini、Wipro、Cloudflare、Dassault Systèmes和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%60good-first-issue%60%E6%A0%87%E7%AD%BE%E3%80%82
2. 如果您想深入了解架构，请阅读Checkmate的详细结构。
3. 如果您认为遇到了bug，请提交issue。
4. 如果您是新手，请查看good-first-issue。
5. 提交pull request以添加新功能/改进用户体验/修复bug。
6. 在CodeCanvas上查看Checkmate代码库的交互式演练此处。要优化现有数据流模拟或创建新模拟，请按照此处的快速教程操作。