使用 Cloudflare Worker telemetry 发送并验证事件
在受控应用程序边界使用 Cloudflare Worker telemetry,保持事件契约较小,并在构建聚合视图之前验证已知结果。
- 1
选择结果
边缘API监控
- 2
定义合同
worker_name、route_template、方法、status_code、颜色和 trigger_type
- 3
在结果处发出
仅将 ctx.waitUntil 用于观察到失败的交付承诺;否则,Worker 可以在遥测数据刷新之前返回。
- 4
核实证据
Exercise a known fixture, then inspect edge_request_completed for one correctly typed terminal row.
开始之前
开始之前
- Telemetry API 密钥的 Worker 秘密绑定
- ExecutionContext 可用于显式管理的后台交付
- Cloudflare 请求元数据的规范化路由名称和允许列表
交货设置
安装并初始化服务器端
在仅服务器代码中导入 telemetry-sh 并使用 process.env.TELEMETRY_API_KEY 对其进行一次初始化。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。
npm安装
npm install telemetry-sh- 1准备一个具有有限网络行为的可重用服务器端交付客户端。
- 2在成功、失败、重试或超时边界处添加结果事件。
- 3在启用警报之前发送受控装置并检查存储的行。
片段
从一个结构化事件开始
在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。
Cloudflare Worker telemetry事件
await telemetry.log("edge_request_completed", {
worker_name: "events-api",
route_template: "/api/events",
method: "POST",
status_code: 202,
colo: request.cf?.colo,
latency_ms: 42,
status: "success",
release: env.APP_RELEASE,
});事件结构
worker_name、route_template、方法、status_code、颜色和 trigger_type
状态、latency_ms、cpu_time_ms(如果可用)和 error_type
request_id、queue_name、尝试、发布和环境
检查配置
检查站 1
仅将 ctx.waitUntil 用于观察到失败的交付承诺;否则,Worker 可以在遥测数据刷新之前返回。
检查站 2
记录路由模板而不是原始 URL,并且不记录 cookie、授权标头、请求正文、客户端 IP 地址或不受限制的 cf 属性。
检查站 3
保留工作日志以进行运行时诊断,并发出紧凑的 Telemetry 事件以查看应用程序结果,而不是复制每个控制台记录。
验证
证明事件已到达
在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同,请替换后备表名称。
Cloudflare Worker telemetry 验证查询
SELECT *
FROM edge_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;实施参考
在启用新的生产路径之前,请检查事件合同、数据安全指南和上游主要文档。
在哪里记录事件
保持结果事件小且可恢复
该模式提供了
- 除了上游工作流程之外,还有一个有界的、SQL 就绪的结果。
- 用于仪表板、警报和跨事件关联的稳定字段。
- 用于验证成功、失败、重试和超时行为的夹具驱动路径。
该模式不提供
- OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
- 仅因为有效负载包含事件 ID,所以仅传送一次。
- 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。
事件模式示例
此工作流的事件模式
在将查询或代码片段适应生产之前,请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。
相关产品功能
继续此工作流程 告警
将经过审查的可靠性查询提升到拥有的阈值和响应工作流程中。
相关 SQL 查询示例
更多 SQL 示例
针对此工作流程中的结构化字段运行查询,检查示例结果,并将有用的答案转换为仪表板或警报。
按路由计算 API 请求吞吐量
哪些 API 路由每分钟处理的请求最多?
打开查询示例测量 API 429 速率限制恢复
收到 HTTP 429 的请求重试后能否成功恢复?
打开查询示例按路由计算API错误率
在至少有 20 次请求的 API 路由中,哪些路由的 5xx 错误率最高?
打开查询示例计算 p50、p95 和 p99 API 延迟
哪些端点的尾部延迟最差?
打开查询示例计算 API 错误预算消耗率
API 消耗其 99.9% 可用性预算的速度有多快?
打开查询示例检测丢失的服务心跳
哪些预期遥测源已停止发送心跳?
打开查询示例按路线和版本比较核心网络生命力
哪个路线和版本的前端性能最弱?
打开查询示例按实施系列浏览
比较相关集成模式
与此集成配对的模板
更多集成