Module: Datadog::Workers::IntervalLoop

Defined in:
lib/ddtrace/workers/interval_loop.rb

Overview

Adds looping behavior to workers, with a sleep interval between each loop.

Defined Under Namespace

Modules: PrependedMethods

Constant Summary collapse

BACK_OFF_RATIO = 
1.2
BACK_OFF_MAX = 
5
BASE_INTERVAL = 
1

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#loop_back_off_max ⇒ Object 



51
52
53
 
# File 'lib/ddtrace/workers/interval_loop.rb', line 51

def loop_back_off_max
  @loop_back_off_max ||= BACK_OFF_MAX
end

#loop_back_off_ratio ⇒ Object 



47
48
49
 
# File 'lib/ddtrace/workers/interval_loop.rb', line 47

def loop_back_off_ratio
  @loop_back_off_ratio ||= BACK_OFF_RATIO
end

#loop_base_interval ⇒ Object 



43
44
45
 
# File 'lib/ddtrace/workers/interval_loop.rb', line 43

def loop_base_interval
  @loop_base_interval ||= BASE_INTERVAL
end

Class Method Details

.included(base) ⇒ Object 



11
12
13
 
# File 'lib/ddtrace/workers/interval_loop.rb', line 11

def self.included(base)
  base.prepend(PrependedMethods)
end

Instance Method Details

#loop_back_off! ⇒ Object 



63
64
65
 
# File 'lib/ddtrace/workers/interval_loop.rb', line 63

def loop_back_off!
  self.loop_wait_time = [loop_wait_time * BACK_OFF_RATIO, BACK_OFF_MAX].min
end

#loop_wait_before_first_iteration? ⇒ Boolean

Should perform_loop just straight into work, or start by waiting?

The use case is if we want to report some information (like profiles) from time to time, we may not want to report empty/zero/some residual value immediately when the worker starts.

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/ddtrace/workers/interval_loop.rb', line 71

def loop_wait_before_first_iteration?
  false
end

#loop_wait_time ⇒ Object 



55
56
57
 
# File 'lib/ddtrace/workers/interval_loop.rb', line 55

def loop_wait_time
  @loop_wait_time ||= loop_base_interval
end

#loop_wait_time=(value) ⇒ Object 



59
60
61
 
# File 'lib/ddtrace/workers/interval_loop.rb', line 59

def loop_wait_time=(value)
  @loop_wait_time = value
end

#run_loop? ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
40
41
 
# File 'lib/ddtrace/workers/interval_loop.rb', line 37

def run_loop?
  return false unless instance_variable_defined?(:@run_loop)

  @run_loop == true
end

#stop_loop ⇒ Object 



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/ddtrace/workers/interval_loop.rb', line 22

def stop_loop
  mutex.synchronize do
    return false unless run_loop?

    @run_loop = false
    shutdown.signal
  end

  true
end

#work_pending? ⇒ Boolean

Returns:

  • (Boolean) 


33
34
35
 
# File 'lib/ddtrace/workers/interval_loop.rb', line 33

def work_pending?
  run_loop?
end