Saltar al contenido
Telemetry
guía de integración

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.

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
  • Monitoreo de API Python
  • Análisis de latencia de cola
  • Depuración del impacto en el cliente
Evidencia de implementación

Python and FastAPI Structured Logging: del límite a la fila verificada

Utilice Python and FastAPI 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. 1

    Elige el resultado

    Monitoreo de API Python

  2. 2

    Definir el contrato

    route_template, método y status_code

  3. 3

    Instrumentar el límite

    Utilice la ruta de ruta coincidente en lugar de la URL sin formato para que los identificadores no creen grupos ilimitados.

  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 instalado en el entorno de servicio
  • TelemetryAsync inicializado con una clave API del lado del servidor
  • Un ID de solicitud proporcionado por middleware confiable o generado en el ingreso

Configuración de entrega

Instalar e inicializar el lado del servidor

Inicialice Telemetry para código síncrono o TelemetryAsync para código asíncrono una vez por proceso con una clave del lado del servidor. 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 python-fastapi

Instalación pip

bash
python -m pip 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.

python-fastapi

Evento Python and FastAPI Structured Logging

python
@app.middleware("http")
async def record_request(request, call_next):
    started_at = time.perf_counter()
    response = await call_next(request)
    route = request.scope.get("route")

    await telemetry.log("api_request_completed", {
        "route_template": getattr(route, "path", "unmatched"),
        "method": request.method,
        "status_code": response.status_code,
        "status": "failed" if response.status_code >= 500 else "success",
        "latency_ms": round((time.perf_counter() - started_at) * 1000),
        "request_id": request.headers.get("x-request-id"),
    })
    return response

Contrato de evento

route_template, método y status_code

estado, latency_ms y error_type

request_id, entorno y lanzamiento

Puntos de control de implementación

Punto de control 1

Utilice la ruta de ruta coincidente en lugar de la URL sin formato para que los identificadores no creen grupos ilimitados.

Punto de control 2

Espere la ingesta asincrónica después de conocer el resultado de la respuesta y defina el comportamiento de falla que no ocultará la respuesta de la API.

Punto de control 3

Agregue instrumentación de controlador de excepciones para fallas que omiten la finalización normal del middleware.

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 python-fastapi

Consulta de verificación Python and FastAPI Structured Logging

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.

SDK PythonLatencia de API SQLMiddleware rápido API

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 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 Python TelemetryIntegraciones 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

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.

abrir guia

Monitoreo 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