Saltar al contenido
Telemetry
guía de integración

Trabajo de Sidekiq Telemetry

Realice un seguimiento de los resultados de ejecución, los intentos, las colas de espera, los errores y las liberaciones de Sidekiq desde el middleware del servidor sin copiar los argumentos del 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

Útil para
  • Monitoreo de reintento de Sidekiq
  • Análisis de latencia de cola
  • Fiabilidad del trabajo en segundo plano
Evidencia de implementación

Sidekiq Job Telemetry: del límite a la fila verificada

Utilice Sidekiq Job Telemetry 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 reintento de Sidekiq

  2. 2

    Definir el contrato

    job_id, job_name, queue_name, estado e intento

  3. 3

    Instrumentar el límite

    Ajustar el rendimiento en el middleware del servidor para que cada intento de ejecución tenga un resultado; use jid como identificador lógico y retry_count más uno como intento.

  4. 4

    Verificar la evidencia

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

Antes de empezar

Requisitos previos y límites

  • Un contenedor Ruby HTTP reutilizable con tiempos de espera de apertura y lectura explícitos
  • Middleware del servidor Sidekiq registrado en cada proceso de trabajo
  • Clases de trabajo estables y nombres de colas más una taxonomía de errores aprobada

Configuración de entrega

Instalar e inicializar el lado del servidor

Utilice un pequeño contenedor Net::HTTP con una clave del lado del servidor más tiempos de espera de apertura y lectura 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.

sidekiq

Evento Sidekiq Job Telemetry

ruby
class TelemetryOutcomeMiddleware
  include Sidekiq::ServerMiddleware

  def call(_job_instance, job, queue)
    started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
    status = "success"
    error_type = nil

    begin
      yield
    rescue => error
      status = "failed"
      error_type = classify_error(error)
      raise
    ensure
      TelemetryHttp.log(
        table: "job_attempt_completed",
        data: {
          job_id: job["jid"],
          job_name: job["class"],
          queue_name: queue,
          attempt: job.fetch("retry_count", -1) + 2,
          status: status,
          duration_ms: ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at) * 1000).round,
          error_type: error_type,
          release: ENV["APP_RELEASE"]
        }
      )
    end
  end
end

Contrato de evento

job_id, job_name, queue_name, estado e intento

queue_wait_ms, duration_ms, error_type, retry_exhausted y versión

item_count o contexto de cuenta aprobado derivado del trabajo, nunca argumentos serializados

Puntos de control de implementación

Punto de control 1

Ajustar el rendimiento en el middleware del servidor para que cada intento de ejecución tenga un resultado; use jid como identificador lógico y retry_count más uno como intento.

Punto de control 2

No rescate sin volver a subir porque Sidekiq debe observar la excepción para aplicar su política de reintento.

Punto de control 3

Si los eventos se emiten por intento, cree explícitamente métricas de éxito del terminal y agotamiento de reintentos para que los reintentos no inflen los totales de trabajos.

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 sidekiq

Consulta de verificación Sidekiq Job Telemetry

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

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.

Puntos de partida del esquema 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

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
colecciones completasTareas en segundo plano SQL

Explorar por familia de implementación

Comparar patrones de integración relacionados

Plantillas para combinar con esta integración

Más integraciones