Class: ScoutApm::BackgroundWorker

Inherits:
Object
  • Object
show all
Defined in:
lib/scout_apm/background_worker.rb

Constant Summary collapse

DEFAULT_PERIOD =

in seconds, time between when the worker thread wakes up and runs.

60

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(period = DEFAULT_PERIOD) ⇒ BackgroundWorker

Returns a new instance of BackgroundWorker.



9
10
11
12
 
# File 'lib/scout_apm/background_worker.rb', line 9

def initialize(period=DEFAULT_PERIOD)
  @period = period
  @keep_running = true
end

Instance Attribute Details

#period ⇒ Object (readonly)

Returns the value of attribute period.



7
8
9
 
# File 'lib/scout_apm/background_worker.rb', line 7

def period
  @period
end

Instance Method Details

#run_once ⇒ Object

Runs the task passed to start once.



20
21
22
 
# File 'lib/scout_apm/background_worker.rb', line 20

def run_once
  @task.call if @task
end

#start(&block) ⇒ Object

Starts running the passed block every 60 seconds (starting now).



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
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/scout_apm/background_worker.rb', line 25

def start(&block)
  @task = block

  begin
    ScoutApm::Agent.instance.logger.debug "Background Worker: Starting Background Worker, running every #{period} seconds"

    # The first run should be 1 period of time from now
    next_time = Time.now + period

    loop do
      # Bail out if @keep_running is false
      unless @keep_running
        ScoutApm::Agent.instance.logger.debug "Background Worker: breaking from loop"
        break
      end

      now = Time.now

      # Sleep the correct amount of time to reach next_time
      while now < next_time && @keep_running
        sleep_time = next_time - now
        sleep(sleep_time) if sleep_time > 0
        now = Time.now
      end

      @task.call

      # Adjust the next time to run forward by @periods until it is in the future
      while next_time <= now
        next_time += period
      end
    end
  rescue
    ScoutApm::Agent.instance.logger.debug "Background Worker Exception!"
    ScoutApm::Agent.instance.logger.debug $!.message
    ScoutApm::Agent.instance.logger.debug $!.backtrace
  end
end

#stop ⇒ Object 



14
15
16
17
 
# File 'lib/scout_apm/background_worker.rb', line 14

def stop
  ScoutApm::Agent.instance.logger.debug "Background Worker: stop requested"
  @keep_running = false
end