Saltar al contenido
Telemetry
guía de integración

Contexto OpenTelemetry en eventos estructurados

Conecte los eventos comerciales Telemetry a los seguimientos OpenTelemetry existentes registrando identificadores de seguimiento y tramo seguros en los límites del flujo de trabajo.

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

Obtén una clave APIVer fragmento
Útil para
  • Correlación de seguimiento a evento
  • Análisis de resultados empresariales
  • Investigación de incidentes
Evidencia de implementación

OpenTelemetry Context en Structured Events: del límite a la fila verificada

Utilice OpenTelemetry Context en Structured Events 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

    Correlación de seguimiento a evento

  2. 2

    Definir el contrato

    trace_id y span_id del tramo activo

  3. 3

    Instrumentar el límite

    Este patrón enriquece un evento Telemetry con el contexto OpenTelemetry; no envía datos OTLP a Telemetry.

  4. 4

    Verificar la evidencia

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

Antes de empezar

Requisitos previos y límites

  • Un SDK OpenTelemetry existente y una configuración de propagación de contexto
  • El paquete telemetry-sh se inicializó en el lado del servidor
  • Un evento empresarial definido que complementa el diagnóstico a nivel global

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 opentelemetry

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.

opentelemetry

Evento OpenTelemetry Context en Structured Events

javascript
import { trace } from "@opentelemetry/api";

const spanContext = trace.getActiveSpan()?.spanContext();

await telemetry.log("checkout_completed", {
  status: "success",
  latency_ms: 684,
  trace_id: spanContext?.traceId,
  span_id: spanContext?.spanId,
  checkout_version: "v2",
  account_id: account.id,
});

Contrato de evento

trace_id y span_id del tramo activo

nombre del flujo de trabajo, estado, duración y categoría de error

Dimensiones seguras de cuentas, versiones o funciones

Puntos de control de implementación

Punto de control 1

Este patrón enriquece un evento Telemetry con el contexto OpenTelemetry; no envía datos OTLP a Telemetry.

Punto de control 2

Emita el resultado empresarial una vez, mientras que los intervalos conservan el tiempo a nivel de dependencia.

Punto de control 3

Trate los ID de seguimiento y extensión como campos de correlación para la búsqueda, no como dimensiones del gráfico.

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 opentelemetry

Consulta de verificación OpenTelemetry Context en Structured Events

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

Registros, métricas, seguimientos y eventosID de correlaciónOpenTelemetry JavaScript

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.
Entrega e idempotenciaProcesamiento por lotes y apagadoSolucionar problemas de ingestión

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.

Fiabilidad de la API10 campos

api_request_completed

Una solicitud de API completada.

inspeccionar contrato

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.

Explorar AlertasRevisar la evidencia del cliente

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
Fiabilidad de la APIIntermedio

Compare la confiabilidad de API por versión

¿Qué versiones coinciden con peores errores de API o latencia de cola?

Receta abierta
Fiabilidad de la APIIntermedio

Comparar dependencia p95 Latencia

¿Qué dependencias posteriores tienen la peor latencia de cola y tasa de fallas?

Receta abierta
Fiabilidad de la APIIntermedio

Medir la disponibilidad de API frente a un SLO

¿Cada servicio cumplió con su objetivo de disponibilidad diaria?

Receta abierta
Fiabilidad de la APIPrincipiante

Clasificació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 abierta
Eventos estructuradosAvanzado

Detecte picos en la tasa de errores con una línea de base móvil

¿Qué segmentos de tasa de error por hora están muy por encima de su línea de base reciente?

Receta abierta
colecciones completasFiabilidad de la API SQLEventos estructurados SQL

Explorar por familia de implementación

Comparar patrones de integración relacionados

Integraciones de nube e infraestructura TelemetryIntegraciones de registro y observabilidad Telemetry

Plantillas para combinar con esta integración

Monitor de latencia y errores de API

Observe el volumen de solicitudes, los códigos de estado, la latencia de ruta, los puntos finales fallidos y los incidentes de API que afectan al cliente.

Abrir plantilla

Más integraciones

Análisis de eventos estructurados .NET y Serilog

Agregue un evento de resultado Telemetry enfocado junto a los diagnósticos de Serilog para la latencia de solicitudes de ASP.NET, fallas, versiones e impacto en el cliente.

abrir guia

Node.js y registro estructurado exprés

Resultados de ruta de Instrument Express con plantillas de ruta estables, códigos de estado, latencia de solicitud y campos de correlación seguros.

abrir guia

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 guia