OpenTelemetry Context 中 Structured Events：从边界到验证行
在受控应用程序边界使用 OpenTelemetry Context 中 Structured Events，保持事件契约较小，并在构建聚合视图之前验证已知结果。
- 1
选择结果
跟踪到事件的关联
- 2
定义合同
来自活动跨度的 trace_id 和 span_id
- 3
埋点边界
该模式用 OpenTelemetry 上下文丰富了 Telemetry 事件；它不向 Telemetry 发送 OTLP 数据。
- 4
核实证据
Exercise a known fixture, then inspect checkout_completed for one correctly typed terminal row.
开始之前
先决条件和界限
- 现有的 OpenTelemetry SDK 和上下文传播设置
- telemetry-sh 包在服务器端初始化
- 补充跨度级诊断的已定义业务事件
交货设置
安装并初始化服务器端
在仅服务器代码中导入 telemetry-sh 并使用 process.env.TELEMETRY_API_KEY 对其进行一次初始化。 将摄取凭据保留在浏览器包、客户端可见的环境变量、源代码控制、日志和异常消息之外。
npm安装
npm install telemetry-sh- 1准备一个具有有限网络行为的可重用服务器端交付客户端。
- 2在成功、失败、重试或超时边界处添加结果事件。
- 3在启用警报之前发送受控装置并检查存储的行。
片段
从一个结构化事件开始
在工作流程完成、失败或重试的位置添加此形状。然后从真实的字段构建仪表板。
OpenTelemetry Context 中 Structured Events事件
import { trace } from "@opentelemetry/api";
const spanContext = trace.getActiveSpan()?.spanContext();
await telemetry.log("checkout_completed", {
status: "success",
latency_ms: 684,
trace_id: spanContext?.traceId,
span_id: spanContext?.spanId,
checkout_version: "v2",
account_id: account.id,
});活动合约
来自活动跨度的 trace_id 和 span_id
工作流程名称、状态、持续时间和错误类别
安全帐户、发布或功能维度
实施检查点
检查站 1
该模式用 OpenTelemetry 上下文丰富了 Telemetry 事件；它不向 Telemetry 发送 OTLP 数据。
检查站 2
一次发出业务结果，而跨度保留依赖级时序。
检查站 3
将跟踪和跨度 ID 视为查找的相关字段，而不是图表维度。
验证
证明事件已到达
在演练已知的成功和失败案例后运行此命令。如果您的最终事件契约与代码片段不同，请替换后备表名称。
OpenTelemetry Context 中 Structured Events 验证查询
SELECT *
FROM checkout_completed
ORDER BY timestamp_utc DESC
LIMIT 20;实施参考
在启用新的生产路径之前，请检查事件合同、数据安全指南和上游主要文档。
生产边界
保持结果事件小且可恢复
该模式提供了
- 除了上游工作流程之外，还有一个有界的、SQL 就绪的结果。
- 用于仪表板、警报和跨事件关联的稳定字段。
- 用于验证成功、失败、重试和超时行为的夹具驱动路径。
该模式不提供
- OTLP 导出器、自动收集管道或详细跟踪和诊断日志的替代品。
- 仅因为有效负载包含事件 ID，所以仅传送一次。
- 收集原始提供商有效负载、用户内容、凭证或受监管数据的权限。
事件架构起点
此工作流程的事件契约
在将查询或代码片段适应生产之前，请检查行粒度、发出边界、所需类型、隐私类、示例有效负载和验证清单。
相关产品功能
继续此工作流程 告警
将经过审查的可靠性查询提升到拥有的阈值和响应工作流程中。
相关 SQL 查询示例
用 SQL 回答下一个问题
针对此工作流程中的结构化字段运行查询，检查示例结果，并将有用的答案转换为仪表板或警报。
按实施系列浏览
比较相关集成模式
与此集成配对的模板
更多集成