Class: Resque::StuckQueue::Config

Inherits:
Hash
  • Object
show all
Defined in:
lib/resque_stuck_queue/config.rb

Defined Under Namespace

Classes: NoConfigError

Constant Summary collapse

OPTIONS_DESCRIPTIONS = 
{
  :triggered_handler  => "set to what gets triggered when resque-stuck-queue will detect the latest heartbeat is older than the trigger_timeout time setting.\n\tExample:\n\tResque::StuckQueue.config[:triggered_handler] = proc { |queue_name, lagtime| send_email('queue \#{queue_name} isnt working, aaah the daemons') }",
  :recovered_handler  => "set to what gets triggered when resque-stuck-queue has triggered a problem, but then detects the queue went back down to functioning well again(it wont trigger again until it has recovered).\n\tExample:\n\tResque::StuckQueue.config[:recovered_handler] = proc { |queue_name, lagtime| send_email('phew, queue \#{queue_name} is ok') }",
  :heartbeat_interval => "set to how often to push the 'heartbeat' job which will refresh the latest working time.\n\tExample:\n\tResque::StuckQueue.config[:heartbeat_interval] = 5.minutes",
  :watcher_interval            => "set to how often to check to see when the last time it worked was.\n\tExample:\n\tResque::StuckQueue.config[:watcher_interval] = 1.minute",
  :trigger_timeout    => "set to how much of a resque work lag you are willing to accept before being notified. note: take the :watcher_interval setting into account when setting this timeout.\n\tExample:\n\tResque::StuckQueue.config[:trigger_timeout] = 9.minutes",
  :warn_interval      => "optional: if set, it will continiously trigger/warn in spaces of this interval after first trigger. eg, as long as lagtime keeps on being above trigger_timeout/recover hasn't occured yet.",
  :redis              => "set the Redis StuckQueue will use. Either a Redis or Redis::Namespace instance.",
  :heartbeat_key      => "optional, name of keys to keep track of the last good resque heartbeat time",
  :triggered_key      => "optional, name of keys to keep track of the last trigger time",
  :logger             => "optional, pass a Logger. Default a ruby logger will be instantiated. Needs to respond to that interface.",
  :queues             => "optional, monitor specific queues you want to send a heartbeat/monitor to. default is [:app]",
  :abort_on_exception => "optional, if you want the resque-stuck-queue threads to explicitly raise, default is true",
  :heartbeat_job      => "optional, your own custom refreshing job. if you are using something other than resque",
  :enable_signals     => "optional, allow resque::stuck's signal_handlers which do mostly nothing at this point. possible future plan: log info, reopen log file, etc.",
}
OPTIONS = 
OPTIONS_DESCRIPTIONS.keys
REQUIRED_KEYS = 
[:redis]

Instance Method Summary collapse

Instance Method Details

#[](k) ⇒ Object 



45
46
47
48
 
# File 'lib/resque_stuck_queue/config.rb', line 45

def [](k)
  validate_key_exists!(k)
  super(k)
end

#[]=(k, v) ⇒ Object 



40
41
42
43
 
# File 'lib/resque_stuck_queue/config.rb', line 40

def []=(k,v)
  validate_key_exists!(k)
  super(k,v)
end

#description_for(k) ⇒ Object 



67
68
69
 
# File 'lib/resque_stuck_queue/config.rb', line 67

def description_for(k)
  OPTIONS_DESCRIPTIONS[k.to_sym]
end

#pretty_descriptions ⇒ Object 



71
72
73
74
75
76
77
 
# File 'lib/resque_stuck_queue/config.rb', line 71

def pretty_descriptions
  out = "\n"
  OPTIONS_DESCRIPTIONS.map{|key,msg|
    out << "#{key}:\n\t#{msg}\n\n"
  }
  out
end

#validate_key_exists!(k) ⇒ Object 



61
62
63
64
65
 
# File 'lib/resque_stuck_queue/config.rb', line 61

def validate_key_exists!(k)
  if !OPTIONS.include?(k)
    raise NoConfigError, "no such config key #{k} exists!"
  end
end

#validate_required_keys! ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/resque_stuck_queue/config.rb', line 51

def validate_required_keys!
  REQUIRED_KEYS.each do |k|
    if self[k].nil?
      raise NoConfigError, "You must set config[:#{k}]"
    end
  end
end