Google Cloud Pub/Sub Telemetry：從邊界到驗證行
在受控應用程式邊界使用 Google Cloud Pub/Sub Telemetry，保持事件契約較小，並在建置聚合檢視之前驗證已知結果。
- 1
選擇結果
Pub/Sub 交付可靠性
- 2
定義合約
message_id、message_type、主題、訂閱、ordering_key_category、發布
- 3
埋點邊界
Pub/Sub 可以重新傳送訊息；將提供商訊息 ID 和傳送嘗試與最終業務結果分開。
- 4
核實證據
Exercise a known fixture, then inspect pubsub_message_completed for one correctly typed terminal row.
開始之前
先決條件和界限
- @google-cloud/pubsub 和 telemetry-sh 在受信任的發布者或訂閱者中初始化
- 穩定的主題、訂閱、訊息型別和邏輯結果定義
- 冪等消費者和記錄在案的確認或一次性策略
交貨設定
安裝並初始化伺服器端
在僅伺服器程式碼中匯入 telemetry-sh 並使用 process.env.TELEMETRY_API_KEY 對其進行一次初始化。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。
npm安裝
npm install telemetry-sh- 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
- 2在成功、失敗、重試或超時邊界處新增結果事件。
- 3在啟用警示之前傳送受控裝置並檢查儲存的行。
片段
從一個結構化事件開始
在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。
Google Cloud Pub/Sub Telemetry事件
await telemetry.log("pubsub_message_completed", {
message_id: message.id,
message_type: "account_export",
topic: "account-exports",
subscription: "account-export-worker",
status: "success",
delivery_attempt: message.deliveryAttempt ?? 1,
wait_ms: Date.now() - Number(message.publishTime.getTime()),
duration_ms: Math.round(performance.now() - startedAt),
acknowledged: true,
dead_lettered: false,
service: "export-worker",
release: process.env.APP_RELEASE,
});活動合約
message_id、message_type、主題、訂閱、ordering_key_category、發布
狀態、delivery_attempt、wait_ms、duration_ms、已確認和 error_type
dead_lettered、published_at、account_id、服務、區域和環境
實施檢查點
檢查站 1
Pub/Sub 可以重新傳送訊息；將提供商訊息 ID 和傳送嘗試與最終業務結果分開。
檢查站 2
一次性交付具有訂閱和區域限制，因此請驗證實際設定，而不是從確認呼叫中推斷設定。
檢查站 3
除了應用程式結果之外，還要監視提供程式積壓指標，並且不要將訊息資料、包含私有內容的屬性或不受限制的錯誤複製到事件中。
驗證
證明事件已到達
在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同，請替換後備資料表名稱。
Google Cloud Pub/Sub Telemetry 驗證查詢
SELECT *
FROM pubsub_message_completed
ORDER BY timestamp_utc DESC
LIMIT 20;實施參考
在啟用新的生產路徑之前，請檢查事件合約、資料安全指南和上游主要文件。
生產邊界
保持結果事件小且可恢復
該模式提供了
- 除了上游工作流程之外，還有一個有界的、SQL 就緒的結果。
- 用於儀表板、警示和跨事件關聯的穩定欄位。
- 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。
該模式不提供
- OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
- 僅因為有效負載包含事件 ID，所以僅傳送一次。
- 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。
事件架構起點
此工作流程的事件契約
在將查詢或程式碼片段適應生產之前，請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。
相關產品功能
繼續此工作流程 警示
將經過審查的可靠性查詢提升到擁有的閾值和回應工作流程中。
相關 SQL 查詢範例
用 SQL 回答下一個問題
針對此工作流程中的結構化欄位執行查詢，檢查範例結果，並將有用的答案轉換為儀表板或警示。
按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合