Saltar al contenido
Telemetry
guía de integración

Base de datos ORM de Prisma Telemetry

Mida las huellas digitales de las operaciones de Prisma, la latencia de los modelos y métodos, las fallas, los recuentos de resultados, las versiones y los flujos de trabajo dependientes de la base de datos sin recopilar parámetros de consulta sin procesar.

Revisado por el equipo de producto Telemetry en . Contrato de instrumentación, límites de privacidad y guía de implementación. Revisar los estándares y la propiedad

Útil para
  • Latencia de operación de Prisma
  • Análisis de regresión de lanzamiento
  • Depuración del flujo de trabajo dependiente de la base de datos
Evidencia de implementación

Prisma ORM Database Telemetry: del límite a la fila verificada

Utilice Prisma ORM Database Telemetry en un límite de aplicación controlado, mantenga el contrato de evento pequeño y verifique un resultado conocido antes de crear vistas agregadas.

  1. 1

    Elige el resultado

    Latencia de operación de Prisma

  2. 2

    Definir el contrato

    query_fingerprint, prisma_model, prisma_operation y flujo de trabajo

  3. 3

    Instrumentar el límite

    Envuelva las llamadas Prisma a nivel de producto con una huella digital explícita como User.findMany.active en lugar de reenviar el SQL emitido.

  4. 4

    Verificar la evidencia

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

Antes de empezar

Requisitos previos y límites

  • Prisma Client inicializado en el servidor
  • Nombres de operaciones estables elegidos en los sitios de llamadas de aplicaciones
  • Un TELEMETRY_API_KEY del lado del servidor

Configuración de entrega

Instalar e inicializar el lado del servidor

Importe telemetry-sh en código solo de servidor e inicialícelo una vez con Process.env.TELEMETRY_API_KEY. Mantenga las credenciales de ingesta fuera de los paquetes de navegador, las variables de entorno visibles para el cliente, el control de fuente, los registros y los mensajes de excepción.

Instalación de prisma

Instalación npm

bash
npm install telemetry-sh
  1. 1Prepare un cliente de entrega del lado del servidor reutilizable con comportamiento de red limitado.
  2. 2Agregue el evento de resultado en el límite de éxito, error, reintento o tiempo de espera.
  3. 3Envíe accesorios controlados e inspeccione las filas almacenadas antes de habilitar una alerta.

Fragmento

Comience con un evento estructurado

Agregue esta forma donde el flujo de trabajo se completa, falla o se vuelve a intentar. Luego cree el panel a partir de campos reales.

prisma

Evento 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 } }),
});

Contrato de evento

query_fingerprint, prisma_model, prisma_operation y flujo de trabajo

estado, duration_ms, rows_returned, error_type controlado y account_id

database_name, identificadores de versión, entorno y correlación segura

Puntos de control de implementación

Punto de control 1

Envuelva las llamadas Prisma a nivel de producto con una huella digital explícita como User.findMany.active en lugar de reenviar el SQL emitido.

Punto de control 2

Mantenga el modelo, la operación y el flujo de trabajo separados para que una regresión de la base de datos pueda conectarse al comportamiento visible del cliente.

Punto de control 3

Los eventos de consulta de Prisma exponen SQL y parámetros; no envíe ninguno de los campos a Telemetry.

Verificación

Demuestra que el evento llegó

Ejecute esto después de ejercitar casos conocidos de éxito y fracaso. Reemplace el nombre de la tabla alternativa si su contrato de evento final difiere del fragmento.

Verificación prisma

Consulta de verificación Prisma ORM Database Telemetry

sql
SELECT *
FROM database_query_completed
ORDER BY timestamp_utc DESC
LIMIT 20;
Confirme una fila terminal por resultado lógico, con el estado esperado, identificadores, unidades y hora UTC.
Inspeccione el esquema inferido y verifique que los reintentos no cambien los tipos de campos ni generen un nuevo ID de evento lógico.
Busque en los campos almacenados credenciales, cargas útiles sin procesar, mensajes, contenido privado y mensajes de error ilimitados.
Realice un tiempo de espera del proveedor, un rechazo de la ingesta y un cierre del proceso antes de considerar el panel como completo.

Referencias de implementación

Revise el contrato del evento, la guía de seguridad de los datos y la documentación primaria previa antes de habilitar una nueva ruta de producción.

Límite de producción

Mantenga el evento de resultado pequeño y recuperable

Este patrón proporciona

  • Un resultado limitado y listo para SQL junto al flujo de trabajo ascendente.
  • Campos estables para paneles, alertas y correlación entre eventos.
  • Una ruta basada en dispositivos para validar el comportamiento de éxito, fracaso, reintento y tiempo de espera.

Este patrón no proporciona

  • Un exportador de OTLP, un canal de recopilación automática o un reemplazo para seguimientos detallados y registros de diagnóstico.
  • Entrega exactamente una vez simplemente porque la carga útil contiene un ID de evento.
  • Permiso para recopilar cargas útiles sin procesar del proveedor, contenido de usuario, credenciales o datos regulados.

Puntos de partida del esquema de eventos

Revise el detalle de la fila, el límite de emisión, los tipos requeridos, las clases de privacidad, la carga útil de ejemplo y la lista de verificación de validación antes de adaptar una consulta o fragmento a producción.

Función relacionada del producto

Continúe este flujo de trabajo en Consulta SQL API

Ejecute DataFusion SQL de solo lectura sobre tablas de eventos estructurados y reutilice el resultado.

Recetas SQL relacionadas

Responde la siguiente pregunta con SQL

Ejecute la consulta en los campos estructurados de este flujo de trabajo, inspeccione el resultado del ejemplo y convierta una respuesta útil en un panel o alerta.

Explorar todas las recetas

Explorar por familia de implementación

Comparar patrones de integración relacionados

Plantillas para combinar con esta integración

Más integraciones