Temporal Workflow Observability：從邊界到驗證行
在受控應用程式邊界使用 Temporal Workflow Observability，保持事件契約較小，並在建置聚合檢視之前驗證已知結果。
- 1
選擇結果
工作流程完成情況監控
- 2
定義合約
workflow_type、workflow_id、run_id 和狀態
- 3
埋點邊界
從活動或工作攔截器傳送 Telemetry 事件，而不是直接從確定性工作流程式碼傳送。
- 4
核實證據
Exercise a known fixture, then inspect workflow_completed for one correctly typed terminal row.
開始之前
先決條件和界限
- 伺服器端TELEMETRY_API_KEY
- 穩定的工作流程和活動型別名稱
- 外部遙測呼叫的非重播邊界
交貨設定
安裝並初始化伺服器端
在僅伺服器程式碼中匯入 telemetry-sh 並使用 process.env.TELEMETRY_API_KEY 對其進行一次初始化。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。
npm安裝
npm install telemetry-sh- 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
- 2在成功、失敗、重試或超時邊界處新增結果事件。
- 3在啟用警示之前傳送受控裝置並檢查儲存的行。
片段
從一個結構化事件開始
在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。
Temporal Workflow Observability事件
await telemetry.log("workflow_completed", {
workflow_type: info.workflowType,
workflow_id: info.workflowId,
run_id: info.runId,
task_queue: info.taskQueue,
status: "success",
duration_ms: Date.now() - startedAt,
business_outcome: result.category,
});活動合約
workflow_type、workflow_id、run_id 和狀態
activity_type、嘗試、queue_name 和 duration_ms
error_type、business_outcome，並釋放
實施檢查點
檢查站 1
從活動或工作攔截器傳送 Telemetry 事件，而不是直接從確定性工作流程式碼傳送。
檢查站 2
保持邏輯工作流程 ID 穩定，同時單獨記錄臨時執行 ID。
檢查站 3
請勿記錄工作流程參數、包含私有資料的搜尋屬性或活動結果。
驗證
證明事件已到達
在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同，請替換後備資料表名稱。
Temporal Workflow Observability 驗證查詢
SELECT *
FROM workflow_completed
ORDER BY timestamp_utc DESC
LIMIT 20;實施參考
在啟用新的生產路徑之前，請檢查事件合約、資料安全指南和上游主要文件。
生產邊界
保持結果事件小且可恢復
該模式提供了
- 除了上游工作流程之外，還有一個有界的、SQL 就緒的結果。
- 用於儀表板、警示和跨事件關聯的穩定欄位。
- 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。
該模式不提供
- OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
- 僅因為有效負載包含事件 ID，所以僅傳送一次。
- 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。
事件架構起點
此工作流程的事件契約
在將查詢或程式碼片段適應生產之前，請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。
相關產品功能
繼續此工作流程 警示
將經過審查的可靠性查詢提升到擁有的閾值和回應工作流程中。
相關 SQL 查詢範例
用 SQL 回答下一個問題
針對此工作流程中的結構化欄位執行查詢，檢查範例結果，並將有用的答案轉換為儀表板或警示。
測量後台作業重試和失敗率
哪些後台作業消耗的重試次數最多或仍然失敗？
開啟查詢範例按作業測量佇列等待時間
哪些工作在工人開始之前等待的時間最長？
開啟查詢範例使用 SQL 查詢停滯的後台作業
哪些作業已啟動但從未產生終止事件？
開啟查詢範例檢測後台作業重試風暴
目前哪些工作型別在重試上花費的工作量最多？
開啟查詢範例按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合