Node.js and Express Structured Logging: del límite a la fila verificada
Utilice Node.js and Express Structured Logging 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
Elige el resultado
Monitoreo de la tasa de errores de API
- 2
Definir el contrato
route_template, método y status_code
- 3
Instrumentar el límite
Adjunte el oyente antes de llamar a continuación para que registre el estado de la respuesta final.
- 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
- Una variable de entorno TELEMETRY_API_KEY del lado del servidor
- El paquete telemetry-sh se inicializó durante el inicio de la aplicación
- Plantillas de ruta estables en lugar de URL de solicitud sin formato
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 npm
npm install telemetry-sh- 1Prepare un cliente de entrega del lado del servidor reutilizable con comportamiento de red limitado.
- 2Agregue el evento de resultado en el límite de éxito, error, reintento o tiempo de espera.
- 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.
Evento Node.js and Express Structured Logging
app.use((req, res, next) => {
const startedAt = performance.now();
res.on("finish", async () => {
await telemetry.log("api_request_completed", {
route_template: req.route?.path ?? "unmatched",
method: req.method,
status_code: res.statusCode,
status: res.statusCode >= 500 ? "failed" : "success",
latency_ms: Math.round(performance.now() - startedAt),
request_id: req.id,
release: process.env.APP_RELEASE,
});
});
next();
});Contrato de evento
route_template, método y status_code
estado y categorizado error_type
latency_ms, request_id y versión
Puntos de control de implementación
Punto de control 1
Adjunte el oyente antes de llamar a continuación para que registre el estado de la respuesta final.
Punto de control 2
Utilice el patrón de ruta Express coincidente y la URL base del enrutador; nunca envíe cadenas de consulta ni cuerpos de solicitud sin formato.
Punto de control 3
Decida si las solicitudes abortadas necesitan un estado separado y ejerza esa rama en una prueba.
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.
Consulta de verificación Node.js and Express Structured Logging
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;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
Contratos de eventos para este flujo de trabajo
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.
Calcular la tasa de errores de API por ruta
¿Qué rutas API tienen la tasa de error 5xx significativa más alta?
Receta abiertaCalcule la latencia API p50, p95 y p99
¿Qué puntos finales tienen la peor latencia de cola?
Receta abiertaCalcular la tasa de tiempo de espera de API por ruta
¿Qué rutas API caducan con suficiente frecuencia como para afectar a los usuarios?
Receta abiertaComparar dependencia p95 Latencia
¿Qué dependencias posteriores tienen la peor latencia de cola y tasa de fallas?
Receta abiertaClasificación de huellas dactilares de error por impacto en el cliente
¿Qué grupos de errores afectan a la mayoría de las cuentas de clientes?
Receta abiertaExplorar por familia de implementación
Comparar patrones de integración relacionados
Plantillas para combinar con esta integración
Más integraciones
Registro estructurado Python y FastAPI
Capture los resultados y la latencia de las solicitudes FastAPI con el cliente asincrónico Telemetry y los nombres de ruta normalizados.
abrir guiaIntegración de Elixir Phoenix Telemetry
Adjunte a los eventos del ciclo de vida de la solicitud de Phoenix y reenvíe el resultado de una solicitud de terminal limitada sin copiar datos de conexión, parámetros o texto de excepción.
abrir guiaMonitoreo de eventos estructurados de Spring Boot
Registre Spring MVC y los resultados del flujo de trabajo programado a través de la API HTTP de Telemetry con rutas estables, latencia, estado y contexto de seguimiento.
abrir guia