class Sidekiq::Client
Attributes
Public Class Methods
Resque compatibility helpers. Note all helpers should go through Worker#client_push.
Example usage:
Sidekiq::Client.enqueue(MyWorker, 'foo', 1, :bat => 'bar')
Messages are enqueued to the 'default' queue.
# File lib/sidekiq/client.rb, line 146 def enqueue(klass, *args) klass.client_push('class' => klass, 'args' => args) end
Example usage:
Sidekiq::Client.enqueue_in(3.minutes, MyWorker, 'foo', 1, :bat => 'bar')
# File lib/sidekiq/client.rb, line 174 def enqueue_in(interval, klass, *args) klass.perform_in(interval, *args) end
Example usage:
Sidekiq::Client.enqueue_to(:queue_name, MyWorker, 'foo', 1, :bat => 'bar')
# File lib/sidekiq/client.rb, line 153 def enqueue_to(queue, klass, *args) klass.client_push('queue' => queue, 'class' => klass, 'args' => args) end
Example usage:
Sidekiq::Client.enqueue_to_in(:queue_name, 3.minutes, MyWorker, 'foo', 1, :bat => 'bar')
# File lib/sidekiq/client.rb, line 160 def enqueue_to_in(queue, interval, klass, *args) int = interval.to_f now = Time.now.to_f ts = (int < 1_000_000_000 ? now + int : int) item = { 'class' => klass, 'args' => args, 'at' => ts, 'queue' => queue } item.delete('at') if ts <= now klass.client_push(item) end
Sidekiq::Client normally uses the default Redis pool but you may pass a custom ConnectionPool if you want to shard your Sidekiq jobs across several Redis instances (for scalability reasons, e.g.)
Sidekiq::Client.new(ConnectionPool.new { Redis.new })
Generally this is only needed for very large Sidekiq installs processing thousands of jobs per second. I don't recommend sharding unless you cannot scale any other way (e.g. splitting your app into smaller apps).
# File lib/sidekiq/client.rb, line 40 def initialize(redis_pool=nil) @redis_pool = redis_pool || Thread.current[:sidekiq_via_pool] || Sidekiq.redis_pool end
# File lib/sidekiq/client.rb, line 130 def push(item) new.push(item) end
# File lib/sidekiq/client.rb, line 134 def push_bulk(items) new.push_bulk(items) end
Allows sharding of jobs across any number of Redis instances. All jobs defined within the block will use the given Redis connection pool.
pool = ConnectionPool.new { Redis.new } Sidekiq::Client.via(pool) do SomeWorker.perform_async(1,2,3) SomeOtherWorker.perform_async(1,2,3) end
Generally this is only needed for very large Sidekiq installs processing thousands of jobs per second. I do not recommend sharding unless you cannot scale any other way (e.g. splitting your app into smaller apps).
# File lib/sidekiq/client.rb, line 119 def self.via(pool) raise ArgumentError, "No pool given" if pool.nil? current_sidekiq_pool = Thread.current[:sidekiq_via_pool] Thread.current[:sidekiq_via_pool] = pool yield ensure Thread.current[:sidekiq_via_pool] = current_sidekiq_pool end
Public Instance Methods
Define client-side middleware:
client = Sidekiq::Client.new client.middleware do |chain| chain.use MyClientMiddleware end client.push('class' => 'SomeWorker', 'args' => [1,2,3])
All client instances default to the globally-defined Sidekiq.client_middleware but you can change as necessary.
# File lib/sidekiq/client.rb, line 19 def middleware(&block) @chain ||= Sidekiq.client_middleware if block_given? @chain = @chain.dup yield @chain end @chain end
The main method used to push a job to Redis. Accepts a number of options:
queue - the named queue to use, default 'default' class - the worker class to call, required args - an array of simple arguments to the perform method, must be JSON-serializable at - timestamp to schedule the job (optional), must be Numeric (e.g. Time.now.to_f) retry - whether to retry this job if it fails, default true or an integer number of retries backtrace - whether to save any error backtrace, default false
If class is set to the class name, the jobs' options will be based on Sidekiq's default worker options. Otherwise, they will be based on the job class's options.
Any options valid for a worker class's sidekiq_options are also available here.
All options must be strings, not symbols. NB: because we are serializing to JSON, all symbols in 'args' will be converted to strings. Note that +backtrace: true+ can take quite a bit of space in Redis; a large volume of failing jobs can start Redis swapping if you aren't careful.
Returns a unique Job ID. If middleware stops the job, nil will be returned instead.
Example:
push('queue' => 'my_queue', 'class' => MyWorker, 'args' => ['foo', 1, :bat => 'bar'])
# File lib/sidekiq/client.rb, line 68 def push(item) normed = normalize_item(item) payload = process_single(item['class'], normed) if payload raw_push([payload]) payload['jid'] end end
Push a large number of jobs to Redis. This method cuts out the redis network round trip latency. I wouldn't recommend pushing more than 1000 per call but YMMV based on network quality, size of job args, etc. A large number of jobs can cause a bit of Redis command processing latency.
Takes the same arguments as push except that args is expected to be an Array of Arrays. All other keys are duplicated for each job. Each job is run through the client middleware pipeline and each job gets its own Job ID as normal.
Returns an array of the of pushed jobs' jids. The number of jobs pushed can be less than the number given if the middleware stopped processing for one or more jobs.
# File lib/sidekiq/client.rb, line 91 def push_bulk(items) arg = items['args'].first return [] unless arg # no jobs to push raise ArgumentError, "Bulk arguments must be an Array of Arrays: [[1], [2]]" if !arg.is_a?(Array) normed = normalize_item(items) payloads = items['args'].map do |args| copy = normed.merge('args' => args, 'jid' => SecureRandom.hex(12), 'enqueued_at' => Time.now.to_f) result = process_single(items['class'], copy) result ? result : nil end.compact raw_push(payloads) if !payloads.empty? payloads.collect { |payload| payload['jid'] } end
Private Instance Methods
# File lib/sidekiq/client.rb, line 190 def atomic_push(conn, payloads) if payloads.first['at'] conn.zadd('schedule', payloads.map do |hash| at = hash.delete('at').to_s [at, Sidekiq.dump_json(hash)] end) else q = payloads.first['queue'] now = Time.now.to_f to_push = payloads.map do |entry| entry['enqueued_at'] = now Sidekiq.dump_json(entry) end conn.sadd('queues', q) conn.lpush("queue:#{q}", to_push) end end
# File lib/sidekiq/client.rb, line 216 def normalize_item(item) raise(ArgumentError, "Job must be a Hash with 'class' and 'args' keys: { 'class' => SomeWorker, 'args' => ['bob', 1, :foo => 'bar'] }") unless item.is_a?(Hash) && item.has_key?('class') && item.has_key?('args') raise(ArgumentError, "Job args must be an Array") unless item['args'].is_a?(Array) raise(ArgumentError, "Job class must be either a Class or String representation of the class name") unless item['class'].is_a?(Class) || item['class'].is_a?(String) raise(ArgumentError, "Job 'at' must be a Numeric timestamp") if item.has_key?('at') && !item['at'].is_a?(Numeric) #raise(ArgumentError, "Arguments must be native JSON types, see https://github.com/mperham/sidekiq/wiki/Best-Practices") unless JSON.load(JSON.dump(item['args'])) == item['args'] normalized_hash(item['class']) .each{ |key, value| item[key] = value if item[key].nil? } item['class'] = item['class'].to_s item['queue'] = item['queue'].to_s item['jid'] ||= SecureRandom.hex(12) item['created_at'] ||= Time.now.to_f item end
# File lib/sidekiq/client.rb, line 233 def normalized_hash(item_class) if item_class.is_a?(Class) raise(ArgumentError, "Message must include a Sidekiq::Worker class, not class name: #{item_class.ancestors.inspect}") if !item_class.respond_to?('get_sidekiq_options') item_class.get_sidekiq_options else Sidekiq.default_worker_options end end
# File lib/sidekiq/client.rb, line 208 def process_single(worker_class, item) queue = item['queue'] middleware.invoke(worker_class, item, queue, @redis_pool) do item end end
# File lib/sidekiq/client.rb, line 181 def raw_push(payloads) @redis_pool.with do |conn| conn.multi do atomic_push(conn, payloads) end end true end