Saltar al contenido
Telemetry
guía de integración

Grupo y consulta de nodo-postgres Telemetry

Instrumente huellas digitales de consultas de nodo-postgres, adquisición de conexiones, presión del grupo, tiempos de espera, resultados de transacciones y errores de bases de datos sin registrar parámetros SQL.

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
  • Monitoreo del grupo de conexiones de Postgres
  • Análisis de operación de base de datos lenta
  • Depuración de transacciones y tiempos de espera
Evidencia de implementación

node-postgres Pool and Query Telemetry: del límite a la fila verificada

Utilice node-postgres Pool and Query 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

    Monitoreo del grupo de conexiones de Postgres

  2. 2

    Definir el contrato

    query_fingerprint, servicio, database_name, estado y duration_ms

  3. 3

    Instrumentar el límite

    Pase una huella digital limitada desde el sitio de la llamada en lugar de derivarla de SQL sin formato.

  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

  • El paquete pg con piscina compartida
  • Huellas dactilares de operación propiedad de la aplicación
  • 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 node-postgres

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.

node-postgres

Evento node-postgres Pool and Query Telemetry

javascript
import { Pool } from "pg";
import telemetry from "telemetry-sh";

const pool = new Pool({ max: 10 });
const SAFE_DATABASE_ERROR_CODES = new Set(["40001", "40P01", "55P03", "57014"]);

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 runDatabaseOperation({
  queryFingerprint,
  text,
  values,
}) {
  const acquireStartedAt = performance.now();
  let client;

  try {
    client = await pool.connect();
    const acquisitionWaitMs = performance.now() - acquireStartedAt;
    const queryStartedAt = performance.now();
    const result = await client.query(text, values);
    await telemetry.log("database_query_completed", {
      query_fingerprint: queryFingerprint,
      service: "checkout-api",
      database_name: "app_production",
      status: "success",
      duration_ms: Math.round(performance.now() - queryStartedAt),
      acquisition_wait_ms: Math.round(acquisitionWaitMs),
      rows_returned: result.rowCount ?? result.rows.length,
      active_connections: pool.totalCount - pool.idleCount,
      idle_connections: pool.idleCount,
      max_connections: pool.options.max ?? 10,
      waiting_count: pool.waitingCount,
      release: process.env.APP_RELEASE,
      environment: process.env.NODE_ENV,
    });
    return result;
  } catch (error) {
    await telemetry.log("database_query_completed", {
      query_fingerprint: queryFingerprint,
      service: "checkout-api",
      database_name: "app_production",
      status: "failed",
      duration_ms: Math.round(performance.now() - acquireStartedAt),
      error_type: classifyDatabaseError(error),
      active_connections: pool.totalCount - pool.idleCount,
      idle_connections: pool.idleCount,
      max_connections: pool.options.max ?? 10,
      waiting_count: pool.waitingCount,
      release: process.env.APP_RELEASE,
      environment: process.env.NODE_ENV,
    });
    throw error;
  } finally {
    client?.release();
  }
}

Contrato de evento

query_fingerprint, servicio, database_name, estado y duration_ms

active_connections, idle_connections, max_connections y waiting_count

acquisition_wait_ms, rows_returned, error_type, versión y entorno

Puntos de control de implementación

Punto de control 1

Pase una huella digital limitada desde el sitio de la llamada en lugar de derivarla de SQL sin formato.

Punto de control 2

Mida la adquisición de conexiones por separado de la ejecución de consultas para que la contención del grupo no se confunda con el trabajo de la base de datos.

Punto de control 3

Registre los códigos de error del controlador a través de una lista de permitidos y nunca reenvíe cadenas de conexión, parámetros de consulta o mensajes de bases de datos sin procesar.

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 node-postgres

Consulta de verificación node-postgres Pool and Query 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
Fiabilidad de la base de datosPrincipiante

Encuentre consultas lentas en bases de datos por huella digital

¿Qué operaciones de bases de datos son lo suficientemente lentas como para investigarlas?

Receta abierta
Fiabilidad de la base de datosPrincipiante

Clasificar consultas de bases de datos por impacto en el tiempo total

¿Qué operación de base de datos consume la mayor cantidad de tiempo de solicitud acumulado?

Receta abierta
Fiabilidad de la base de datosPrincipiante

Medir la saturación del grupo de conexiones de la base de datos

¿Qué grupos de aplicaciones hacen que las personas que llaman esperen una conexión a la base de datos?

Receta abierta
Fiabilidad de la base de datosIntermedio

Medir los tiempos de espera y la rotación de la conexión de la base de datos

¿Qué servicios y regiones muestran una pérdida de conexiones de bases de datos incorrecta?

Receta abierta
Fiabilidad de la base de datosIntermedio

Calcular la tasa de reversión de transacciones de la base de datos

¿Qué servicios revierten una proporción inusual de transacciones de bases de datos?

Receta abierta
Fiabilidad de la base de datosIntermedio

Mida las transacciones de bases de datos de larga duración

¿Qué clases de transacciones de aplicaciones permanecen abiertas por más tiempo?

Receta abierta
Fiabilidad de la base de datosIntermedio

Encuentre esperas y bloqueos de bloqueo de bases de datos

¿Qué operaciones de base de datos crean la contienda de bloqueo más grave?

Receta abierta
Fiabilidad de la base de datosPrincipiante

Analizar errores de bases de datos por SQLSTATE y versión

¿Qué clases de errores de bases de datos aumentaron después del lanzamiento de una aplicación?

Receta abierta
Fiabilidad de la base de datosPrincipiante

Medir la replicación de la base de datos y el retraso de CDC

¿Qué réplicas o consumidores de CDC se están quedando atrás con respecto a su base de datos de origen?

Receta abierta
Fiabilidad de la base de datosAvanzado

Medir el estancamiento de la réplica de la base de datos por región

¿Qué regiones de réplica ofrecen lecturas obsoletas o fallidas?

Receta abierta
Fiabilidad de la base de datosPrincipiante

Seguimiento de errores de migración de bases de datos por versión

¿Qué versiones contienen migraciones de bases de datos fallidas o revertidas?

Receta abierta

Explorar por familia de implementación

Comparar patrones de integración relacionados

Plantillas para combinar con esta integración

Más integraciones