跳至主要內容
Telemetry
整合指南

Supabase 和 Postgres 應用程式 Telemetry

追蹤產品工作流程、資料庫相關作業、API 路由以及伺服器程式碼中面向客戶的故障。

審閱者 Telemetry產品團隊 . 我們檢查了要傳送的事件、要排除的資料和程式碼新增方式. 誰負責審查此頁面

有用於
  • API 可靠性
  • 啟用追蹤
  • 執行除錯
實施證據

使用 Supabase and Postgres app telemetry 傳送並驗證事件

在受控應用程式邊界使用 Supabase and Postgres app telemetry,保持事件契約較小,並在建置聚合檢視之前驗證已知結果。

  1. 1

    選擇結果

    API 可靠性

  2. 2

    定義合約

    function_name、route_template、方法、status_code 和區域

  3. 3

    在結果處發出

    將 Telemetry 金鑰和 Supabase 秘密或服務角色憑證儲存在伺服器端功能秘密中;切勿將它們暴露給瀏覽器程式碼。

  4. 4

    核實證據

    Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.

開始之前

開始之前

  • Supabase Edge Function 或其他具有 Telemetry 金鑰的可信伺服器執行時
  • 在特權資料庫工作之前強制執行行級安全性和應用程式授權
  • 用於直接資料庫存取的池化或無伺服器友好的 Postgres 連線路徑

交貨設定

安裝並初始化伺服器端

在僅伺服器程式碼中匯入 telemetry-sh 並使用 process.env.TELEMETRY_API_KEY 對其進行一次初始化。 將攝取憑據保留在瀏覽器包、客戶端可見的環境變數、原始碼控制、日誌和異常訊息之外。

supabase-postgres-install

npm安裝

bash
npm install telemetry-sh
  1. 1準備一個具有有限網路行為的可重用伺服器端交付客戶端。
  2. 2在成功、失敗、重試或超時邊界處新增結果事件。
  3. 3在啟用警示之前傳送受控裝置並檢查儲存的行。

片段

從一個結構化事件開始

在工作流程完成、失敗或重試的位置新增此形狀。然後從真實的欄位建置儀表板。

supabase-postgres

Supabase and Postgres app telemetry事件

javascript
await telemetry.log("api_request_completed", {
  function_name: "sync-project",
  route_template: "/api/projects/:id/sync",
  method: "POST",
  status_code: 200,
  status: "success",
  latency_ms: 266,
  database_operation: "sync_project",
  team_id: team.id,
  region: Deno.env.get("SB_REGION"),
});

事件結構

function_name、route_template、方法、status_code 和區域

狀態、latency_ms、database_operation、rows_affected 和 error_type

request_id、account_id、版本和環境

檢查設定

檢查站 1

將 Telemetry 金鑰和 Supabase 秘密或服務角色憑證儲存在伺服器端功能秘密中;切勿將它們暴露給瀏覽器程式碼。

檢查站 2

記錄應用程式結果,而不是 SQL 文字、連線字串、請求正文或不受限制的資料庫錯誤。

檢查站 3

當診斷需要區分功能延遲和資料庫操作延遲時。

驗證

證明事件已到達

在演練已知的成功和失敗案例後執行此命令。如果您的最終事件契約與程式碼片段不同,請替換後備資料表名稱。

supabase-postgres-verification

Supabase and Postgres app telemetry 驗證查詢

sql
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
確認每個邏輯結果的一個終端行,以及預期狀態、識別符號、單位和 UTC 時間。
檢查推斷的架構並驗證重試不會更改欄位型別或生成新的邏輯事件 ID。
在儲存的欄位中搜尋憑據、原始有效負載、提示、私有內容和無限制的錯誤訊息。
在將儀表板視為完整之前,請執行提供程式超時、攝取拒絕和處理程序關閉。

實施參考

在啟用新的生產路徑之前,請檢查事件合約、資料安全指南和上游主要文件。

在哪裡記錄事件

保持結果事件小且可恢復

該模式提供了

  • 除了上游工作流程之外,還有一個有界的、SQL 就緒的結果。
  • 用於儀表板、警示和跨事件關聯的穩定欄位。
  • 用於驗證成功、失敗、重試和超時行為的夾具驅動路徑。

該模式不提供

  • OTLP 匯出器、自動收集管道或詳細追蹤和診斷日誌的替代品。
  • 僅因為有效負載包含事件 ID,所以僅傳送一次。
  • 收集原始提供商有效負載、使用者內容、憑證或受監管資料的權限。

事件結構描述範例

在將查詢或程式碼片段適應生產之前,請檢查行粒度、發出邊界、所需型別、隱私類、範例有效負載和驗證清單。

相關產品功能

繼續此工作流程 儀表板

將經過驗證的產品或收入查詢轉變為集中的決策介面。

相關 SQL 查詢範例

更多 SQL 範例

針對此工作流程中的結構化欄位執行查詢,檢查範例結果,並將有用的答案轉換為儀表板或警示。

瀏覽所有查詢範例

按實施系列瀏覽

比較相關整合模式

與此整合配對的範本

更多整合