Class: Delayed::Worker
- Inherits:
-
Object
- Object
- Delayed::Worker
- Defined in:
- lib/delayed/worker.rb
Constant Summary collapse
- DEFAULT_LOG_LEVEL =
'info'
- DEFAULT_SLEEP_DELAY =
5
- DEFAULT_MAX_ATTEMPTS =
25
- DEFAULT_MAX_RUN_TIME =
4.hours
- DEFAULT_DEFAULT_PRIORITY =
0
- DEFAULT_DELAY_JOBS =
true
- DEFAULT_QUEUES =
[]
- DEFAULT_READ_AHEAD =
5
Instance Attribute Summary collapse
-
#name_prefix ⇒ Object
name_prefix is ignored if name is set directly.
Class Method Summary collapse
- .after_fork ⇒ Object
- .backend=(backend) ⇒ Object
- .before_fork ⇒ Object
- .guess_backend ⇒ Object
- .lifecycle ⇒ Object
- .reset ⇒ Object
Instance Method Summary collapse
- #failed(job) ⇒ Object
-
#initialize(options = {}) ⇒ Worker
constructor
A new instance of Worker.
- #job_say(job, text, level = DEFAULT_LOG_LEVEL) ⇒ Object
- #max_attempts(job) ⇒ Object
-
#name ⇒ Object
Every worker has a unique name which by default is the pid of the process.
-
#name=(val) ⇒ Object
Sets the name of the worker.
-
#reschedule(job, time = nil) ⇒ Object
Reschedule the job in the future (when a job fails).
- #run(job) ⇒ Object
- #say(text, level = DEFAULT_LOG_LEVEL) ⇒ Object
- #start ⇒ Object
- #stop ⇒ Object
- #stop? ⇒ Boolean
-
#work_off(num = 100) ⇒ Object
Do num jobs and return stats on success/failure.
Constructor Details
#initialize(options = {}) ⇒ Worker
Returns a new instance of Worker.
109 110 111 112 113 114 115 116 117 118 |
# File 'lib/delayed/worker.rb', line 109 def initialize(={}) @quiet = .has_key?(:quiet) ? [:quiet] : true @failed_reserve_count = 0 [:min_priority, :max_priority, :sleep_delay, :read_ahead, :queues, :exit_on_complete].each do |option| self.class.send("#{option}=", [option]) if .has_key?(option) end self.plugins.each { |klass| klass.new } end |
Instance Attribute Details
#name_prefix ⇒ Object
name_prefix is ignored if name is set directly
31 32 33 |
# File 'lib/delayed/worker.rb', line 31 def name_prefix @name_prefix end |
Class Method Details
.after_fork ⇒ Object
92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/delayed/worker.rb', line 92 def self.after_fork # Re-open file handles @files_to_reopen.each do |file| begin file.reopen file.path, "a+" file.sync = true rescue ::Exception end end backend.after_fork end |
.backend=(backend) ⇒ Object
67 68 69 70 71 72 73 74 75 |
# File 'lib/delayed/worker.rb', line 67 def self.backend=(backend) if backend.is_a? Symbol require "delayed/serialization/#{backend}" require "delayed/backend/#{backend}" backend = "Delayed::Backend::#{backend.to_s.classify}::Job".constantize end @@backend = backend silence_warnings { ::Delayed.const_set(:Job, backend) } end |
.before_fork ⇒ Object
81 82 83 84 85 86 87 88 89 90 |
# File 'lib/delayed/worker.rb', line 81 def self.before_fork unless @files_to_reopen @files_to_reopen = [] ObjectSpace.each_object(File) do |file| @files_to_reopen << file unless file.closed? end end backend.before_fork end |
.guess_backend ⇒ Object
77 78 79 |
# File 'lib/delayed/worker.rb', line 77 def self.guess_backend warn "[DEPRECATION] guess_backend is deprecated. Please remove it from your code." end |
.lifecycle ⇒ Object
105 106 107 |
# File 'lib/delayed/worker.rb', line 105 def self.lifecycle @lifecycle ||= Delayed::Lifecycle.new end |
.reset ⇒ Object
33 34 35 36 37 38 39 40 41 |
# File 'lib/delayed/worker.rb', line 33 def self.reset self.sleep_delay = DEFAULT_SLEEP_DELAY self.max_attempts = DEFAULT_MAX_ATTEMPTS self.max_run_time = DEFAULT_MAX_RUN_TIME self.default_priority = DEFAULT_DEFAULT_PRIORITY self.delay_jobs = DEFAULT_DELAY_JOBS self.queues = DEFAULT_QUEUES self.read_ahead = DEFAULT_READ_AHEAD end |
Instance Method Details
#failed(job) ⇒ Object
234 235 236 237 238 239 |
# File 'lib/delayed/worker.rb', line 234 def failed(job) self.class.lifecycle.run_callbacks(:failure, self, job) do job.hook(:failure) self.class.destroy_failed_jobs ? job.destroy : job.fail! end end |
#job_say(job, text, level = DEFAULT_LOG_LEVEL) ⇒ Object
241 242 243 244 |
# File 'lib/delayed/worker.rb', line 241 def job_say(job, text, level = DEFAULT_LOG_LEVEL) text = "Job #{job.name} (id=#{job.id}) #{text}" say text, level end |
#max_attempts(job) ⇒ Object
258 259 260 |
# File 'lib/delayed/worker.rb', line 258 def max_attempts(job) job.max_attempts || self.class.max_attempts end |
#name ⇒ Object
Every worker has a unique name which by default is the pid of the process. There are some advantages to overriding this with something which survives worker restarts: Workers can safely resume working on tasks which are locked by themselves. The worker will assume that it crashed before.
124 125 126 127 |
# File 'lib/delayed/worker.rb', line 124 def name return @name unless @name.nil? "#{@name_prefix}host:#{Socket.gethostname} pid:#{Process.pid}" rescue "#{@name_prefix}pid:#{Process.pid}" end |
#name=(val) ⇒ Object
Sets the name of the worker. Setting the name to nil will reset the default worker name
131 132 133 |
# File 'lib/delayed/worker.rb', line 131 def name=(val) @name = val end |
#reschedule(job, time = nil) ⇒ Object
Reschedule the job in the future (when a job fails). Uses an exponential scale depending on the number of failed attempts.
222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/delayed/worker.rb', line 222 def reschedule(job, time = nil) if (job.attempts += 1) < max_attempts(job) time ||= job.reschedule_at job.run_at = time job.unlock job.save! else job_say job, "REMOVED permanently because of #{job.attempts} consecutive failures", 'error' failed(job) end end |
#run(job) ⇒ Object
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 |
# File 'lib/delayed/worker.rb', line 204 def run(job) job_say job, 'RUNNING' runtime = Benchmark.realtime do Timeout.timeout(self.class.max_run_time.to_i, WorkerTimeout) { job.invoke_job } job.destroy end job_say job, 'COMPLETED after %.4f' % runtime return true # did work rescue DeserializationError => error job.last_error = "#{error.}\n#{error.backtrace.join("\n")}" failed(job) rescue Exception => error self.class.lifecycle.run_callbacks(:error, self, job){ handle_failed_job(job, error) } return false # work failed end |
#say(text, level = DEFAULT_LOG_LEVEL) ⇒ Object
246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/delayed/worker.rb', line 246 def say(text, level = DEFAULT_LOG_LEVEL) text = "[Worker(#{name})] #{text}" puts text unless @quiet if logger # TODO: Deprecate use of Fixnum log levels if !level.is_a?(String) level = Logger::Severity.constants.detect {|i| Logger::Severity.const_get(i) == level }.to_s.downcase end logger.send(level, "#{Time.now.strftime('%FT%T%z')}: #{text}") end end |
#start ⇒ Object
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 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 |
# File 'lib/delayed/worker.rb', line 135 def start trap('TERM') do say 'Exiting...' stop raise SignalException.new('TERM') if self.class.raise_signal_exceptions end trap('INT') do say 'Exiting...' stop raise SignalException.new('INT') if self.class.raise_signal_exceptions && self.class.raise_signal_exceptions != :term end say "Starting job worker" self.class.lifecycle.run_callbacks(:execute, self) do loop do self.class.lifecycle.run_callbacks(:loop, self) do @realtime = Benchmark.realtime do @result = work_off end end count = @result.sum if count.zero? if self.class.exit_on_complete say "No more jobs available. Exiting" break else sleep(self.class.sleep_delay) unless stop? end else say "#{count} jobs processed at %.4f j/s, %d failed" % [count / @realtime, @result.last] end break if stop? end end end |
#stop ⇒ Object
176 177 178 |
# File 'lib/delayed/worker.rb', line 176 def stop @exit = true end |
#stop? ⇒ Boolean
180 181 182 |
# File 'lib/delayed/worker.rb', line 180 def stop? !!@exit end |
#work_off(num = 100) ⇒ Object
Do num jobs and return stats on success/failure. Exit early if interrupted.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/delayed/worker.rb', line 186 def work_off(num = 100) success, failure = 0, 0 num.times do case reserve_and_run_one_job when true success += 1 when false failure += 1 else break # leave if no work could be done end break if stop? # leave if we're exiting end return [success, failure] end |