Saltar al contenido
Telemetry
guía de integración

Análisis de eventos estructurados de Winston

Conecte los diagnósticos de aplicaciones de Winston con pequeñas solicitudes, flujos de trabajo y resultados de trabajos listos para SQL sin duplicar todo el flujo de registros.

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 flujo de trabajo Node.js
  • Correlación registro-resultado
  • Paneles de error y latencia
Evidencia de implementación

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

Utilice Winston 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

    Monitoreo del flujo de trabajo Node.js

  2. 2

    Definir el contrato

    operación, request_id o job_id, estado y liberación

  3. 3

    Instrumentar el límite

    Utilice transportes y formatos de Winston para registros de diagnóstico; envíe solo los campos de terminal requeridos para una pregunta Telemetry definida.

  4. 4

    Verificar la evidencia

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

Antes de empezar

Requisitos previos y límites

  • Winston y telemetry-sh se inicializaron una vez en un servidor o proceso de trabajo
  • Nombres de operaciones estables, ID de correlación, categorías de errores y versiones
  • Una política de cierre tanto para los transportes de Winston como para las solicitudes Telemetry pendientes

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 winston-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.

winston-node

Evento Winston Structured Event Analytics

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

const logger = winston.createLogger({
  format: winston.format.json(),
  transports: [new winston.transports.Console()],
});

const startedAt = performance.now();
try {
  const result = await processImport();
  const outcome = {
    operation: "customer_import",
    job_id: jobId,
    status: "success",
    duration_ms: Math.round(performance.now() - startedAt),
    item_count: result.itemCount,
    release: process.env.APP_RELEASE,
  };

  logger.info("customer import completed", outcome);
  await telemetry.log("job_completed", outcome);
  return result;
} catch (error) {
  const outcome = {
    operation: "customer_import",
    job_id: jobId,
    status: "failed",
    duration_ms: Math.round(performance.now() - startedAt),
    error_type: classifyError(error),
    release: process.env.APP_RELEASE,
  };

  logger.error("customer import failed", { ...outcome, error });
  await telemetry.log("job_completed", outcome);
  throw error;
}

Contrato de evento

operación, request_id o job_id, estado y liberación

duration_ms, error_type, retry_count y item_count

servicio, entorno, característica y contexto de cuenta aprobado

Puntos de control de implementación

Punto de control 1

Utilice transportes y formatos de Winston para registros de diagnóstico; envíe solo los campos de terminal requeridos para una pregunta Telemetry definida.

Punto de control 2

No cree un transporte Winston que reenvíe registros arbitrarios a menos que cada campo de mensaje y metadatos tenga un esquema revisado y una política de redacción.

Punto de control 3

Pruebe el rechazo de entrega y el comportamiento de apagado por separado porque completar un transporte no elimina otro cliente de red.

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

Consulta de verificación Winston Structured Event Analytics

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

Explorar por familia de implementación

Comparar patrones de integración relacionados

Plantillas para combinar con esta integración

Más integraciones