Class: Sidekiq::Processor
- Inherits:
-
Object
- Object
- Sidekiq::Processor
show all
- Includes:
- Util
- Defined in:
- lib/sidekiq/processor.rb
Overview
The Processor is a standalone thread which:
-
fetches a job from Redis
-
executes the job
a. instantiate the Worker
b. run the middleware chain
c. call
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
#handle_exception
Constructor Details
#initialize(mgr) ⇒ Processor
Returns a new instance of Processor.
34
35
36
37
38
39
40
41
42
43
44
|
# File 'lib/sidekiq/processor.rb', line 34
def initialize(mgr)
@mgr = mgr
@down = false
@done = false
@job = nil
@thread = nil
@strategy = (mgr.options[:fetch] || Sidekiq::BasicFetch).new(mgr.options)
@reloader = Sidekiq.options[:reloader]
@logging = (mgr.options[:job_logger] || Sidekiq::JobLogger).new
@retrier = Sidekiq::JobRetry.new
end
|
Instance Attribute Details
#job ⇒ Object
Returns the value of attribute job.
32
33
34
|
# File 'lib/sidekiq/processor.rb', line 32
def job
@job
end
|
#thread ⇒ Object
Returns the value of attribute thread.
31
32
33
|
# File 'lib/sidekiq/processor.rb', line 31
def thread
@thread
end
|
Instance Method Details
#cloned(thing) ⇒ 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.
228
229
230
|
# File 'lib/sidekiq/processor.rb', line 228
def cloned(thing)
Marshal.load(Marshal.dump(thing))
end
|
#constantize(str) ⇒ Object
232
233
234
235
236
237
238
239
|
# File 'lib/sidekiq/processor.rb', line 232
def constantize(str)
names = str.split('::')
names.shift if names.empty? || names.first.empty?
names.inject(Object) do |constant, name|
constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
end
end
|
#dispatch(job_hash, queue) ⇒ Object
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 122
def dispatch(job_hash, queue)
pristine = cloned(job_hash)
Sidekiq::Logging.with_job_hash_context(job_hash) do
@retrier.global(job_hash, queue) do
@logging.call(job_hash, queue) do
stats(pristine, queue) do
@reloader.call do
klass = constantize(job_hash['class'.freeze])
worker = klass.new
worker.jid = job_hash['jid'.freeze]
@retrier.local(worker, job_hash, queue) do
yield worker
end
end
end
end
end
end
end
|
#execute_job(worker, cloned_args) ⇒ Object
198
199
200
|
# File 'lib/sidekiq/processor.rb', line 198
def execute_job(worker, cloned_args)
worker.perform(*cloned_args)
end
|
#fetch ⇒ Object
100
101
102
103
104
105
106
107
108
|
# File 'lib/sidekiq/processor.rb', line 100
def fetch
j = get_one
if j && @done
j.requeue
nil
else
j
end
end
|
#get_one ⇒ Object
89
90
91
92
93
94
95
96
97
98
|
# File 'lib/sidekiq/processor.rb', line 89
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
110
111
112
113
114
115
116
117
118
119
120
|
# File 'lib/sidekiq/processor.rb', line 110
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
52
53
54
55
56
57
58
59
60
61
62
|
# File 'lib/sidekiq/processor.rb', line 52
def kill(wait=false)
@done = true
return if !@thread
@thread.raise ::Sidekiq::Shutdown
@thread.value if wait
end
|
#process(work) ⇒ Object
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
# File 'lib/sidekiq/processor.rb', line 150
def process(work)
jobstr = work.job
queue = work.queue_name
ack = false
begin
job_hash = nil
begin
job_hash = Sidekiq.load_json(jobstr)
rescue => ex
handle_exception(ex, { :context => "Invalid JSON for job", :jobstr => jobstr })
send_to_morgue(jobstr)
ack = true
raise
end
ack = true
dispatch(job_hash, queue) do |worker|
Sidekiq.server_middleware.invoke(worker, job_hash, queue) do
execute_job(worker, cloned(job_hash['args'.freeze]))
end
end
rescue Sidekiq::Shutdown
ack = false
rescue Exception => ex
e = ex.is_a?(::Sidekiq::JobRetry::Skip) && ex.cause ? ex.cause : ex
handle_exception(e, { :context => "Job raised exception", :job => job_hash, :jobstr => jobstr })
raise e
ensure
work.acknowledge if ack
end
end
|
#process_one ⇒ Object
83
84
85
86
87
|
# File 'lib/sidekiq/processor.rb', line 83
def process_one
@job = fetch
process(@job) if @job
@job = nil
end
|
#run ⇒ Object
70
71
72
73
74
75
76
77
78
79
80
81
|
# File 'lib/sidekiq/processor.rb', line 70
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
|
#send_to_morgue(msg) ⇒ Object
187
188
189
190
191
192
193
194
195
196
|
# File 'lib/sidekiq/processor.rb', line 187
def send_to_morgue(msg)
now = Time.now.to_f
Sidekiq.redis do |conn|
conn.multi do
conn.zadd('dead', now, msg)
conn.zremrangebyscore('dead', '-inf', now - DeadSet.timeout)
conn.zremrangebyrank('dead', 0, -DeadSet.max_jobs)
end
end
end
|
#start ⇒ Object
64
65
66
|
# File 'lib/sidekiq/processor.rb', line 64
def start
@thread ||= safe_thread("processor", &method(:run))
end
|
#stats(job_hash, queue) ⇒ Object
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
# File 'lib/sidekiq/processor.rb', line 210
def stats(job_hash, queue)
tid = thread_identity
WORKER_STATE[tid] = {:queue => queue, :payload => job_hash, :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
46
47
48
49
50
|
# File 'lib/sidekiq/processor.rb', line 46
def terminate(wait=false)
@done = true
return if !@thread
@thread.value if wait
end
|
#thread_identity ⇒ Object
202
203
204
|
# File 'lib/sidekiq/processor.rb', line 202
def thread_identity
@str ||= Thread.current.object_id.to_s(36)
end
|