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 回答下一個問題
針對此工作流程中的結構化欄位執行查詢，檢查範例結果，並將有用的答案轉換為儀表板或警示。
按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合