跳至主要內容
Telemetry
瀏覽說明文件
入門指南更新於 2026年7月28日由 Telemetry 編輯團隊和產品團隊審查閱讀約需 3 分鐘

讓程式設計代理使用這篇文件

開啟 Claude Code、Codex、Cursor 或其他編碼代理的集中提示包,然後將其適應此處介紹的工作流程。

本頁內容
  1. 活動合約
  2. 敏感資料邊界
  3. 憑證和環境
  4. 交付和失敗行為
  5. 架構和資料生命週期
  6. 分析與應對
  7. 逐步推出

生產環境插樁檢查清單

在端到端的合成事件、查詢、儀表板和警示工作之後使用此清單。目標是在所有者和後備的情況下進行有限的生產部署,而不是最大的事件覆蓋範圍。

活動合約

  • 事件名稱描述了一種持久的工作流程結果。
  • 業務粒度被記錄:請求、作業、帳戶、代理執行、Webhook 或其他穩定單元。
  • 列出了必填和可選欄位以及型別和單位。
  • 狀態、錯誤、功能、版本和環境值使用有界詞彙資料表。
  • 穩定的識別符號可以在不暴露秘密的情況下連線相關事件。
  • 重試和重複嘗試可以與最終結果區分開來。

檢視 設計事件架構規範廣泛事件相關 ID

敏感資料邊界

  • 禁止使用密碼、API 金鑰、授權標頭、cookie 和會話權杖。
  • 除非單獨審查,否則原始請求正文、Webhook 有效負載、提示、完成和作業有效負載將保留在其中。
  • 路由範本替換包含識別符號的 URL。
  • 錯誤類別儘可能替換原始私人內容。
  • 個人或受監管的領域具有批准的目的、存取邊界和保留期限。

在審查期間使用 脫敏敏感資料安全和資料處理 概述。

憑證和環境

  • 生產攝取使用命名的、寫入範圍的金鑰。
  • 報告自動化使用單獨的讀取範圍鍵。
  • 金鑰位於秘密管理器或受保護的執行時設定中。
  • 登臺和生產使用單獨的金鑰和顯式 environment 欄位。
  • 記錄所有權的輪換和撤銷。

在未確認每個已部署環境或提供相容後備的情況下,切勿引入所需的環境變數。

交付和失敗行為

  • Telemetry 交付具有有限的超時時間。
  • 遙測失敗不會破壞主要應用程式結果。
  • 重試是有限的且可觀察的。
  • 針對選定的 SDK 測試關閉或重新整理行為。
  • 如果沒有經過批准的原因,大容量迴圈不會為每個內部步驟發出事件。

在 Telemetry 端點不可用或速度緩慢的情況下執行受控測試。應用程式應遵循其記錄的後備。

架構和資料生命週期

  • 已在最終資料表中檢查了合成行。
  • 欄位型別與現有生成器和儲存的查詢保持相容。
  • 分割區選擇反映了真實的查詢過濾器。
  • 保留符合操作和隱私目的。
  • 瞭解行和資料表刪除的職責。

請參見 模式演化選擇分割區列資料保留和刪除

分析與應對

  • 第一個儲存的 SQL 結果與已知燈具匹配。
  • 分母、排除項、時間視窗和恆等規則均已記錄。
  • 儀表板小工具返回可檢查的 SQL 或行。
  • 每個警示都有經過測試的閾值、接收者和回應操作。
  • 商業、安全或客戶維度都有適當的存取邊界。

在將結果視為生產證據之前,請使用 SQL測試方法 和相關的 SQL配方

逐步推出

從一項服務、工作人員或路線開始。在擴充套件之前觀察事件量、架構行為、查詢成本、交付失敗和警示噪音。

記錄:

  • 所有者和審查日期。
  • 已部署的服務和版本。
  • 預計每日事件量。
  • 已儲存的查詢和儀表板連結。
  • 警示收件人和回應文件。
  • 已知的差距和下一次審查觸發點。

如果工作流程透過了此清單,則從證據中進行擴充套件。如果沒有,請繼續開發或舉辦活動,直到邊界清晰為止。

相關產品功能

記錄穩定的事件名稱、型別明確的欄位,以及經過隱私審查的上下文。

內容責任與技術參考

Telemetry 編輯團隊負責維護本文;產品團隊審查功能行為、範例和適用範圍。

檢視編輯規範