使用 Stripe webhook telemetry 傳送並驗證事件
在受控應用程式邊界使用 Stripe webhook telemetry，保持事件契約較小，並在建置聚合檢視之前驗證已知結果。
- 1
選擇結果
Webhook 除錯
- 2
定義合約
provider_event_id、event_type、即時模式、端點和 received_at
- 3
在結果處發出
在信任或記錄任何事件欄位之前驗證 Stripe-Signature 標頭，並且切勿將簽名或原始正文傳送到 Telemetry。
- 4
核實證據
Exercise a known fixture, then inspect webhook_processed for one correctly typed terminal row.
開始之前
開始之前
- 一個伺服器端點，用於根據未修改的請求正文驗證 Stripe 簽名
- 由 Stripe 事件識別符號鍵入的持久重複資料刪除
- 下游工作緩慢的快速確認路徑已轉移到冪等工作
交貨設定
安裝並初始化伺服器端
在僅伺服器程式碼中匯入 telemetry-sh 並使用 process.env.TELEMETRY_API_KEY 對其進行一次初始化。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。
npm安裝
npm install telemetry-sh- 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
- 2在成功、失敗、重試或超時邊界處新增結果事件。
- 3在啟用警示之前傳送受控裝置並檢查儲存的行。
片段
從一個結構化事件開始
在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。
Stripe webhook telemetry事件
await telemetry.log("webhook_processed", {
provider: "stripe",
provider_event_id: event.id,
event_type: "invoice.payment_succeeded",
status: "success",
latency_ms: 328,
downstream_job_count: 2,
idempotency_outcome: "new_event",
livemode: event.livemode,
});事件結構
provider_event_id、event_type、即時模式、端點和 received_at
狀態、status_code、latency_ms、嘗試和 idempotency_outcome
downstream_job、downstream_status、error_type、account_id 和釋放
檢查設定
檢查站 1
在信任或記錄任何事件欄位之前驗證 Stripe-Signature 標頭，並且切勿將簽名或原始正文傳送到 Telemetry。
檢查站 2
重複發貨與重複業務處理分開記錄；事件識別符號應該使後者不可能。
檢查站 3
將已確認的交付連線到下游作業結果，以便快速的 2xx 回應無法隱藏失敗的訂閱或發票工作。
驗證
證明事件已到達
在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同，請替換後備資料表名稱。
Stripe webhook telemetry 驗證查詢
SELECT *
FROM webhook_processed
ORDER BY timestamp_utc DESC
LIMIT 20;實施參考
在啟用新的生產路徑之前，請檢查事件合約、資料安全指南和上游主要文件。
在哪裡記錄事件
保持結果事件小且可恢復
該模式提供了
- 除了上游工作流程之外，還有一個有界的、SQL 就緒的結果。
- 用於儀表板、警示和跨事件關聯的穩定欄位。
- 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。
該模式不提供
- OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
- 僅因為有效負載包含事件 ID，所以僅傳送一次。
- 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。
事件結構描述範例
此工作流程的事件結構描述
在將查詢或程式碼片段適應生產之前，請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。
相關產品功能
繼續此工作流程 儀表板
將經過驗證的產品或收入查詢轉變為集中的決策介面。
相關 SQL 查詢範例
更多 SQL 範例
針對此工作流程中的結構化欄位執行查詢，檢查範例結果，並將有用的答案轉換為儀表板或警示。
按實施系列瀏覽
比較相關整合模式
與此整合配對的範本
更多整合