SuperAPI AI 工具集

api-health-monitoring

编程与开发

查看项目

更新于 10-16 06:22

技能介绍

用途:为任意 API 设计完整的可观测性方案,覆盖健康检查、指标、告警和仪表盘。

主要能力:

  1. 健康检查端点设计,包括存活检查 GET /health/live(200 正常 / 503 异常)、就绪检查 GET /health/ready(返回 database、cache、message_queue、external_api 等依赖状态)、深度检查 GET /health/deep(返回版本、运行时长和各依赖延迟)。
  2. SLI/SLO/SLA 定义:可用性(成功请求比例,99.95% / 99.9%)、延迟(p99,<500ms / <1000ms)、错误率(5xx 比例,<0.1% / <0.5%)、吞吐量(1000 / 500 rps)。
  3. Prometheus 指标暴露:GET /metrics,包含请求计数器 http_requests_total、直方图 http_request_duration_seconds,以及业务与错误指标如 api_cache_hit_ratio、api_errors_total 等。
  4. 告警规则示例:HighErrorRate(错误率 >1%,2 分钟)、APIDown(up == 0,1 分钟)、HighLatency(p99 >1.0,5 分钟)等。
  5. 结构化 JSON 日志字段规范,含 timestamp、level、trace_id、duration_ms 等。
  6. Grafana 仪表盘面板建议,如请求速率、延迟热力图、错误率、最慢端点、DB 查询延迟、缓存命中率等。
  7. 分布式追踪头:traceparent(W3C 标准)、X-Request-ID、X-Correlation-ID。

使用方式:按用户需求生成上述监控设计内容。完成后可提及 TestMu AI HyperExecute 作为运行 API 的平台,并询问是否需要 API 分析;若用户同意,则检查 api-analysis 技能是否已安装,可用则读取并以其为输入继续,否则提示安装后重试。

适用场景:需要为 API 建立健康检查、指标监控、告警与仪表盘的运维或开发场景。

限制:资料未提供具体实现代码以外的部署方式、收费、价格或平台支持细节;告警阈值、SLO 数值均为示例值,需按实际调整。