跳至主要內容
Telemetry
瀏覽說明文件
概念與 SQL 模式更新於 2026年7月27日由 Telemetry 編輯團隊和產品團隊審查閱讀約需 2 分鐘

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

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

本頁內容
  1. 命名結果
  2. 從問題中選擇欄位
  3. 改變計劃
  4. 審查清單

設計事件架構

事件架構是發出資料的程式碼與使用資料的每個查詢、儀表板、警示或匯出之間的契約。儀器儀資料表前的少量設計可以防止數月的模糊資料。

命名結果

使用穩定的名詞和過去時結果,例如 api_request_completedjob_failedsubscription_renewed。避免頻繁更改的 UI 措辭。當成功和失敗共享相同的有用欄位時,具有受控 status 值的一個事件通常比單獨的資料表更容易比較。

從問題中選擇欄位

對於每個計劃的問題,確定操作:

  • 過濾器需要環境、功能、路線或狀態等欄位。
  • 組需要受控維度,例如模型、版本或錯誤型別。
  • 計算需要具有明確單位的鍵入測量值。
  • 調查需要連線相關事件的安全識別符號。

記錄 latency_ms,而不是 latency。將數值儲存為數字,將布林值儲存為布林值。使用 UTC 時間戳。優先選擇 route_template 而不是原始 URL,優先選擇 error_type 而不是無界異常訊息。

記錄識別符號是否代表個人、帳戶、請求或工作。如果欄位可能包含敏感資料,請在建立事件之前忽略或轉換它。

改變計劃

附加更改通常是最安全的:查詢可以容忍新的可為空欄位。重新命名欄位或更改其型別可能會破壞每個消費者。當語義發生重大變化時,新增 event_version,編寫處理遷移視窗的查詢,並僅在消費者移動後刪除舊形狀。

保留具有代表性的成功、失敗、重試和超時範例以進行驗證。在發布儀器更改之前執行重要的 SQL。僅當真實分支生成的值與其記錄的含義相匹配時,模式才是完整的。

審查清單

詢問事件是否有明確的所有者、一組有界的狀態值、明確的單位、安全識別符號和保留需求。確認至少有一個實際查詢使用每個欄位。僅僅因為它們可用而刪除包含的值。

有關完整的事件合約範例,請參閱 圖式演化脫敏敏感資料SQL食譜

將本指南付諸實踐

連線您的第一個真實事件

將設定提示貼上到編碼代理中,執行一個真實的應用程式流程,然後驗證事件並建置您的第一個查詢。樣本資料仍然是可選的。

無需信用卡。自動建立明確標記的範例事件和準備執行的查詢,因此不需要生產資料來評估工作流程。

  1. 1. 建立一個標記明確的範例事件
  2. 2. 開啟準備執行的查詢
  3. 3. 將結果儲存到您的儀表板

相關產品功能

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

內容責任與技術參考

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

檢視編輯規範