Saltar al contenido
guía de integración

Registro estructurado Python y FastAPI

Registra el estado de respuesta de FastAPI y la latencia hasta las cabeceras con el cliente asíncrono de Telemetry y nombres de ruta normalizados.

Revisado por el equipo de producto Telemetry en . Revisamos qué eventos enviar, qué datos excluir y cómo añadir el código. Quién revisa esta página

Usa el prompt de configuración para instrumentar una ruta existente. No necesitas registrarte para probar.

Útil para
  • Monitoreo de API Python
  • Análisis de latencia de cola
  • Depuración del impacto en el cliente
Evidencia de implementación

Envía y verifica eventos con Python and FastAPI structured logging

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

    Emitir en el resultado

    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 fastapi_response_observed for one correctly typed terminal row.

Antes de empezar

Antes de empezar

  • telemetry-sh instalado en el entorno de servicio
  • TelemetryAsync inicializado con una clave API del lado del servidor
  • Un ID de solicitud generado que no copie cabeceras de solicitud no fiables

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
import asyncio
import time
import uuid

# app and the initialized TelemetryAsync client already exist.
@app.middleware("http")
async def record_request(request, call_next):
    started_at = time.perf_counter()
    request_id = uuid.uuid4().hex
    response = await call_next(request)
    route = request.scope.get("route")
    latency_ms = round((time.perf_counter() - started_at) * 1000)

    try:
        await asyncio.wait_for(telemetry.log("fastapi_response_observed", {
            "route_template": getattr(route, "path", "unmatched"),
            "method": request.method,
            "status_code": response.status_code,
            "status": "response_observed",
            "latency_ms": latency_ms,
            "request_id": request_id,
        }), timeout=1.0)
    except Exception:
        # Best effort: connect this to your existing safe diagnostics.
        pass
    return response

Esquema del evento

route_template, método y status_code

status y latency_ms al observar las cabeceras de respuesta

request_id generado localmente

Comprueba tu configuració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

Este ejemplo observa las cabeceras de respuesta, no la finalización del cuerpo transmitido ni el éxito de la operación de negocio; latency_ms termina cuando retorna call_next.

Punto de control 3

Un tiempo de espera cooperativo de un segundo para el envío y una protección frente a errores conservan la respuesta. En producción aún se necesitan una cola limitada y diagnósticos seguros de fallos.

Punto de control 4

Las excepciones de aplicación no controladas omiten este evento. Instrumenta los manejadores de excepciones por separado; la cancelación de la solicitud debe seguir propagándose.

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 fastapi_response_observed
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.

Dónde registrar eventos

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.

Ejemplos de esquemas 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

Más ejemplos de 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 de consultasFiabilidad 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