class Sidekiq::ProcessSet
Enumerates the set of Sidekiq
processes which are actively working right now. Each process send a heartbeat to Redis every 5 seconds so this set should be relatively accurate, barring network partitions.
Yields a Sidekiq::Process
.
Public Class Methods
new(clean_plz=true)
click to toggle source
# File lib/sidekiq/api.rb, line 736 def initialize(clean_plz=true) cleanup if clean_plz end
Public Instance Methods
cleanup()
click to toggle source
Cleans up dead processes recorded in Redis. Returns the number of processes cleaned.
# File lib/sidekiq/api.rb, line 742 def cleanup count = 0 Sidekiq.redis do |conn| procs = sscan(conn, 'processes').sort heartbeats = conn.pipelined do procs.each do |key| conn.hget(key, 'info') end end # the hash named key has an expiry of 60 seconds. # if it's not found, that means the process has not reported # in to Redis and probably died. to_prune = [] heartbeats.each_with_index do |beat, i| to_prune << procs[i] if beat.nil? end count = conn.srem('processes', to_prune) unless to_prune.empty? end count end
each() { |process(merge('busy' => to_i, 'beat' => to_f, 'quiet' => quiet))| ... }
click to toggle source
# File lib/sidekiq/api.rb, line 764 def each procs = Sidekiq.redis { |conn| sscan(conn, 'processes') }.sort Sidekiq.redis do |conn| # We're making a tradeoff here between consuming more memory instead of # making more roundtrips to Redis, but if you have hundreds or thousands of workers, # you'll be happier this way result = conn.pipelined do procs.each do |key| conn.hmget(key, 'info', 'busy', 'beat', 'quiet') end end result.each do |info, busy, at_s, quiet| # If a process is stopped between when we query Redis for `procs` and # when we query for `result`, we will have an item in `result` that is # composed of `nil` values. next if info.nil? hash = Sidekiq.load_json(info) yield Process.new(hash.merge('busy' => busy.to_i, 'beat' => at_s.to_f, 'quiet' => quiet)) end end nil end
leader()
click to toggle source
Returns the identity of the current cluster leader or “” if no leader. This is a Sidekiq
Enterprise feature, will always return “” in Sidekiq
or Sidekiq
Pro.
# File lib/sidekiq/api.rb, line 802 def leader @leader ||= begin x = Sidekiq.redis {|c| c.get("dear-leader") } # need a non-falsy value so we can memoize x = "" unless x x end end
size()
click to toggle source
This method is not guaranteed accurate since it does not prune the set based on current heartbeat. each
does that and ensures the set only contains Sidekiq
processes which have sent a heartbeat within the last 60 seconds.
# File lib/sidekiq/api.rb, line 795 def size Sidekiq.redis { |conn| conn.scard('processes') } end