跳转到内容
Telemetry
事件跟踪模板

API错误和延迟监视器

监视请求量、状态代码、路由延迟、失败的端点以及影响客户的 API 事件。

审阅者 Telemetry产品团队 . 我们检查了事件名称、建议字段、查询要回答的问题和要排除的数据. 谁负责审核此页面

由此解锁的问题
  • 哪些路由的 p95 延迟最慢?
  • 哪些客户会受到错误率上升的影响?
  • 流量在哪里下降或激增?
模板证据路径

API error and latency monitor:实施到决策

将提示视为实施概要。有用的工件不仅仅是复制的代码,而是经过审查的事件契约,可以产生值得信赖的答案。

  1. 1

    设定边界

    Instrument the point where api_request_started becomes final.

  2. 2

    创建合同

    Start with api_request_started, api_request_completed, api_request_failed and keep every field typed, bounded, and privacy-reviewed.

  3. 3

    运行夹具

    在依赖汇总结果之前,先练习已知的成功、失败、重试和空结果案例。

  4. 4

    回答问题

    哪些路由的 p95 延迟最慢?

模板与用例

使用此模板添加事件

当测量目标已经明确时,复制此模板。使用匹配的用例指南来查看事件边界、成功定义以及生成的 SQL 应支持的决策。

读取 API可靠性监控

模板

将其粘贴到您的编码代理中

更换 YOUR_API_KEY,在本地运行流程,然后验证生成的事件和仪表板。

api-error-monitor

API错误和延迟监视器

text
将 Telemetry 添加到 API 请求处理。

使用 /skill.md 和此 Telemetry API 密钥:YOUR_API_KEY

记录每个重要的 API 请求:
route_template、method、status_code、status、latency_ms、user_id、team_id、request_size_bytes、response_size_bytes、error_type 和 feature。

创建请求量、错误率、p50 延迟、p95 延迟和主要故障端点的图表。添加针对 5xx 峰值、慢 p95 延迟和流量下降的警报。

不要记录请求正文、cookie、身份验证标头、机密或原始用户内容。

要捕获的事件

api_request_startedapi_request_completedapi_request_failedapi_rate_limitedapi_timeout

验证清单

完整的埋点通行证留下了什么

活动

综合事件以稳定的名称和字段类型到达预期的表。

查询

第一个 SQL 查询返回具有明确时间窗口的合理行。

意见

仪表板使用真实字段并包含足够的上下文来解释更改。

安全

检查提示、正文、凭据、签名和私人内容是否经过编辑。

事件模式示例

在将查询或代码片段适应生产之前,请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。

相关产品功能

继续此工作流程 告警

将经过审查的可靠性查询提升到拥有的阈值和响应工作流程中。

相关 SQL 查询示例

更多 SQL 示例

针对此工作流程中的结构化字段运行查询,检查示例结果,并将有用的答案转换为仪表板或警报。

浏览所有查询示例
API 可靠性入门

按路由计算 API 请求吞吐量

哪些 API 路由每分钟处理的请求最多?

打开查询示例
API 可靠性中级

测量 API 429 速率限制恢复

收到 HTTP 429 的请求重试后能否成功恢复?

打开查询示例
基础设施高级

计算事件检测和恢复时间

每项服务需要多长时间来检测事件并从事件中恢复?

打开查询示例
API 可靠性入门

按路由计算API错误率

在至少有 20 次请求的 API 路由中,哪些路由的 5xx 错误率最高?

打开查询示例
API 可靠性中级

计算 p50、p95 和 p99 API 延迟

哪些端点的尾部延迟最差?

打开查询示例
API 可靠性入门

按路由计算API超时率

哪些 API 路由超时的频率足以影响用户?

打开查询示例
API 可靠性中级

比较依赖性 p95 延迟

哪些下游依赖项的尾部延迟和故障率最差?

打开查询示例
API 可靠性中级

根据 SLO 衡量 API 可用性

每项服务是否达到其每日可用性目标?

打开查询示例
API 可靠性中级

计算 API 错误预算消耗率

API 消耗其 99.9% 可用性预算的速度有多快?

打开查询示例
API 可靠性入门

按客户影响对错误指纹进行排名

哪些错误组影响最多的客户帐户?

打开查询示例
API 可靠性入门

比较功能推出错误率

功能标志的推出是否不如其对照群体可靠?

打开查询示例
API 可靠性中级

按计划衡量事件对客户的影响

每个计划中有多少个账户受到该事件的影响?

打开查询示例

更多模板