跳转到内容
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-安装

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-验证

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 回答下一个问题

针对此工作流程中的结构化字段运行查询,检查示例结果,并将有用的答案转换为仪表板或警报。

浏览所有查询示例

按实施系列浏览

比较相关集成模式

与此集成配对的模板

更多集成