class Sidekiq::WorkSet
The WorkSet
stores the work being done by this Sidekiq
cluster. It tracks the process and thread working on each job.
WARNING WARNING WARNING
This is live data that can change every millisecond. If you call size
=> 5 and then expect each
to be called 5 times, you’re going to have a bad time.
works = Sidekiq::WorkSet.new works.size => 2 works.each do |process_id, thread_id, work| # process_id is a unique identifier per Sidekiq process # thread_id is a unique identifier per thread # work is a `Sidekiq::Work` instance that has the following accessor methods. # [work.queue, work.run_at, work.payload] # run_at is an epoch Integer. end
Public Instance Methods
Source
# File lib/sidekiq/api.rb, line 1177 def each(&block) results = [] procs = nil all_works = nil Sidekiq.redis do |conn| procs = conn.sscan("processes").to_a.sort all_works = conn.pipelined do |pipeline| procs.each do |key| pipeline.hgetall("#{key}:work") end end end procs.zip(all_works).each do |key, workers| workers.each_pair do |tid, json| results << [key, tid, Sidekiq::Work.new(key, tid, Sidekiq.load_json(json))] unless json.empty? end end results.sort_by { |(_, _, work)| work.run_at }.each(&block) end
Source
# File lib/sidekiq/api.rb, line 1227 def find_work(jid) each do |_process_id, _thread_id, work| job = work.job return work if job.jid == jid end nil end
Find the work which represents a job with the given JID. *This is a slow O(n) operation*. Do not use for app logic.
@param jid [String] the job identifier @return [Sidekiq::Work] the work or nil
Also aliased as: find_work_by_jid
Source
# File lib/sidekiq/api.rb, line 1206 def size Sidekiq.redis do |conn| procs = conn.sscan("processes").to_a if procs.empty? 0 else conn.pipelined { |pipeline| procs.each do |key| pipeline.hget(key, "busy") end }.sum(&:to_i) end end end
Note that size
is only as accurate as Sidekiq’s heartbeat, which happens every 5 seconds. It is NOT real-time.
Not very efficient if you have lots of Sidekiq
processes but the alternative is a global counter which can easily get out of sync with crashy processes.