跳转到内容
集成指南

Cloudflare 工作人员 Telemetry

记录边缘请求状态、延迟、提供商故障、cron 运行以及来自 Cloudflare Workers 的队列工作人员。

审阅者 Telemetry产品团队 上 . 我们检查了要发送的事件、要排除的数据和代码添加方法. 谁负责审核此页面

有用于
  • 边缘API监控
  • Cron 可观测性
  • 队列调试
实施证据

使用 Cloudflare Worker telemetry 发送并验证事件

在受控应用程序边界使用 Cloudflare Worker telemetry,保持事件契约较小,并在构建聚合视图之前验证已知结果。

  1. 1

    选择结果

    边缘API监控

  2. 2

    定义合同

    worker_name、route_template、方法、status_code、颜色和 trigger_type

  3. 3

    在结果处发出

    将已处理错误且设有超时的发送 Promise 传给实际请求的 ctx.waitUntil。这是尽力而为的后台发送,不保证持久存储,也不自动重试。

  4. 4

    核实证据

    Exercise a known fixture, then inspect edge_request_completed for one correctly typed terminal row.

开始之前

开始之前

  • Telemetry API 密钥的 Worker 秘密绑定
  • ExecutionContext 可用于显式管理的后台交付
  • Cloudflare 请求元数据的规范化路由名称和允许列表

交货设置

安装并初始化服务器端

此 Worker 示例通过秘密绑定中的 env.TELEMETRY_API_KEY 直接调用 Log API,无需 npm SDK 或 process.env 配置。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。

  1. 1准备一个具有有限网络行为的可重用服务器端交付客户端。
  2. 2在成功、失败、重试或超时边界处添加结果事件。
  3. 3在启用警报之前发送受控装置并检查存储的行。

片段

从一个结构化事件开始

在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。

cloudflare-workers

Cloudflare Worker telemetry事件

javascript
// Wrap your existing /api/events handler; do not replace its business logic.
export default {
  async fetch(request, env, ctx) {
    const started = performance.now();
    const response = await handleEvents(request, env, ctx);
    try {
      ctx.waitUntil(deliverEdgeEvent(env, {
        worker_name: "events-api",
        route_template: "/api/events",
        method: request.method,
        status_code: response.status,
        colo: request.cf?.colo,
        latency_ms: performance.now() - started,
        latency_scope: "response_ready",
        status: response.status >= 400 ? "error" : "success",
        release: env.APP_RELEASE,
      }));
    } catch {
      // Scheduling or metadata failures must not replace the response.
    }
    return response;
  },
};

async function deliverEdgeEvent(env, data) {
  let timer;
  try {
    if (!env.TELEMETRY_API_KEY) return;
    const controller = new AbortController();
    timer = setTimeout(() => controller.abort(), 3000);
    const response = await fetch("https://api.telemetry.sh/log", {
      method: "POST",
      headers: {
        Authorization: env.TELEMETRY_API_KEY,
        "Content-Type": "application/json",
      },
      body: JSON.stringify({ table: "edge_request_completed", data }),
      signal: controller.signal,
    });
    if (!response.ok || (await response.json()).status !== "success") {
      throw new Error("delivery_unconfirmed");
    }
  } catch {
    try { console.warn("Telemetry delivery unconfirmed"); } catch {}
  } finally {
    clearTimeout(timer);
  }
}

事件结构

worker_name、route_template、方法、status_code、颜色和 trigger_type

状态、latency_ms、cpu_time_ms(如果可用)和 error_type

request_id、queue_name、尝试、发布和环境

检查配置

检查站 1

将已处理错误且设有超时的发送 Promise 传给实际请求的 ctx.waitUntil。这是尽力而为的后台发送,不保证持久存储,也不自动重试。

检查站 2

记录路由模板而不是原始 URL,并且不记录 cookie、授权标头、请求正文、客户端 IP 地址或不受限制的 cf 属性。

检查站 3

将 handleEvents 替换为现有的 /api/events 处理函数。示例记录返回的响应状态和响应准备就绪所需时间,而非流式响应体传输完成时间;应用抛出的错误仍原样传播。未捕获的运行时错误继续由 Workers Logs 记录。

验证

证明事件已到达

在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同,请替换后备表名称。

cloudflare-workers-验证

Cloudflare Worker telemetry 验证查询

sql
SELECT *
FROM edge_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
确认每个逻辑结果的一个终端行,以及预期状态、标识符、单位和 UTC 时间。
检查推断的架构并验证重试不会更改字段类型或生成新的逻辑事件 ID。
在存储的字段中搜索凭据、原始有效负载、提示、私有内容和无限制的错误消息。
在将仪表板视为完整之前,请执行提供程序超时、摄取拒绝和进程关闭。

实施参考

在启用新的生产路径之前,请检查事件合同、数据安全指南和上游主要文档。

在哪里记录事件

保持结果事件小且可恢复

该模式提供了

  • 除了上游工作流程之外,还有一个有界的、SQL 就绪的结果。
  • 用于仪表板、警报和跨事件关联的稳定字段。
  • 用于验证成功、失败、重试和超时行为的夹具驱动路径。

该模式不提供

  • OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
  • 仅因为有效负载包含事件 ID,所以仅传送一次。
  • 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。

事件模式示例

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

相关产品功能

继续此工作流程 告警

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

相关 SQL 查询示例

更多 SQL 示例

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

浏览所有查询示例

按实施系列浏览

比较相关集成模式

与此集成配对的模板

更多集成