Saltar al contenido
guía de integración

Trabajo de Sidekiq Telemetry

Registra los resultados y la duración del bloque de trabajo de Sidekiq sin cambiar el resultado del worker ni copiar los argumentos.

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
  • Monitoreo de reintento de Sidekiq
  • Duración de ejecución del trabajo
  • Fiabilidad del trabajo en segundo plano
Evidencia de implementación

Envía y verifica eventos con Sidekiq job telemetry

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, attempt, status, duration_ms y release

  3. 3

    Emitir en el resultado

    El inicializador registra middleware del servidor. El mismo jid lógico se conserva entre reintentos de Sidekiq; el primer intento es 1 y retry_count 0 significa intento 2. Los metadatos de reintento inválidos permanecen desconocidos.

  4. 4

    Verificar la evidencia

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

Antes de empezar

Antes de empezar

  • Una TELEMETRY_API_KEY del servidor con permiso de escritura
  • Coloca este ejemplo en config/initializers/telemetry_sidekiq.rb y cárgalo una vez en cada proceso worker
  • Sidekiq 7 o posterior con Sidekiq::ServerMiddleware

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
# config/initializers/telemetry_sidekiq.rb
require "sidekiq"
require "json"
require "net/http"
require "uri"

module TelemetrySidekiqAttempts
  def self.delivery_failed
    warn "Telemetry job event delivery failed."
  rescue StandardError
    # A broken diagnostic sink must not change the job outcome.
  end

  def self.log(fields)
    key = ENV["TELEMETRY_API_KEY"]
    return if key.nil? || key.empty?

    uri = URI("https://api.telemetry.sh/log")
    request = Net::HTTP::Post.new(uri)
    request["Authorization"] = key
    request["Content-Type"] = "application/json"
    request.body = { table: "job_attempt_completed", data: fields }.to_json
    http = Net::HTTP.new(uri.host, uri.port)
    http.use_ssl = true
    http.open_timeout = 1
    http.read_timeout = 1
    http.write_timeout = 1
    http.max_retries = 0
    response = http.start { |client| client.request(request) }
    delivery_failed unless response.is_a?(Net::HTTPSuccess)
  rescue StandardError
    delivery_failed
  end
end

class TelemetryOutcomeMiddleware
  include Sidekiq::ServerMiddleware

  def call(_job_instance, job, queue)
    started = Process.clock_gettime(Process::CLOCK_MONOTONIC)
    status = "not_returned"
    begin
      result = yield
      status = "returned"
      result
    rescue StandardError
      status = "raised"
      raise
    ensure
      begin
        retry_count = job["retry_count"]
        attempt = if !job.key?("retry_count")
          1
        elsif retry_count.is_a?(Integer) && retry_count >= 0
          retry_count + 2
        end
        TelemetrySidekiqAttempts.log({
          job_id: job["jid"],
          job_name: job["class"],
          queue_name: queue,
          attempt: attempt,
          status: status,
          duration_ms: ((Process.clock_gettime(
            Process::CLOCK_MONOTONIC
          ) - started) * 1000).round(2),
          release: ENV["APP_RELEASE"]
        })
      rescue StandardError
        TelemetrySidekiqAttempts.delivery_failed
      end
    end
  end
end

Sidekiq.configure_server do |config|
  config.server_middleware do |chain|
    chain.add TelemetryOutcomeMiddleware
  end
end

Esquema del evento

job_id, job_name, queue_name, attempt, status, duration_ms y release

Sin argumentos del trabajo, cuerpos de resultados, mensajes de excepciones ni datos de cuentas de la aplicación

Comprueba tu configuración

Punto de control 1

El inicializador registra middleware del servidor. El mismo jid lógico se conserva entre reintentos de Sidekiq; el primer intento es 1 y retry_count 0 significa intento 2. Los metadatos de reintento inválidos permanecen desconocidos.

Punto de control 2

Que el bloque termine no demuestra la entrega posterior. StandardError se registra como raised y se vuelve a lanzar sin cambios; las demás salidas sin retorno permanecen not_returned.

Punto de control 3

El ejemplo no mide la espera en cola, el agotamiento de reintentos ni la política de reintentos independiente de Active Job. Añádelos en sus propios puntos verificados del ciclo de vida.

Punto de control 4

La duración usa un reloj monotónico y excluye el tiempo de exportación síncrona. La exportación sigue ocupando el worker y añade latencia de procesamiento.

Punto de control 5

Los fallos de transporte, respuestas no 2xx, codificación, metadatos y diagnóstico quedan contenidos. Si falta la clave, se omite la exportación sin cambiar el resultado del trabajo ni la excepción original.

Punto de control 6

Los tiempos de espera de conexión, lectura y escritura son de un segundo cada uno, no un límite total estricto. No hay reintento de exportación, cola persistente ni vaciado al cerrar; usa una bandeja de salida de la aplicación si no puedes aceptar pérdidas.

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.

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 consultasTareas 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