Class: Resque::Worker

Inherits:
Object
  • Object
show all
Extended by:
Helpers
Includes:
Helpers
Defined in:
lib/resque/worker.rb

Overview

A Resque Worker processes jobs. On platforms that support fork(2), the worker will fork off a child to process each job. This ensures a clean slate when beginning the next job and cuts down on gradual memory growth as well as low level failures.

It also ensures workers are always listening to signals from you, their master, and can react accordingly.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Helpers

classify, constantize, decode, encode, mongo, mongo_stats, mongo_workers

Constructor Details

#initialize(*queues) ⇒ Worker

Workers should be initialized with an array of string queue names. The order is important: a Worker will check the first queue given for a job. If none is found, it will check the second queue name given. If a job is found, it will be processed. Upon completion, the Worker will again check the first queue given, and so forth. In this way the queue list passed to a Worker on startup defines the priorities of queues.

If passed a single “*”, this Worker will operate on all queues in alphabetical order. Queues can be dynamically added or removed without needing to restart workers using this method.



72
73
74
75
 
# File 'lib/resque/worker.rb', line 72

def initialize(*queues)
  @queues = queues
  validate_queues
end

Instance Attribute Details

#cant_fork ⇒ Object

Boolean indicating whether this worker can or can not fork. Automatically set if a fork(2) fails.



21
22
23
 
# File 'lib/resque/worker.rb', line 21

def cant_fork
  @cant_fork
end

#to_s ⇒ Object Also known as: worker_id

The string representation is the same as the id for this worker instance. Can be used with ‘Worker.find`.



440
441
442
 
# File 'lib/resque/worker.rb', line 440

def to_s
  @to_s ||= "#{hostname}:#{Process.pid}:#{@queues.join(',')}"
end

#verbose ⇒ Object

Whether the worker should log basic info to STDOUT



14
15
16
 
# File 'lib/resque/worker.rb', line 14

def verbose
  @verbose
end

#very_verbose ⇒ Object

Whether the worker should log lots of info to STDOUT



17
18
19
 
# File 'lib/resque/worker.rb', line 17

def very_verbose
  @very_verbose
end

Class Method Details

.all ⇒ Object

Returns an array of all worker objects.



26
27
28
 
# File 'lib/resque/worker.rb', line 26

def self.all
  mongo_workers.distinct(:worker).map { |worker| find(worker) }.compact
end

.attach(worker_id) ⇒ Object

Alias of ‘find`



51
52
53
 
# File 'lib/resque/worker.rb', line 51

def self.attach(worker_id)
  find(worker_id)
end

.exists?(worker_id) ⇒ Boolean

# Given a string worker id, return a boolean indicating whether the # worker exists

Returns:

  • (Boolean) 


57
58
59
 
# File 'lib/resque/worker.rb', line 57

def self.exists?(worker_id)
  not mongo_workers.find_one(:worker => worker_id.to_s).nil?
end

.find(worker_id) ⇒ Object

Returns a single worker object. Accepts a string id.



41
42
43
44
45
46
47
48
 
# File 'lib/resque/worker.rb', line 41

def self.find(worker_id)
  worker = mongo_workers.find_one(:worker => worker_id)
  return nil unless worker
  queues = worker['worker'].split(',')
  worker = new(*queues)
  worker.to_s = worker_id
  worker
end

.working ⇒ Object

Returns an array of all worker objects currently processing jobs.



32
33
34
35
36
37
38
 
# File 'lib/resque/worker.rb', line 32

def self.working
  select = {}
  select['working_on'] = {"$exists" => true}
  working = mongo_workers.find(select).to_a
  working.map! {|w| w['worker'] }
  working.map {|w| find(w) }
end

Instance Method Details

#==(other) ⇒ Object

Is this worker the same as another worker?



430
431
432
 
# File 'lib/resque/worker.rb', line 430

def ==(other)
  to_s == other.to_s
end

#done_working ⇒ Object

Called when we are done working - clears our ‘working_on` state and tells Redis we processed a job.



363
364
365
366
367
 
# File 'lib/resque/worker.rb', line 363

def done_working
  processed!
  working_on = {'working_on' => 1}
  mongo_workers.update({:worker =>  self.to_s}, {'$unset' => working_on})
end

#enable_gc_optimizations ⇒ Object

Enables GC Optimizations if you’re running REE. www.rubyenterpriseedition.com/faq.html#adapt_apps_for_cow



222
223
224
225
226
 
# File 'lib/resque/worker.rb', line 222

def enable_gc_optimizations
  if GC.respond_to?(:copy_on_write_friendly=)
    GC.copy_on_write_friendly = true
  end
end

#failed ⇒ Object

How many failed jobs has this worker seen? Returns an int.



381
382
383
 
# File 'lib/resque/worker.rb', line 381

def failed
  Stat["failed:#{self}"]
end

#failed! ⇒ Object

Tells Redis we’ve failed a job.



386
387
388
389
 
# File 'lib/resque/worker.rb', line 386

def failed!
  Stat << "failed"
  Stat << "failed:#{self}"
end

#fork ⇒ Object

Not every platform supports fork. Here we do our magic to determine if yours does.



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/resque/worker.rb', line 189

def fork
  @cant_fork = true if $TESTING

  return if @cant_fork

  begin
    # IronRuby doesn't support `Kernel.fork` yet
    if Kernel.respond_to?(:fork)
      Kernel.fork
    else
      raise NotImplementedError
    end
  rescue NotImplementedError
    @cant_fork = true
    nil
  end
end

#hostname ⇒ Object

chomp’d hostname of this machine



446
447
448
 
# File 'lib/resque/worker.rb', line 446

def hostname
  @hostname ||= `hostname`.chomp
end

#idle? ⇒ Boolean

Boolean - true if idle, false if not

Returns:

  • (Boolean) 


418
419
420
 
# File 'lib/resque/worker.rb', line 418

def idle?
  state == :idle
end

#inspect ⇒ Object 



434
435
436
 
# File 'lib/resque/worker.rb', line 434

def inspect
  "#<Worker #{to_s}>"
end

#job ⇒ Object Also known as: processing

Returns a hash explaining the Job we’re currently processing, if any.



405
406
407
408
409
 
# File 'lib/resque/worker.rb', line 405

def job
  worker = mongo_workers.find_one(:worker => self.to_s)
  return {} if !worker
  decode(worker['working_on']) || {}
end

#kill_child ⇒ Object

Kills the forked child immediately, without remorse. The job it is processing will not be completed.



267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/resque/worker.rb', line 267

def kill_child
  if @child
    log! "Killing child at #{@child}"
    if system("ps -o pid,state -p #{@child}")
      Process.kill("KILL", @child) rescue nil
    else
      log! "Child #{@child} not found, restarting."
      shutdown
    end
  end
end

#log(message) ⇒ Object

Log a message to STDOUT if we are verbose or very_verbose.



467
468
469
470
471
472
473
474
 
# File 'lib/resque/worker.rb', line 467

def log(message)
  if verbose
    puts "*** #{message}"
  elsif very_verbose
    time = Time.now.strftime('%I:%M:%S %Y-%m-%d')
    puts "** [#{time}] #$$: #{message}"
  end
end

#log!(message) ⇒ Object

Logs a very verbose message to STDOUT.



477
478
479
 
# File 'lib/resque/worker.rb', line 477

def log!(message)
  log message if very_verbose
end

#pause_processing ⇒ Object

Stop processing jobs after the current one has completed (if we’re currently running one).



281
282
283
284
 
# File 'lib/resque/worker.rb', line 281

def pause_processing
  log "USR2 received; pausing job processing"
  @paused = true
end

#perform(job) ⇒ Object

Processes a given job in the child.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/resque/worker.rb', line 151

def perform(job)
  begin
    run_hook :after_fork, job
    job.perform
  rescue Object => e
    log "#{job.inspect} failed: #{e.inspect}"
    job.fail(e)
    failed!
  else
    log "done: #{job.inspect}"
  ensure
    yield job if block_given?
  end
end

#process(job = nil, &block) ⇒ Object

DEPRECATED. Processes a single job. If none is given, it will try to produce one. Usually run in the child.



141
142
143
144
145
146
147
148
 
# File 'lib/resque/worker.rb', line 141

def process(job = nil, &block)
  return unless job ||= reserve

  working_on job
  perform(job, &block)
ensure
  done_working
end

#processed ⇒ Object

How many jobs has this worker processed? Returns an int.



370
371
372
 
# File 'lib/resque/worker.rb', line 370

def processed
  Stat["processed:#{self}"]
end

#processed! ⇒ Object

Tell Redis we’ve processed a job.



375
376
377
378
 
# File 'lib/resque/worker.rb', line 375

def processed!
  Stat << "processed"
  Stat << "processed:#{self}"
end

#procline(string) ⇒ Object

Given a string, sets the procline ($0) and logs. Procline is always in the format of:

resque-VERSION: STRING



461
462
463
464
 
# File 'lib/resque/worker.rb', line 461

def procline(string)
  $0 = "resque-#{Resque::Version}: #{string}"
  log! $0
end

#prune_dead_workers ⇒ Object

Looks for any workers which should be running on this server and, if they’re not, removes them from Redis.

This is a form of garbage collection. If a server is killed by a hard shutdown, power failure, or something else beyond our control, the Resque workers will not die gracefully and therefore will leave stale state information in Redis.

By checking the current Redis state against the actual environment, we can determine if Redis is old and clean it up a bit.



302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/resque/worker.rb', line 302

def prune_dead_workers
  all_workers = Worker.all
  known_workers = worker_pids unless all_workers.empty?
  all_workers.each do |worker|
    host, pid, queues = worker.to_s.split(':')
    next unless host == hostname
    next if known_workers.include?(pid)
    log! "Pruning dead worker: #{worker}"
    worker.unregister_worker
  end
end

#queues ⇒ Object

Returns a list of queues to use when searching for a job. A splat (“*”) means you want every queue (in alpha order) - this can be useful for dynamically adding new queues.



183
184
185
 
# File 'lib/resque/worker.rb', line 183

def queues
  @queues[0] == "*" ? Resque.queues.sort : @queues
end

#register_signal_handlers ⇒ Object

Registers the various signal handlers a worker responds to.

TERM: Shutdown immediately, stop processing jobs.

INT: Shutdown immediately, stop processing jobs.

QUIT: Shutdown after the current job has finished processing. USR1: Kill the forked child immediately, continue processing jobs. USR2: Don’t process any new jobs CONT: Start processing jobs again after a USR2



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/resque/worker.rb', line 236

def register_signal_handlers
  trap('TERM') { shutdown!  }
  trap('INT')  { shutdown!  }

  begin
    trap('QUIT') { shutdown   }
    trap('USR1') { kill_child }
    trap('USR2') { pause_processing }
    trap('CONT') { unpause_processing }
  rescue ArgumentError
    warn "Signals QUIT, USR1, USR2, and/or CONT not supported."
  end

  log! "Registered signals"
end

#register_worker ⇒ Object

Registers ourself as a worker. Useful when entering the worker lifecycle on startup.



316
317
318
319
 
# File 'lib/resque/worker.rb', line 316

def register_worker
  mongo_workers.insert(:worker => self.to_s)
  started!
end

#reserve ⇒ Object

Attempts to grab a job off one of the provided queues. Returns nil if no job can be found.



168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/resque/worker.rb', line 168

def reserve
  queues.each do |queue|
    log! "Checking #{queue}"
    if job = Resque::Job.reserve(queue)
      log! "Found job on #{queue}"
      return job
    end
  end

  nil
end

#run_hook(name, *args) ⇒ Object

Runs a named hook, passing along any arguments.



322
323
324
325
326
327
328
329
 
# File 'lib/resque/worker.rb', line 322

def run_hook(name, *args)
  return unless hook = Resque.send(name)
  msg = "Running #{name} hook"
  msg << " with #{args.inspect}" if args.any?
  log msg

  args.any? ? hook.call(*args) : hook.call
end

#shutdown ⇒ Object

Schedule this worker for shutdown. Will finish processing the current job.



254
255
256
257
 
# File 'lib/resque/worker.rb', line 254

def shutdown
  log 'Exiting...'
  @shutdown = true
end

#shutdown! ⇒ Object

Kill the child and shutdown immediately.



260
261
262
263
 
# File 'lib/resque/worker.rb', line 260

def shutdown!
  shutdown
  kill_child
end

#started ⇒ Object

What time did this worker start? Returns an instance of ‘Time`



392
393
394
395
396
 
# File 'lib/resque/worker.rb', line 392

def started
  worker = mongo_workers.find_one(:worker => self.to_s)
  return nil if !worker
  worker['started']
end

#started! ⇒ Object

Tell Redis we’ve started



399
400
401
402
 
# File 'lib/resque/worker.rb', line 399

def started!
  started = {'started' => Time.now.to_s}
  mongo_workers.update({:worker => self.to_s},  {'$set' => started})
end

#startup ⇒ Object

Runs all the methods needed when a worker begins its lifecycle.



208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/resque/worker.rb', line 208

def startup
  enable_gc_optimizations
  register_signal_handlers
  prune_dead_workers
  run_hook :before_first_fork
  register_worker

  # Fix buffering so we can `rake resque:work > resque.log` and
  # get output from the child in there.
  $stdout.sync = true
end

#state ⇒ Object

Returns a symbol representing the current worker state, which can be either :working or :idle



424
425
426
427
 
# File 'lib/resque/worker.rb', line 424

def state
  worker = mongo_workers.find_one(:worker => self.to_s)
  worker ? :working : :idle
end

#unpause_processing ⇒ Object

Start processing jobs again after a pause



287
288
289
290
 
# File 'lib/resque/worker.rb', line 287

def unpause_processing
  log "CONT received; resuming job processing"
  @paused = false
end

#unregister_worker ⇒ Object

Unregisters ourself as a worker. Useful when shutting down.



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/resque/worker.rb', line 332

def unregister_worker
  # If we're still processing a job, make sure it gets logged as a
  # failure.
  if (hash = processing) && !hash.empty?
    job = Job.new(hash['queue'], hash['payload'])
    # Ensure the proper worker is attached to this job, even if
    # it's not the precise instance that died.
    job.worker = self
    job.fail(DirtyExit.new)
  end

  mongo_workers.remove(:worker => self.to_s)

  Stat.clear("processed:#{self}")
  Stat.clear("failed:#{self}")
end

#validate_queues ⇒ Object

A worker must be given a queue, otherwise it won’t know what to do with itself.

You probably never need to call this.



81
82
83
84
85
 
# File 'lib/resque/worker.rb', line 81

def validate_queues
  if @queues.nil? || @queues.empty?
    raise NoQueueError.new("Please give each worker at least one queue.")
  end
end

#work(interval = 5, &block) ⇒ Object

This is the main workhorse method. Called on a Worker instance, it begins the worker life cycle.

The following events occur during a worker’s life cycle:

  1. Startup: Signals are registered, dead workers are pruned,

    and this worker is registered.

  2. Work loop: Jobs are pulled from a queue and processed.

  3. Teardown: This worker is unregistered.

Can be passed an integer representing the polling frequency. The default is 5 seconds, but for a semi-active site you may want to use a smaller value.

Also accepts a block which will be passed the job as soon as it has completed processing. Useful for testing.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/resque/worker.rb', line 103

def work(interval = 5, &block)
  $0 = "resque: Starting"
  startup

  loop do
    break if @shutdown

    if not @paused and job = reserve
      log "got: #{job.inspect}"
      run_hook :before_fork
      working_on job

      if @child = fork
        rand # Reseeding
        procline "Forked #{@child} at #{Time.now.to_i}"
        Process.wait
      else
        procline "Processing #{job.queue} since #{Time.now.to_i}"
        perform(job, &block)
        exit! unless @cant_fork
      end

      done_working
      @child = nil
    else
      break if interval.to_i == 0
      log! "Sleeping for #{interval.to_i}"
      procline @paused ? "Paused" : "Waiting for #{@queues.join(',')}"
      sleep interval.to_i
    end
  end

ensure
  unregister_worker
end

#worker_pids ⇒ Object

Returns an array of string pids of all the other workers on this machine. Useful when pruning dead workers on startup.



452
453
454
455
456
 
# File 'lib/resque/worker.rb', line 452

def worker_pids
  `ps -A -o pid,command | grep [r]esque`.split("\n").map do |line|
    line.split(' ')[0]
  end
end

#working? ⇒ Boolean

Boolean - true if working, false if not

Returns:

  • (Boolean) 


413
414
415
 
# File 'lib/resque/worker.rb', line 413

def working?
  state == :working
end

#working_on(job) ⇒ Object

Given a job, tells Redis we’re working on it. Useful for seeing what workers are doing and when.



351
352
353
354
355
356
357
358
359
 
# File 'lib/resque/worker.rb', line 351

def working_on(job)
  job.worker = self
  data = encode \
    :queue   => job.queue,
    :run_at  => Time.now.to_s,
  :payload => job.payload
  working_on = {'working_on' => data}
  mongo_workers.update({:worker => self.to_s},  {'$set' => working_on}, :upsert => true )
end