跳转到内容
Telemetry
API 可靠性

api_request_completed 事件图式

使用路由模板而不是原始 URL、有界错误类别和在服务边界测量的延迟的终端请求事件。

审阅者 Telemetry产品团队 . 事件粒度、所有权、字段类型、隐私分类、示例有效负载和验证. 审查标准和所有权

问题本合同的答案

错误和缓慢的请求会对客户产生哪些影响?

字段
10
必填
9
合同证据路径

api_request_completed:从拥有边界到可信查询

将 api_request_completed 视为持久的分析合约:所有者发出一个记录的谷物,一个固定装置证明字段,并且经过审查的查询回答所述问题。

  1. 1

    结果成为最终结果

    HTTP middleware at request completion emits only after the final response status and latency are known.

  2. 2

    合同是有约束力的

    9 required fields preserve the declared grain: One completed API request.

  3. 3

    夹具已验证

    检查类型、UTC 时间、替代结果、幂等性以及每个假名或评论分类字段。

  4. 4

    问题得到解答

    错误和缓慢的请求会对客户产生哪些影响?

谷物

一个已完成的 API 请求。

业主

请求完成时的 HTTP 中间件

何时发出

在得知最终响应状态和延迟后。

现场合同

具有明确隐私边界的类型化字段

在生产查询依赖现有字段名称和类型后,保持现有字段名称和类型稳定。可选上下文应受到特定决策的限制、记录和证明。

字段类型必填隐私含义
timestamp_utctimestampyesnon-sensitive结果边界处的 UTC 时间。
event_idstringyesnon-sensitive用于重复数据删除的稳定唯一标识符。
releasestringyesnon-sensitive发出事件的应用程序或服务版本。
account_idstringyespseudonymous稳定的内部帐户标识符,绝不是电子邮件或姓名。
request_idstringyespseudonymous相关标识符;不要暴露授权材料。
routestringyesnon-sensitive低基数路由模板,例如 /v1/query/:id。
methodstringyesnon-sensitiveHTTP 方法。
status_codenumberyesnon-sensitive最终 HTTP 响应状态。
latency_msnumberyesnon-sensitive端到端持续时间(以毫秒为单位)。
error_typestringnonon-sensitive有界故障类别;省略堆栈跟踪和有效负载。

合成 JSON 事件

{
  "timestamp_utc": "2026-07-28T14:15:06Z",
  "event_id": "evt_api_01",
  "account_id": "acct_8f31",
  "release": "2026.07.2",
  "request_id": "req_2f71",
  "route": "/v1/query/:id",
  "method": "POST",
  "status_code": 200,
  "latency_ms": 184
}

隐私审查

摄取前检查标识符

此示例使用合成标识符。假名值仍然可以是个人数据,并且审核字段可以公开业务或提供商上下文。应用您自己的同意、保留、访问、居住和删除要求。

  • account_id: pseudonymous
  • request_id: pseudonymous

验证清单

在构建仪表板之前证明合同

  • Send one known api_request_completed fixture after the documented outcome boundary.
  • Verify all 9 required fields arrive with the documented types.
  • 重试相同的事件标识符并确认所选的重复数据删除行为。
  • 当工作流支持时,发送受控失败或替代结果。
  • 在固定窗口上运行相关 SQL 并将结果与固定装置进行协调。

常见错误

保持一行等于一个持久结果

  • Emitting api_request_completed before http middleware at request completion knows the final outcome.
  • 在一张表中混合多种谷物,这使得计数和比率不明确。
  • 用原始 URL、有效负载、提示或错误文本替换受控类别。
  • 保存查询和仪表板依赖于它后就地更改字段类型。
  • 添加标识符,无需记录调查、访问和保留需求。

使用合同

查询并操作事件

相关合同

在生产流量之前发送夹具

创建免费的 API 密钥、发送合成事件并在连接实时工作流程之前检查推断表。

测试这个模式