Class: Sidekiq::Processor

Inherits:
Object
  • Object
show all
Includes:
Util
Defined in:
lib/sidekiq/processor.rb

Overview

The Processor is a standalone thread which:

  1. fetches a job from Redis

  2. executes the job

a. instantiate the Worker
b. run the middleware chain
c. call #perform

A Processor can exit due to shutdown (processor_stopped) or due to an error during job execution (processor_died)

If an error occurs in the job execution, the Processor calls the Manager to create a new one to replace itself and exits.

Constant Summary collapse

WORKER_STATE = 
Concurrent::Map.new
PROCESSED = 
Concurrent::AtomicFixnum.new
FAILURE = 
Concurrent::AtomicFixnum.new

Constants included from Util

Util::EXPIRY

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Util

#fire_event, #hostname, #identity, #logger, #process_nonce, #redis, #safe_thread, #watchdog

Methods included from ExceptionHandler

#handle_exception

Constructor Details

#initialize(mgr) ⇒ Processor

Returns a new instance of Processor.



31
32
33
34
35
36
37
38
 
# File 'lib/sidekiq/processor.rb', line 31

def initialize(mgr)
  @mgr = mgr
  @down = false
  @done = false
  @job = nil
  @thread = nil
  @strategy = (mgr.options[:fetch] || Sidekiq::BasicFetch).new(mgr.options)
end

Instance Attribute Details

#job ⇒ Object (readonly)

Returns the value of attribute job.



29
30
31
 
# File 'lib/sidekiq/processor.rb', line 29

def job
  @job
end

#thread ⇒ Object (readonly)

Returns the value of attribute thread.



28
29
30
 
# File 'lib/sidekiq/processor.rb', line 28

def thread
  @thread
end

Instance Method Details

#cloned(ary) ⇒ Object

Deep clone the arguments passed to the worker so that if the job fails, what is pushed back onto Redis hasn’t been mutated by the worker.



180
181
182
 
# File 'lib/sidekiq/processor.rb', line 180

def cloned(ary)
  Marshal.load(Marshal.dump(ary))
end

#execute_job(worker, cloned_args) ⇒ Object 



150
151
152
 
# File 'lib/sidekiq/processor.rb', line 150

def execute_job(worker, cloned_args)
  worker.perform(*cloned_args)
end

#fetch ⇒ Object 



94
95
96
97
98
99
100
101
102
 
# File 'lib/sidekiq/processor.rb', line 94

def fetch
  j = get_one
  if j && @done
    j.requeue
    nil
  else
    j
  end
end

#get_one ⇒ Object 



83
84
85
86
87
88
89
90
91
92
 
# File 'lib/sidekiq/processor.rb', line 83

def get_one
  begin
    work = @strategy.retrieve_work
    (logger.info { "Redis is online, #{Time.now - @down} sec downtime" }; @down = nil) if @down
    work
  rescue Sidekiq::Shutdown
  rescue => ex
    handle_fetch_exception(ex)
  end
end

#handle_fetch_exception(ex) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/sidekiq/processor.rb', line 104

def handle_fetch_exception(ex)
  if !@down
    @down = Time.now
    logger.error("Error fetching job: #{ex}")
    ex.backtrace.each do |bt|
      logger.error(bt)
    end
  end
  sleep(1)
  nil
end

#kill(wait = false) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/sidekiq/processor.rb', line 46

def kill(wait=false)
  @done = true
  return if !@thread
  # unlike the other actors, terminate does not wait
  # for the thread to finish because we don't know how
  # long the job will take to finish.  Instead we
  # provide a `kill` method to call after the shutdown
  # timeout passes.
  @thread.raise ::Sidekiq::Shutdown
  @thread.value if wait
end

#process(work) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/sidekiq/processor.rb', line 116

def process(work)
  jobstr = work.job
  queue = work.queue_name

  ack = false
  begin
    job = Sidekiq.load_json(jobstr)
    klass  = job['class'.freeze].constantize
    worker = klass.new
    worker.jid = job['jid'.freeze]

    stats(worker, job, queue) do
      Sidekiq.server_middleware.invoke(worker, job, queue) do
        # Only ack if we either attempted to start this job or
        # successfully completed it. This prevents us from
        # losing jobs if a middleware raises an exception before yielding
        ack = true
        execute_job(worker, cloned(job['args'.freeze]))
      end
    end
    ack = true
  rescue Sidekiq::Shutdown
    # Had to force kill this job because it didn't finish
    # within the timeout.  Don't acknowledge the work since
    # we didn't properly finish it.
    ack = false
  rescue Exception => ex
    handle_exception(ex, job || { :job => jobstr })
    raise
  ensure
    work.acknowledge if ack
  end
end

#process_one ⇒ Object 



77
78
79
80
81
 
# File 'lib/sidekiq/processor.rb', line 77

def process_one
  @job = fetch
  process(@job) if @job
  @job = nil
end

#run ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/sidekiq/processor.rb', line 64

def run
  begin
    while !@done
      process_one
    end
    @mgr.processor_stopped(self)
  rescue Sidekiq::Shutdown
    @mgr.processor_stopped(self)
  rescue Exception => ex
    @mgr.processor_died(self, ex)
  end
end

#start ⇒ Object 



58
59
60
 
# File 'lib/sidekiq/processor.rb', line 58

def start
  @thread ||= safe_thread("processor", &method(:run))
end

#stats(worker, job, queue) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/sidekiq/processor.rb', line 162

def stats(worker, job, queue)
  tid = thread_identity
  WORKER_STATE[tid] = {:queue => queue, :payload => job, :run_at => Time.now.to_i }

  begin
    yield
  rescue Exception
    FAILURE.increment
    raise
  ensure
    WORKER_STATE.delete(tid)
    PROCESSED.increment
  end
end

#terminate(wait = false) ⇒ Object 



40
41
42
43
44
 
# File 'lib/sidekiq/processor.rb', line 40

def terminate(wait=false)
  @done = true
  return if !@thread
  @thread.value if wait
end

#thread_identity ⇒ Object 



154
155
156
 
# File 'lib/sidekiq/processor.rb', line 154

def thread_identity
  @str ||= Thread.current.object_id.to_s(36)
end