Saltar al contenido
Telemetry
guía de integración

Análisis de eventos estructurados de Pino

Empareje los registros de diagnóstico de Pino con eventos de resultados delimitados de Telemetry para el análisis de confiabilidad de solicitudes, trabajos y productos de Node.js.

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
  • Fiabilidad API Node.js
  • Registro estructurado y correlación de resultados.
  • Análisis de regresión de lanzamiento
Evidencia de implementación

Pino Structured Event Analytics: del límite a la fila verificada

Utilice Pino Structured Event Analytics 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

    Fiabilidad API Node.js

  2. 2

    Definir el contrato

    request_id, route_template, método, status_code y estado

  3. 3

    Instrumentar el límite

    Mantenga a Pino como flujo de diagnóstico detallado; emite una fila compacta Telemetry separada solo cuando la solicitud o el flujo de trabajo alcanza un resultado terminal.

  4. 4

    Verificar la evidencia

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

Antes de empezar

Requisitos previos y límites

  • Pino y telemetry-sh se inicializaron una vez en un tiempo de ejecución Node.js confiable
  • Plantillas de ruta estables, nombres de flujo de trabajo, ID de solicitud e identificadores de versión
  • Una lista de campos permitidos y reglas de redacción de Pino para credenciales y contenido privado

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

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.

pino-node

Evento Pino Structured Event Analytics

javascript
import pino from "pino";
import telemetry from "telemetry-sh";

const logger = pino();
const startedAt = performance.now();

try {
  const result = await runCheckout();
  const outcome = {
    request_id: requestId,
    route_template: "/api/checkout",
    method: "POST",
    status_code: 200,
    status: "success",
    latency_ms: Math.round(performance.now() - startedAt),
    release: process.env.APP_RELEASE,
  };

  logger.info(outcome, "checkout completed");
  await telemetry.log("api_request_completed", outcome);
  return result;
} catch (error) {
  const outcome = {
    request_id: requestId,
    route_template: "/api/checkout",
    method: "POST",
    status_code: 500,
    status: "failed",
    latency_ms: Math.round(performance.now() - startedAt),
    error_type: classifyError(error),
    release: process.env.APP_RELEASE,
  };

  logger.error({ ...outcome, err: error }, "checkout failed");
  await telemetry.log("api_request_completed", outcome);
  throw error;
}

Contrato de evento

request_id, route_template, método, status_code y estado

latency_ms, error_type, versión, entorno y servicio

account_id o tenant_id solo cuando estén aprobados para análisis operativos

Puntos de control de implementación

Punto de control 1

Mantenga a Pino como flujo de diagnóstico detallado; emite una fila compacta Telemetry separada solo cuando la solicitud o el flujo de trabajo alcanza un resultado terminal.

Punto de control 2

Comparta un request_id aprobado entre sistemas para correlación, pero no copie mensajes de registro, cuerpos de solicitud, encabezados o pilas de excepciones en el evento.

Punto de control 3

Espere o tenga en cuenta la promesa Telemetry en el límite de la aplicación y defina una política de bandeja de salida si perder el resultado es inaceptable.

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

Consulta de verificación Pino Structured Event Analytics

sql
SELECT *
FROM api_request_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 Alertas

Promueva la consulta de confiabilidad revisada a un umbral propio y un flujo de trabajo de respuesta.

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
colecciones completasFiabilidad de la API SQL

Explorar por familia de implementación

Comparar patrones de integración relacionados

Plantillas para combinar con esta integración

Más integraciones