class Sidekiq::HeartbeatMonitor::Config
Attributes
max_heartbeat_delay[RW]
max_queue_size[RW]
Public Class Methods
install_cron_job!(output: false)
click to toggle source
# File lib/sidekiq/heartbeat_monitor/config.rb, line 65 def self.install_cron_job!(output: false) job = Sidekiq::Cron::Job.find("sidekiq_monitor") target_job = Sidekiq::Cron::Job.new( name: 'sidekiq_monitor', cron: '* * * * *', klass: Sidekiq::HeartbeatMonitor::Scheduler ) if job.present? if job.cron != target_job.cron && job.klass.to_s != target_job.klass unless job.destroy puts "ERROR: An existing cron job was found with the same name but incorrect configuration. An attempt to delete it (to create a new, correctly configured one) failed." if output return false end if target_job.save puts "SUCCESS: An existing crob job was found that had the same name but had outdated configuration, so it was deleted and a new one was installed successfully." if output true else puts "ERROR: Sidekiq heartbeat monitor found an existing cron job with the same name but it is configured incorrectly. It was deleted, but a new one could not be created. Run this command again to try adding it manually again and please ensure you can programmatically add sidekiq cron jobs as well." if output false end else puts "SUCCESS: Sidekiq heartbeat monitor cron job already exists and appears to be configured properly so nothing was changed." if output true end else if target_job.save puts "SUCCESS: New cron task was installed successfully." if output true else puts "ERROR: New cron task could not be saved for some reason. Please ensure you can programmatically add sidekiq cron jobs and try again." if output false end end end
new(max_queue_size: nil, on_backed_up: nil, on_slowed_down: nil, dont_repeat_for: nil, slack_notifier_url: nil, max_heartbeat_delay: nil)
click to toggle source
@param max_queue_size
[Integer] The maximum queue size (default: 5000 or SIDEKIQ_MONITOR_MAX_QUEUE_SIZE environment value) @param on_backed_up [Proc|Array<Proc>] On backed up run this or these procs @param on_slowed_down [Proc|Array<Proc>] On slowed down run this or these procs @param dont_repeat_for [Integer] The don't repeat for (optional, default: 5.minutes) @param slack_notifier_url [String] The slack notifier url (optional) @param max_heartbeat_delay
[Integer] The maximum heartbeat delay (default: 5 minute, max: 5 days)
# File lib/sidekiq/heartbeat_monitor/config.rb, line 14 def initialize(max_queue_size: nil, on_backed_up: nil, on_slowed_down: nil, dont_repeat_for: nil, slack_notifier_url: nil, max_heartbeat_delay: nil) @max_queue_size = max_queue_size || ENV.fetch('SIDEKIQ_MONITOR_MAX_QUEUE_SIZE', 5000).to_i @dont_repeat_for = dont_repeat_for unless dont_repeat_for.nil? @max_heartbeat_delay = max_heartbeat_delay || 5.minutes @on_backed_up = (on_backed_up.is_a?(Enumerable) ? on_backed_up : [on_backed_up]) unless on_backed_up.nil? @on_slowed_down = (on_slowed_down.is_a?(Enumerable) ? on_slowed_down : [on_slowed_down]) unless on_slowed_down.nil? setup_slack_notifier!(slack_notifier_url) if slack_notifier_url.present? install_cron_job! end
Public Instance Methods
send_backed_up_alert!(message, q)
click to toggle source
# File lib/sidekiq/heartbeat_monitor/config.rb, line 35 def send_backed_up_alert!(message, q) if @on_backed_up.blank? puts ("WARNING: No 'on_backed_up' callback defined for sidekiq-heartbeat_monitor but one of the queues are backed up: #{message}") return end if @dont_repeat_for.nil? @on_backed_up.to_a.each { |alert| alert.call(message, q) } else DontRepeatFor.new(@dont_repeat_for, "Sidekiq/HeartbeatMonitor/#{q.name}/send_backed_up_alert") do @on_backed_up.to_a.each { |alert| alert.call(message, q) } end end end
send_slowed_down_alert!(message, q)
click to toggle source
# File lib/sidekiq/heartbeat_monitor/config.rb, line 50 def send_slowed_down_alert!(message, q) if @on_slowed_down.blank? puts ("WARNING: No 'on_slowed_down' callback defined for sidekiq-heartbeat_monitor but one of the queues are backed up: #{message}") return end if @dont_repeat_for.nil? @on_slowed_down.to_a.each { |alert| alert.call(message, q) } else DontRepeatFor.new(@dont_repeat_for, "Sidekiq/HeartbeatMonitor/#{q.name}/send_slowed_down_alert") do @on_slowed_down.to_a.each { |alert| alert.call(message, q) } end end end
send_test!()
click to toggle source
# File lib/sidekiq/heartbeat_monitor/config.rb, line 29 def send_test! test_queue = Sidekiq::Queue.new('test') send_backed_up_alert("Test backed up alert!", test_queue) send_slowed_down_alert("Test slowed down alert!", test_queue) end
Private Instance Methods
install_cron_job!()
click to toggle source
# File lib/sidekiq/heartbeat_monitor/config.rb, line 114 def install_cron_job! # Only install the cron job if we're running as a sidekiq server return unless Sidekiq.server? self.class.install_cron_job! rescue Redis::CannotConnectError # If we failed to connect at this point then likely Redis is not yet configured at this point in initialization, # so we should just abort false end
setup_slack_notifier!(slack_notifier_url)
click to toggle source
# File lib/sidekiq/heartbeat_monitor/config.rb, line 105 def setup_slack_notifier!(slack_notifier_url) @notifier = Slack::Notifier.new(slack_notifier_url) slack_notifier_callback = [-> (msg, queue) { @notifier.ping(msg) }] @on_backed_up = @on_backed_up.to_a + slack_notifier_callback @on_slowed_down = @on_slowed_down.to_a + slack_notifier_callback end