Saltar al contenido
Telemetry
guía de integración

Solicitud y flujo de trabajo de NestJS Telemetry

Instrumente a los controladores y proveedores de NestJS con resultados de ruta normalizados, latencia, errores, versiones y contexto de cuenta aprobado.

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 de API NestJS
  • Contratos de eventos basados en interceptores
  • Fiabilidad del controlador por versión
Evidencia de implementación

NestJS Request and Workflow Telemetry: del límite a la fila verificada

Utilice NestJS Request and Workflow 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 de API NestJS

  2. 2

    Definir el contrato

    request_id, controlador, manejador, route_template y método

  3. 3

    Instrumentar el límite

    Aplique un interceptor en el alcance útil más limitado y derive route_template a partir de los metadatos del marco en lugar de req.originalUrl.

  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

  • telemetry-sh inicializado en un proveedor o módulo NestJS solo de servidor
  • Un solucionador de plantilla de ruta que evita URL sin formato e identificadores de ruta
  • Una taxonomía de excepción y una política de entrega sin bloqueo versus entrega duradera

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 nestjs

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.

nestjs

Evento NestJS Request and Workflow Telemetry

javascript
@Injectable()
export class OutcomeInterceptor implements NestInterceptor {
  intercept(context: ExecutionContext, next: CallHandler) {
    const request = context.switchToHttp().getRequest();
    const response = context.switchToHttp().getResponse();
    const startedAt = performance.now();
    let errorType: string | undefined;

    return next.handle().pipe(
      catchError((error) => {
        errorType = classifyError(error);
        throw error;
      }),
      finalize(() => {
        const statusCode = response.statusCode;
        void telemetry.log("api_request_completed", {
          request_id: request.id,
          controller: context.getClass().name,
          handler: context.getHandler().name,
          route_template: resolveRouteTemplate(context),
          method: request.method,
          status_code: statusCode,
          status: statusCode >= 500 ? "failed" : "success",
          latency_ms: Math.round(performance.now() - startedAt),
          error_type: errorType,
          release: process.env.APP_RELEASE,
        }).catch(recordTelemetryFailure);
      }),
    );
  }
}

Contrato de evento

request_id, controlador, manejador, route_template y método

estado, status_code, latency_ms, error_type y versión

tenant_id, plan o característica solo cuando se apruebe explícitamente

Puntos de control de implementación

Punto de control 1

Aplique un interceptor en el alcance útil más limitado y derive route_template a partir de los metadatos del marco en lugar de req.originalUrl.

Punto de control 2

El ejemplo tiene en cuenta la promesa de entrega pero no retrasa la respuesta HTTP; utilice una bandeja de salida propiedad de la aplicación cuando el evento sea crítico para el cumplimiento o la facturación.

Punto de control 3

Mantenga los objetos de excepción, cuerpos de solicitud, encabezados de autorización, cookies, cadenas de consulta y parámetros de ruta sin procesar fuera de la carga útil.

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 nestjs

Consulta de verificación NestJS Request and Workflow Telemetry

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