123456789_123456789_123456789_123456789_123456789_

Class: ActiveJob::StructuredEventSubscriber

Do not use. This class is for internal use only.

Constant Summary

::ActiveSupport::StructuredEventSubscriber - Inherited

DEBUG_CHECK

Class Attribute Summary

::ActiveSupport::StructuredEventSubscriber - Inherited

.debug_methods, .debug_methods?

::ActiveSupport::Subscriber - Inherited

.namespace, .notifier, .subscriber

Class Method Summary

::ActiveSupport::StructuredEventSubscriber - Inherited

.attach_to, .new, .debug_only, .set_silenced_events

::ActiveSupport::Subscriber - Inherited

.attach_to

Attach the subscriber to a namespace.
.detach_from

Detach the subscriber from a namespace.
.method_added

Adds event subscribers for all new methods added to the class.
.new, .subscribers, .add_event_subscriber, .fetch_public_methods, .find_attached_subscriber, .invalid_event?, .pattern_subscribed?, .prepare_pattern, .remove_event_subscriber

Instance Attribute Summary

::ActiveSupport::StructuredEventSubscriber - Inherited

#silenced_events=

::ActiveSupport::Subscriber - Inherited

#patterns

Instance Method Summary

::ActiveSupport::StructuredEventSubscriber - Inherited

#call,
#emit_debug_event

Like emit_event, but only emits when the event reporter is in debug mode.
#emit_event

Emit a structured event via Rails.event.notify.
#silenced?, #handle_event_error

::ActiveSupport::Subscriber - Inherited

#call

Constructor Details

This class inherits a constructor from ActiveSupport::StructuredEventSubscriber

Instance Method Details

#discard(event)

[ GitHub ] 

  


# File 'activejob/lib/active_job/structured_event_subscriber.rb', line 137



def discard(event)
  job = event.payload[:job]
  exception = event.payload[:error]

  emit_event("active_job.discarded",
    job_class: job.class.name,
    job_id: job.job_id,
    exception_class: exception.class.name,
    exception_message: exception.message
  )
end


  








  

    #enqueue(event)  
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/structured_event_subscriber.rb', line 7



def enqueue(event)
  job = event.payload[:job]
  adapter = event.payload[:adapter]
  exception = event.payload[:exception_object] || job.enqueue_error
  payload = {
    job_class: job.class.name,
    job_id: job.job_id,
    queue: job.queue_name,
    adapter: ActiveJob.adapter_name(adapter),
    aborted: event.payload[:aborted],
  }

  if exception
    payload[:exception_class] = exception.class.name
    payload[:exception_message] = exception.message
  end

  if job.class.log_arguments?
    payload[:arguments] = job.arguments
  end

  emit_event("active_job.enqueued", payload)
end


  








  

    #enqueue_all(event)  
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/structured_event_subscriber.rb', line 56



def enqueue_all(event)
  jobs = event.payload[:jobs]
  adapter = event.payload[:adapter]
  enqueued_count = event.payload[:enqueued_count].to_i
  failed_count = jobs.size - enqueued_count

  emit_event("active_job.bulk_enqueued",
    adapter: ActiveJob.adapter_name(adapter),
    job_count: jobs.size,
    enqueued_count: enqueued_count,
    failed_enqueue_count: failed_count,
    enqueued_classes: jobs.filter_map do |job|
      job.class.name if jobs.count == enqueued_count || job.successfully_enqueued?
    end.tally
  )
end


  








  

    #enqueue_at(event)  
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/structured_event_subscriber.rb', line 31



def enqueue_at(event)
  job = event.payload[:job]
  adapter = event.payload[:adapter]
  exception = event.payload[:exception_object] || job.enqueue_error
  payload = {
    job_class: job.class.name,
    job_id: job.job_id,
    queue: job.queue_name,
    scheduled_at: job.scheduled_at,
    adapter: ActiveJob.adapter_name(adapter),
    aborted: event.payload[:aborted],
  }

  if exception
    payload[:exception_class] = exception.class.name
    payload[:exception_message] = exception.message
  end

  if job.class.log_arguments?
    payload[:arguments] = job.arguments
  end

  emit_event("active_job.enqueued_at", payload)
end


  








  

    #enqueue_retry(event)  
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/structured_event_subscriber.rb', line 109



def enqueue_retry(event)
  job = event.payload[:job]
  exception = event.payload[:error]
  wait = event.payload[:wait]

  emit_event("active_job.retry_scheduled",
    job_class: job.class.name,
    job_id: job.job_id,
    executions: job.executions,
    wait_seconds: wait.to_i,
    exception_class: exception&.class&.name,
    exception_message: exception&.message
  )
end


  








  

    #interrupt(event)  
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/structured_event_subscriber.rb', line 149



def interrupt(event)
  job = event.payload[:job]
  description = event.payload[:description]
  reason = event.payload[:reason]

  emit_event("active_job.interrupt",
    job_class: job.class.name,
    job_id: job.job_id,
    description: description,
    reason: reason,
  )
end


  








  

    #perform(event)  
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/structured_event_subscriber.rb', line 87



def perform(event)
  job = event.payload[:job]
  exception = event.payload[:exception_object]
  adapter = event.payload[:adapter]
  payload = {
    job_class: job.class.name,
    job_id: job.job_id,
    queue: job.queue_name,
    adapter: ActiveJob.adapter_name(adapter),
    aborted: event.payload[:aborted],
    duration: event.duration.round(2),
  }

  if exception
    payload[:exception_class] = exception.class.name
    payload[:exception_message] = exception.message
    payload[:exception_backtrace] = exception.backtrace
  end

  emit_event("active_job.completed", payload)
end


  








  

    #perform_start(event)  
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/structured_event_subscriber.rb', line 73



def perform_start(event)
  job = event.payload[:job]
  payload = {
    job_class: job.class.name,
    job_id: job.job_id,
    queue: job.queue_name,
    enqueued_at: job.enqueued_at&.utc&.iso8601(9),
  }
  if job.class.log_arguments?
    payload[:arguments] = job.arguments
  end
  emit_event("active_job.started", payload)
end


  








  

    #resume(event)  
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/structured_event_subscriber.rb', line 162



def resume(event)
  job = event.payload[:job]
  description = event.payload[:description]

  emit_event("active_job.resume",
    job_class: job.class.name,
    job_id: job.job_id,
    description: description,
  )
end


  








  

    #retry_stopped(event)  
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/structured_event_subscriber.rb', line 124



def retry_stopped(event)
  job = event.payload[:job]
  exception = event.payload[:error]

  emit_event("active_job.retry_stopped",
    job_class: job.class.name,
    job_id: job.job_id,
    executions: job.executions,
    exception_class: exception.class.name,
    exception_message: exception.message
  )
end


  








  

    #step(event)  
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/structured_event_subscriber.rb', line 197



def step(event)
  job = event.payload[:job]
  step = event.payload[:step]
  exception = event.payload[:exception_object]
  payload = {
    job_class: job.class.name,
    job_id: job.job_id,
    step: step.name,
    cursor: step.cursor,
    interrupted: event.payload[:interrupted],
    duration: event.duration.round(2),
  }

  if exception
    payload[:exception_class] = exception.class.name
    payload[:exception_message] = exception.message
  end

  emit_event("active_job.step", payload)
end


  








  

    #step_skipped(event)  
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/structured_event_subscriber.rb', line 173



def step_skipped(event)
  job = event.payload[:job]
  step = event.payload[:step]

  emit_event("active_job.step_skipped",
    job_class: job.class.name,
    job_id: job.job_id,
    step: step.name,
  )
end


  








  

    #step_started(event)  
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/structured_event_subscriber.rb', line 184



def step_started(event)
  job = event.payload[:job]
  step = event.payload[:step]

  emit_event("active_job.step_started",
    job_class: job.class.name,
    job_id: job.job_id,
    step: step.name,
    cursor: step.cursor,
    resumed: step.resumed?,
  )
end