Class: Delayed::Worker::HealthCheck

Inherits:
Object
  • Object
show all
Defined in:
lib/delayed/worker/health_check.rb

Direct Known Subclasses

ConsulHealthCheck, NullHealthCheck

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(worker_name:, config: {}) ⇒ HealthCheck

Returns a new instance of HealthCheck.



54
55
56
57
 
# File 'lib/delayed/worker/health_check.rb', line 54

def initialize(worker_name:, config: {})
  @config = config.with_indifferent_access
  @worker_name = worker_name
end

Class Attribute Details

.subclasses ⇒ Object (readonly)

Returns the value of attribute subclasses.



10
11
12
 
# File 'lib/delayed/worker/health_check.rb', line 10

def subclasses
  @subclasses
end

.type_name ⇒ Object

Returns the value of attribute type_name.



9
10
11
 
# File 'lib/delayed/worker/health_check.rb', line 9

def type_name
  @type_name
end

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



52
53
54
 
# File 'lib/delayed/worker/health_check.rb', line 52

def config
  @config
end

#worker_name ⇒ Object

Returns the value of attribute worker_name.



52
53
54
 
# File 'lib/delayed/worker/health_check.rb', line 52

def worker_name
  @worker_name
end

Class Method Details

.build(type:, worker_name:, config: {}) ⇒ Object

Raises:

  • (ArgumentError) 


16
17
18
19
20
21
 
# File 'lib/delayed/worker/health_check.rb', line 16

def build(type:, worker_name:, config: {})
  type = type.to_sym
  klass = @subclasses.find { |sc| sc.type_name == type }
  raise ArgumentError, "Unable to build a HealthCheck for type #{type}" unless klass
  klass.new(worker_name: worker_name, config: config)
end

.inherited(subclass) ⇒ Object 



12
13
14
 
# File 'lib/delayed/worker/health_check.rb', line 12

def inherited(subclass)
  @subclasses << subclass
end

.reschedule_abandoned_jobs ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/delayed/worker/health_check.rb', line 23

def reschedule_abandoned_jobs
  return if Settings.worker_health_check_type == :none

  checker = Worker::HealthCheck.build(
    type: Settings.worker_health_check_type,
    config: Settings.worker_health_check_config,
    worker_name: 'cleanup-crew'
  )
  live_workers = checker.live_workers

  Delayed::Job.running_jobs.each do |job|
    # prefetched jobs have their own way of automatically unlocking themselves
    next if job.locked_by.start_with?("prefetch:")
    unless live_workers.include?(job.locked_by)
      begin
        Delayed::Job.transaction do
          # double check that the job is still there. locked_by will immediately be reset
          # to nil in this transaction by Job#reschedule
          next unless Delayed::Job.where(id: job, locked_by: job.locked_by).update_all(locked_by: "abandoned job cleanup") == 1
          job.reschedule
        end
      rescue
        ::Rails.logger.error "Failure rescheduling abandoned job #{job.id} #{$!.inspect}"
      end
    end
  end
end

Instance Method Details

#live_workers ⇒ Object

Raises:

  • (NotImplementedError) 


67
68
69
 
# File 'lib/delayed/worker/health_check.rb', line 67

def live_workers
  raise NotImplementedError
end

#start ⇒ Object

Raises:

  • (NotImplementedError) 


59
60
61
 
# File 'lib/delayed/worker/health_check.rb', line 59

def start
  raise NotImplementedError
end

#stop ⇒ Object

Raises:

  • (NotImplementedError) 


63
64
65
 
# File 'lib/delayed/worker/health_check.rb', line 63

def stop
  raise NotImplementedError
end