跳至主要內容
Telemetry
整合指南

Prisma ORM 資料庫 Telemetry

測量 Prisma 操作指紋、模型和方法延遲、故障、結果計數、版本和依賴於資料庫的工作流程,而無需收集原始查詢參數。

審閱者 Telemetry產品團隊 . 埋點合約、隱私邊界和實施指南. 審查標準和所有權

有用於
  • Prisma 操作延遲
  • 發布迴歸分析
  • 依賴於資料庫的工作流程除錯
實施證據

Prisma ORM Database Telemetry:從邊界到驗證行

在受控應用程式邊界使用 Prisma ORM Database Telemetry,保持事件契約較小,並在建置聚合檢視之前驗證已知結果。

  1. 1

    選擇結果

    Prisma 操作延遲

  2. 2

    定義合約

    query_fingerprint、prisma_model、prisma_operation 和工作流程

  3. 3

    埋點邊界

    使用顯式指紋(例如 User.findMany.active)包裝產品級 Prisma 呼叫,而不是轉發發出的 SQL。

  4. 4

    核實證據

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

開始之前

先決條件和界限

  • Prisma 客戶端在伺服器上初始化
  • 在應用程式呼叫站點選擇的穩定操作名稱
  • 伺服器端TELEMETRY_API_KEY

交貨設定

安裝並初始化伺服器端

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

prisma-install

npm安裝

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

片段

從一個結構化事件開始

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

prisma

Prisma ORM Database Telemetry事件

javascript
import telemetry from "telemetry-sh";

const SAFE_DATABASE_ERROR_CODES = new Set(["P2024", "P2034"]);

function classifyDatabaseError(error) {
  return error && typeof error === "object" &&
    "code" in error &&
    SAFE_DATABASE_ERROR_CODES.has(String(error.code))
    ? String(error.code)
    : "database_error";
}

async function observePrismaOperation({
  queryFingerprint,
  model,
  operation,
  workflow,
  run,
}) {
  const startedAt = performance.now();
  try {
    const result = await run();
    await telemetry.log("database_query_completed", {
      query_fingerprint: queryFingerprint,
      prisma_model: model,
      prisma_operation: operation,
      workflow,
      database_name: "app_production",
      status: "success",
      duration_ms: Math.round(performance.now() - startedAt),
      rows_returned: Array.isArray(result) ? result.length : 1,
      release: process.env.APP_RELEASE,
      environment: process.env.NODE_ENV,
    });
    return result;
  } catch (error) {
    await telemetry.log("database_query_completed", {
      query_fingerprint: queryFingerprint,
      prisma_model: model,
      prisma_operation: operation,
      workflow,
      database_name: "app_production",
      status: "failed",
      duration_ms: Math.round(performance.now() - startedAt),
      error_type: classifyDatabaseError(error),
      release: process.env.APP_RELEASE,
      environment: process.env.NODE_ENV,
    });
    throw error;
  }
}

const users = await observePrismaOperation({
  queryFingerprint: "User.findMany.active",
  model: "User",
  operation: "findMany",
  workflow: "account_directory",
  run: () => prisma.user.findMany({ where: { active: true } }),
});

活動合約

query_fingerprint、prisma_model、prisma_operation 和工作流程

狀態、duration_ms、rows_returned、受控 error_type 和 account_id

database_name,版本、環境和安全相關識別符號

實施檢查點

檢查站 1

使用顯式指紋(例如 User.findMany.active)包裝產品級 Prisma 呼叫,而不是轉發發出的 SQL。

檢查站 2

將模型、操作和工作流程分開,以便資料庫迴歸可以連線到客戶可見的行為。

檢查站 3

Prisma 查詢事件公開 SQL 和參數;不要將任何一個欄位傳送到 Telemetry。

驗證

證明事件已到達

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

prisma-verification

Prisma ORM Database Telemetry 驗證查詢

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

實施參考

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

生產邊界

保持結果事件小且可恢復

該模式提供了

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

該模式不提供

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

事件架構起點

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

相關產品功能

繼續此工作流程 SQL 查詢 API

對結構化事件資料表執行只讀 DataFusion SQL 並重用結果。

相關 SQL 查詢範例

用 SQL 回答下一個問題

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

瀏覽所有查詢範例

按實施系列瀏覽

比較相關整合模式

與此整合配對的範本

更多整合