SolStatus API 参考:自定义监控逻辑与数据查询指南
SolStatus API 参考自定义监控逻辑与数据查询指南【免费下载链接】solstatusAn uptime monitoring service that is easy and cheap to run at scale. Create endpoint checks for uptime, latency, and status code. Supports OpsGenie for alerts.项目地址: https://gitcode.com/gh_mirrors/upti/solstatusSolStatus 是一款轻量级、低成本的 uptime 监控服务让你轻松创建端点检查以监控网站的可用性、延迟和状态码并支持通过 OpsGenie 发送告警通知。本文将详细介绍 SolStatus 的 API 接口帮助你实现自定义监控逻辑与数据查询。核心 API 端点概览SolStatus 提供了丰富的 API 端点用于管理和查询监控数据。以下是主要的 API 端点分类端点监控管理GET /api/endpoint-monitors获取所有端点监控列表POST /api/endpoint-monitors创建新的端点监控GET /api/endpoint-monitors/[id]获取特定端点监控详情PATCH /api/endpoint-monitors/[id]更新特定端点监控DELETE /api/endpoint-monitors/[id]删除特定端点监控监控状态与操作GET /api/endpoint-monitors/[id]/status获取特定端点监控的当前状态POST /api/endpoint-monitors/[id]/pause暂停特定端点监控POST /api/endpoint-monitors/[id]/resume恢复特定端点监控GET /api/endpoint-monitors/[id]/execute-check手动执行特定端点的检查数据查询GET /api/endpoint-monitors/[id]/checks获取特定端点的检查记录GET /api/endpoint-monitors/[id]/checks/history获取特定端点的检查历史GET /api/endpoint-monitors/[id]/uptime获取特定端点的 uptime 数据GET /api/endpoint-monitors/[id]/uptime/range获取特定时间范围内的 uptime 数据GET /api/endpoint-monitors/[id]/uptime/limit获取有限范围内的 uptime 数据统计信息GET /api/endpoint-monitors/count获取端点监控的数量统计GET /api/endpoint-monitors/stats获取端点监控的统计信息端点监控数据模型端点监控的核心数据模型定义在 packages/common/src/db/schema/endpointMonitor.ts 文件中主要包含以下字段id端点监控的唯一标识符url要监控的端点 URLname端点监控的名称checkInterval检查间隔秒isRunning是否正在运行监控expectedStatusCode预期的 HTTP 状态码consecutiveFailures连续失败次数alertThreshold触发告警的阈值activeAlert是否有活动告警时间戳字段createdAt、updatedAt自定义监控逻辑实现创建端点监控要创建自定义监控你可以使用POST /api/endpoint-monitors接口。以下是一个示例请求体{ url: https://example.com, name: Example Site Monitor, checkInterval: 60, expectedStatusCode: 200, alertThreshold: 3 }这个请求将创建一个每 60 秒检查一次https://example.com的监控当连续失败 3 次时触发告警。暂停和恢复监控当你需要暂时停止监控某个端点时可以使用暂停接口POST /api/endpoint-monitors/[id]/pause恢复监控则使用恢复接口POST /api/endpoint-monitors/[id]/resume这些接口允许你根据需要灵活控制监控的运行状态。数据查询与分析获取 uptime 数据要获取特定端点的 uptime 数据可以使用GET /api/endpoint-monitors/[id]/uptime接口。这个接口将返回该端点的总体 uptime 百分比。如果你需要特定时间范围内的 uptime 数据可以使用范围查询接口GET /api/endpoint-monitors/[id]/uptime/range?start2023-01-01end2023-01-31查看检查历史要查看端点的检查历史记录可以使用GET /api/endpoint-monitors/[id]/checks/history接口。这个接口将返回该端点的检查历史包括每次检查的时间戳、状态码和响应时间。SolStatus 监控仪表板展示了端点的实时状态和历史数据高级用法集成告警系统SolStatus 支持与 OpsGenie 集成以发送告警通知。告警逻辑实现于 packages/api/src/utils/opsgenie.ts 文件中。当端点连续失败次数达到设定的阈值时系统将自动触发告警。你可以通过修改alertThreshold字段来调整告警的敏感度以适应不同的监控需求。快速开始安装与配置要开始使用 SolStatus API首先需要克隆仓库git clone https://gitcode.com/gh_mirrors/upti/solstatus然后按照项目 README 中的说明进行安装和配置。配置完成后你就可以开始使用本文介绍的 API 接口来实现自定义监控逻辑和数据查询了。总结SolStatus 提供了强大而灵活的 API 接口使你能够轻松实现自定义监控逻辑和数据查询。通过本文介绍的 API 端点和数据模型你可以构建适合自己需求的监控系统并与告警服务集成以确保及时响应。无论是个人网站监控还是企业级应用监控SolStatus 都能为你提供简单、低成本且可扩展的解决方案。【免费下载链接】solstatusAn uptime monitoring service that is easy and cheap to run at scale. Create endpoint checks for uptime, latency, and status code. Supports OpsGenie for alerts.项目地址: https://gitcode.com/gh_mirrors/upti/solstatus创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考