跳转到内容
Telemetry
集成指南

谷歌云运行 Telemetry

使用应用程序拥有的结构化事件跟踪 Cloud Run 请求和作业结果、冷启动上下文、实例并发性、重试、延迟和发布。

审阅者 Telemetry产品团队 . 埋点合约、隐私边界和实施指南. 审查标准和所有权

有用于
  • 无服务器请求可靠性
  • Cloud Run 作业监控
  • 发布及地区分析
实施证据

Google Cloud Run Telemetry:从边界到验证行

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

  1. 1

    选择结果

    无服务器请求可靠性

  2. 2

    定义合同

    服务、修订、区域、route_template、job_name 和发布

  3. 3

    埋点边界

    在请求或作业产生最终结果后发出,并保留平台请求日志以进行提供商本机诊断。

  4. 4

    核实证据

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

开始之前

先决条件和界限

  • 在可信服务器代码中初始化了 telemetry-sh 的 Cloud Run 服务或作业
  • 稳定的服务、版本、区域、路线和作业名称
  • 有限的交付行为无法延长请求关闭时间或使成功的工作负载失败

交货设置

安装并初始化服务器端

在仅服务器代码中导入 telemetry-sh 并使用 process.env.TELEMETRY_API_KEY 对其进行一次初始化。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。

google-cloud-run-安装

npm安装

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

片段

从一个结构化事件开始

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

google-cloud-run

Google Cloud Run Telemetry事件

javascript
await telemetry.log("cloud_run_request_completed", {
  service: process.env.K_SERVICE,
  revision: process.env.K_REVISION,
  region: process.env.GOOGLE_CLOUD_REGION,
  route_template: "/api/reports/:reportId",
  status: responseStatus < 500 ? "success" : "failed",
  status_code: responseStatus,
  duration_ms: Math.round(performance.now() - startedAt),
  request_id: requestId,
  cold_start_observed: coldStartObserved,
  environment: process.env.APP_ENV,
  release: process.env.APP_RELEASE,
});

活动合约

服务、修订、区域、route_template、job_name 和发布

状态、status_code、duration_ms、尝试、instance_id_category 和 error_type

request_id、account_id、cold_start_observed、item_count 和环境

实施检查点

检查站 1

在请求或作业产生最终结果后发出,并保留平台请求日志以进行提供商本机诊断。

检查站 2

如果可用,请使用 K_REVISION、K_SERVICE 和 K_CONFIGURATION;将临时实例标识符保留在分组维度之外。

检查站 3

设置较短的交付超时并验证实例终止行为,以便遥测不会延迟响应或更改作业成功。

验证

证明事件已到达

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

google-cloud-run-验证

Google Cloud Run Telemetry 验证查询

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

实施参考

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

生产边界

保持结果事件小且可恢复

该模式提供了

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

该模式不提供

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

事件架构起点

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

相关产品功能

继续此工作流程 告警

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

相关 SQL 查询示例

用 SQL 回答下一个问题

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

浏览所有查询示例

按实施系列浏览

比较相关集成模式

与此集成配对的模板

更多集成