Saltar al contenido
Telemetry
guía de integración

Integració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.

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

Supervisar los resultados de las solicitudes de PhoenixVer fragmento
Útil para
  • Confiabilidad de la API de Phoenix
  • Latencia de ruta por lanzamiento
  • Análisis controlado de fallos de solicitudes
Evidencia de implementación

Elixir Phoenix Telemetry Integration: del límite a la fila verificada

Utilice Elixir Phoenix Telemetry Integration 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

    Confiabilidad de la API de Phoenix

  2. 2

    Definir el contrato

    route_template, método, status_code, estado, duration_ms y versión

  3. 3

    Instrumentar el límite

    Conéctelo una vez durante el inicio de la aplicación y maneje el punto final del terminal Phoenix o el evento de detención del envío del enrutador; convierta unidades de duración nativas con System.convert_time_unit/3.

  4. 4

    Verificar la evidencia

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

Antes de empezar

Requisitos previos y límites

  • Telemetría de punto final de Phoenix habilitada y un proceso de aplicación supervisado que instala controladores una vez
  • Un cliente HTTP del lado del servidor con tiempos de espera de conexión y respuesta limitados
  • Una taxonomía de plantilla de ruta, estado y error controlado que excluye los parámetros de solicitud y el contenido de la conexión.

Configuración de entrega

Instalar e inicializar el lado del servidor

Utilice un proceso de cliente supervisado con una clave del lado del servidor, tiempos de espera HTTP limitados y límites de reintento explícitos. 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.

  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.

elixir-phoenix

Evento Elixir Phoenix Telemetry Integration

elixir
defmodule MyAppWeb.TelemetryOutcome do
  def attach do
    :telemetry.attach(
      "telemetry-phoenix-request-outcome",
      [:phoenix, :endpoint, :stop],
      &__MODULE__.handle_stop/4,
      nil
    )
  end

  def handle_stop(_event, measurements, metadata, _config) do
    conn = metadata.conn

    event = %{
      route_template: conn.private[:phoenix_route] || "unmatched",
      method: conn.method,
      status_code: conn.status,
      status: if(conn.status < 500, do: "success", else: "failed"),
      duration_ms:
        System.convert_time_unit(measurements.duration, :native, :millisecond),
      release: System.get_env("APP_RELEASE", "development")
    }

    # Supervise this app-owned client and give it bounded HTTP timeouts.
    MyApp.TelemetryIngest.enqueue("phoenix_request_completed", event)
  end
end

Contrato de evento

route_template, método, status_code, estado, duration_ms y versión

request_id, account_id, entorno, node_role y error_type controlado cuando esté aprobado

Sin parámetros de conexión, cadena de consulta, cuerpo de solicitud o respuesta, sesión, encabezado de autorización, seguimiento de pila ni metadatos sin restricciones

Puntos de control de implementación

Punto de control 1

Conéctelo una vez durante el inicio de la aplicación y maneje el punto final del terminal Phoenix o el evento de detención del envío del enrutador; convierta unidades de duración nativas con System.convert_time_unit/3.

Punto de control 2

Los eventos de detención de Phoenix y Plug no constituyen un intervalo distribuido completo, y Plug documenta casos en los que no se emite un evento de detención después de un error. Conserve las herramientas de seguimiento y excepción para ese límite de diagnóstico.

Punto de control 3

Reenvíe de forma asincrónica a través de una ruta de entrega limitada y supervisada para que la latencia HTTP de telemetría no pueda extender la solicitud del usuario ni desestabilizar el buzón de la aplicación.

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 elixir-phoenix

Consulta de verificación Elixir Phoenix Telemetry Integration

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

Guía de telemetría de aplicacionesMonitoreo de confiabilidad APILatencia de API SQLEventos de telemetría de PhoenixLímite del ciclo de vida de Plug.Telemetry

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 APIPrincipiante

Calcular el rendimiento de las solicitudes de API por ruta

¿Qué rutas API procesan la mayor cantidad de solicitudes por minuto?

Receta abierta
Fiabilidad de la APIPrincipiante

Calcular la tasa de errores de API por ruta

¿Qué rutas API tienen la tasa de error 5xx significativa más alta?

Receta abierta
Fiabilidad de la APIIntermedio

Calcule la latencia API p50, p95 y p99

¿Qué puntos finales tienen la peor latencia de cola?

Receta abierta
Fiabilidad de la APIPrincipiante

Calcular la tasa de tiempo de espera de API por ruta

¿Qué rutas API caducan con suficiente frecuencia como para afectar a los usuarios?

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 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
colecciones completasFiabilidad de la API SQL

Explorar por familia de implementación

Comparar patrones de integración relacionados

Integraciones del marco de aplicación 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

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

Análisis de eventos estructurados de Pino

Empareje los registros de diagnóstico de Pino con eventos de resultados delimitados de Telemetry para el análisis de confiabilidad de solicitudes, trabajos y productos de Node.js.

abrir guia