Saltar al contenido
guía de integración

Monitoreo de eventos estructurados de Django y Apio

Registra los estados de cada intento de una tarea Celery sin confundir los reintentos con fallos definitivos ni cambiar el resultado de la tarea.

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

Útil para
  • Resultados del worker de Celery
  • Análisis de reintento de apio
  • Correlación entre reintentos y tareas
Evidencia de implementación

Envía y verifica eventos con Django and Celery structured event monitoring

Observa un intento de tarea Celery, conserva su resultado original y verifica el estado registrado antes de crear gráficos.

  1. 1

    Elige el intento

    Resultados del worker de Celery

  2. 2

    Definir el contrato

    job_name, job_id, queue_name, observed_state y status

  3. 3

    Registra el estado del intento

    Este ejemplo registra SUCCESS, FAILURE y RETRY de task_postrun como estados de intento; un reintento no es un fallo definitivo.

  4. 4

    Verificar la evidencia

    Ejecuta una tarea conocida y consulta celery_task_attempt_finished para verificar el estado del intento observado; una fila de reintento no es un resultado final.

Antes de empezar

Antes de empezar

  • Un TELEMETRY_API_KEY del lado del servidor
  • Celery instalado en el proceso del worker
  • Importa este módulo al iniciar el worker de Celery

Configuración de entrega

Instalar e inicializar el lado del servidor

Este módulo del worker de Celery envía eventos con HTTP de la biblioteca estándar de Python; no necesita instalar ni inicializar el SDK de Telemetry. 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. 1Carga el módulo de señales una vez por worker y separa los errores de envío de los resultados de las tareas.
  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.

django-celery

Evento Django and Celery structured event monitoring

python
import json
import logging
import os
from urllib.request import Request, urlopen
from celery.signals import task_postrun


def report_export_failure():
    try:
        logging.getLogger(__name__).warning("Telemetry export unavailable")
    except Exception:
        pass


@task_postrun.connect(weak=False)
def record_task(sender=None, task_id=None, state=None, **kwargs):
    try:
        status = {"SUCCESS": "success", "FAILURE": "failed",
                  "RETRY": "retry_scheduled"}.get(state)
        if status is None:
            return  # Other states need their own observed lifecycle handlers.
        key = os.getenv("TELEMETRY_API_KEY")
        if not key:
            report_export_failure()
            return
        delivery = sender.request.delivery_info or {}
        payload = {
            "table": "celery_task_attempt_finished",
            "data": {
                "job_name": sender.name,
                "job_id": task_id,
                "queue_name": delivery.get("routing_key"),
                "observed_state": state,
                "status": status,
                "attempt": sender.request.retries + 1,
            },
        }
        request = Request("https://api.telemetry.sh/log",
                          data=json.dumps(payload).encode("utf-8"),
                          headers={"Authorization": key,
                                   "Content-Type": "application/json",
                                   "User-Agent": "telemetry-agent/1.0"},
                          method="POST")
        # Socket timeout, not a hard end-to-end deadline. Export can be lost.
        with urlopen(request, timeout=1.0) as response:
            if not 200 <= response.status < 300:
                report_export_failure()
    except Exception:
        # Do not let export or metadata errors replace the task outcome.
        report_export_failure()

Esquema del evento

job_name, job_id, queue_name, observed_state y status

attempt es retries + 1 para la ejecución observada

Solo metadatos del worker; revisa los identificadores de tarea y cola antes de enviarlos

Comprueba tu configuración

Punto de control 1

Este ejemplo registra SUCCESS, FAILURE y RETRY de task_postrun como estados de intento; un reintento no es un fallo definitivo.

Punto de control 2

Conserva el ID de la tarea lógica durante los reintentos y registra retries + 1 como número de intento.

Punto de control 3

Importa este módulo una vez en cada proceso del worker. No instrumenta solicitudes de Django ni mide la duración de las tareas.

Punto de control 4

El envío se realiza sin garantía, con un tiempo límite de socket de un segundo; añade latencia al worker y no implementa un plazo total estricto, entrega duradera ni reintentos del exportador.

Punto de control 5

No incluyas argumentos, resultados, texto de excepciones, URL ni credenciales en el evento. La pérdida o terminación del worker puede impedir task_postrun, por lo que los eventos ausentes tienen estado desconocido.

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 django-celery

Consulta de verificación Django and Celery structured event monitoring

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

Explorar por familia de implementación

Comparar patrones de integración relacionados

Plantillas para combinar con esta integración

Más integraciones