Saltar al contenido
Telemetry
guía de integración

Bus de servicio de Azure Telemetry

Realice un seguimiento de los envíos, recepciones, renovación de bloqueos, liquidación, reenvío, aplazamiento y resultados de mensajes fallidos de Azure Service Bus sin recopilar cuerpos de mensajes.

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 en la entrega del Service Bus
  • Análisis de bloqueo y liquidación de mensajes.
  • Monitoreo de mensajes fallidos
Evidencia de implementación

Azure Service Bus Telemetry: del límite a la fila verificada

Utilice Azure Service Bus 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

    Fiabilidad en la entrega del Service Bus

  2. 2

    Definir el contrato

    message_id, message_type, entity_name, session_id_category y versión

  3. 3

    Instrumentar el límite

    Un acuse de recibo de envío y una liquidación de recepción describen límites diferentes; registrar el resultado comercial final por separado cuando ocurra más adelante.

  4. 4

    Verificar la evidencia

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

Antes de empezar

Requisitos previos y límites

  • @azure/service-bus y telemetry-sh inicializados en un productor o procesador confiable
  • Definiciones de entidad estable, tipo de mensaje, flujo de trabajo y resultados lógicos
  • Procesamiento idempotente con políticas explícitas de completo, abandono, aplazamiento y letra muerta

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 azure-service-bus

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.

azure-service-bus

Evento Azure Service Bus Telemetry

javascript
await telemetry.log("service_bus_message_completed", {
  message_id: message.messageId,
  message_type: "customer_import",
  entity_name: "customer-imports",
  status: "success",
  delivery_count: message.deliveryCount,
  wait_ms: Date.now() - message.enqueuedTimeUtc.getTime(),
  duration_ms: Math.round(performance.now() - startedAt),
  lock_lost: false,
  settlement: "completed",
  workflow: "customer_import",
  service: "import-worker",
  release: process.env.APP_RELEASE,
});

Contrato de evento

message_id, message_type, entity_name, session_id_category y versión

estado, delivery_count, wait_ms, duration_ms, lock_lost y error_type

liquidación, dead_letter_reason_category, flujo de trabajo, servicio y entorno

Puntos de control de implementación

Punto de control 1

Un acuse de recibo de envío y una liquidación de recepción describen límites diferentes; registrar el resultado comercial final por separado cuando ocurra más adelante.

Punto de control 2

Los bloqueos de mensajes pueden caducar y las entregas pueden repetirse, así que conserve message_id, delivery_count, el estado de bloqueo perdido y el resultado de la liquidación.

Punto de control 3

No registre cuerpos de mensajes, propiedades de aplicaciones con valores privados, cadenas de conexión, tokens SAS ni descripciones de mensajes no entregados sin restricciones.

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 azure-service-bus

Consulta de verificación Azure Service Bus Telemetry

sql
SELECT *
FROM service_bus_message_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 completasTareas en segundo plano SQL

Explorar por familia de implementación

Comparar patrones de integración relacionados

Plantillas para combinar con esta integración

Más integraciones