module SidekiqUniqueJobs::Orphans::Manager
Manages the orphan reaper
@author Mikael Henriksson <mikael@mhenrixon.com>
Constants
- DRIFT_FACTOR
-
@return [Float] the amount to add to the reaper interval
- REAPERS
-
@return [Symbol] allowed reapers (:ruby or :lua)
Public Instance Methods
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 237 def current_timestamp Time.now.to_i end
Current time (as integer value)
@return [Integer]
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 85 def default_task SidekiqUniqueJobs::TimerTask.new(timer_task_options) do with_logging_context do redis do |conn| refresh_reaper_mutex Orphans::Reaper.call(conn) end end end end
A properly configured timer task
@return [SidekiqUniqueJobs::TimerTask]
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 176 def disabled? !enabled? end
Checks if reaping is disabled
@see enabled?
@return [true, false]
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 227 def drift_reaper_interval reaper_interval + (reaper_interval * DRIFT_FACTOR).to_i end
Reaper
interval with a little drift
Redis isn't exact enough so to give a little buffer, we add a tiny value to the reaper interval.
@return [Integer] <description>
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 185 def enabled? REAPERS.include?(reaper) end
Checks if reaping is enabled
@return [true, false]
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 138 def logging_context if logger_context_hash? { "uniquejobs" => "reaper" } else "uniquejobs=orphan-reaper" end end
A context to use for all log entries
@return [Hash] when logger responds to ‘:with_context` @return [String] when logger does not responds to `:with_context`
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 120 def reaper SidekiqUniqueJobs.config.reaper end
@see SidekiqUniqueJobs::Config#reaper
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 127 def reaper_interval SidekiqUniqueJobs.config.reaper_interval end
@see SidekiqUniqueJobs::Config#reaper_interval
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 205 def refresh_reaper_mutex redis { |conn| conn.set(UNIQUE_REAPER, current_timestamp, "ex", drift_reaper_interval) } end
Updates mutex key
@return [void]
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 195 def register_reaper_process redis { |conn| conn.set(UNIQUE_REAPER, current_timestamp, "nx", "ex", drift_reaper_interval) } end
Writes a mutex key to redis
@return [void]
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 152 def registered? redis do |conn| conn.get(UNIQUE_REAPER).to_i + drift_reaper_interval > current_timestamp end end
Checks if a reaper is registered
@return [true, false]
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 35 def start(test_task = nil) return if disabled? return if registered? self.task = test_task || default_task with_logging_context do if register_reaper_process log_info("Starting Reaper") task.add_observer(Observer.new) task.execute task end end end
Starts a separate thread that periodically reaps orphans
@return [SidekiqUniqueJobs::TimerTask] the task that was started
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 58 def stop return if disabled? return if unregistered? with_logging_context do log_info("Stopping Reaper") unregister_reaper_process task.shutdown end end
Stops the thread that reaps orphans
@return [Boolean]
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 75 def task @task ||= default_task # rubocop:disable ThreadSafety/ClassInstanceVariable end
The task that runs the reaper
@return [<type>] <description>
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 103 def task=(task) @task = task # rubocop:disable ThreadSafety/ClassInstanceVariable end
Store a task to use for scheduled execution
@param [SidekiqUniqueJobs::TimerTask] task the task to use
@return [void]
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 113 def timer_task_options { run_now: true, execution_interval: reaper_interval } end
Arguments passed on to the timer task
@return [Hash]
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 215 def unregister_reaper_process redis { |conn| conn.del(UNIQUE_REAPER) } end
Removes mutex key from redis
@return [void]
Source
# File lib/sidekiq_unique_jobs/orphans/manager.rb, line 165 def unregistered? !registered? end
Checks if that reapers are not registerd
@see registered?
@return [true, false]