module Sidekiq
Constants
- DEFAULTS
- DEFAULT_WORKER_OPTIONS
- FAKE_INFO
- LICENSE
- NAME
- VERSION
Public Class Methods
How frequently Redis should be checked by a random Sidekiq process for scheduled and retriable jobs. Each individual process will take turns by waiting some multiple of this value.
See sidekiq/scheduled.rb for an in-depth explanation of this value
# File lib/sidekiq.rb, line 196 def self.average_scheduled_poll_interval=(interval) self.options[:average_scheduled_poll_interval] = interval end
# File lib/sidekiq.rb, line 134 def self.client_middleware @client_chain ||= Middleware::Chain.new yield @client_chain if block_given? @client_chain end
Configuration for Sidekiq client, use like:
Sidekiq.configure_client do |config| config.redis = { :namespace => 'myapp', :size => 1, :url => 'redis://myhost:8877/0' } end
# File lib/sidekiq.rb, line 81 def self.configure_client yield self unless server? end
Configuration for Sidekiq server, use like:
Sidekiq.configure_server do |config| config.redis = { :namespace => 'myapp', :size => 25, :url => 'redis://myhost:8877/0' } config.server_middleware do |chain| chain.add MyServerHook end end
# File lib/sidekiq.rb, line 71 def self.configure_server yield self if server? end
Death handlers are called when all retries for a job have been exhausted and the job dies. It's the notification to your application that this job will not succeed without manual intervention.
::configure_server do |config|
config.death_handlers << ->(job, ex) do end
end
# File lib/sidekiq.rb, line 173 def self.death_handlers options[:death_handlers] end
# File lib/sidekiq.rb, line 158 def self.default_retries_exhausted=(prok) logger.info { "default_retries_exhausted is deprecated, please use `config.death_handlers << -> {|job, ex| }`" } return nil unless prok death_handlers << prok end
# File lib/sidekiq.rb, line 146 def self.default_server_middleware Middleware::Chain.new end
# File lib/sidekiq.rb, line 154 def self.default_worker_options defined?(@default_worker_options) ? @default_worker_options : DEFAULT_WORKER_OPTIONS end
# File lib/sidekiq.rb, line 150 def self.default_worker_options=(hash) # stringify @default_worker_options = default_worker_options.merge(Hash[hash.map{|k, v| [k.to_s, v]}]) end
# File lib/sidekiq.rb, line 180 def self.dump_json(object) JSON.generate(object) end
Register a proc to handle any error which occurs within the Sidekiq process.
Sidekiq.configure_server do |config| config.error_handlers << proc {|ex,ctx_hash| MyErrorService.notify(ex, ctx_hash) } end
The default error handler logs errors to ::logger.
# File lib/sidekiq.rb, line 207 def self.error_handlers self.options[:error_handlers] end
# File lib/sidekiq.rb, line 177 def self.load_json(string) JSON.parse(string) end
# File lib/sidekiq.rb, line 184 def self.logger Sidekiq::Logging.logger end
# File lib/sidekiq.rb, line 187 def self.logger=(log) Sidekiq::Logging.logger = log end
Register a block to run at a point in the Sidekiq lifecycle. :startup, :quiet or :shutdown are valid events.
Sidekiq.configure_server do |config| config.on(:shutdown) do puts "Goodbye cruel world!" end end
# File lib/sidekiq.rb, line 219 def self.on(event, &block) raise ArgumentError, "Symbols only please: #{event}" unless event.is_a?(Symbol) raise ArgumentError, "Invalid event name: #{event}" unless options[:lifecycle_events].key?(event) options[:lifecycle_events][event] << block end
# File lib/sidekiq.rb, line 55 def self.options @options ||= DEFAULTS.dup end
# File lib/sidekiq.rb, line 58 def self.options=(opts) @options = opts end
# File lib/sidekiq.rb, line 89 def self.redis raise ArgumentError, "requires a block" unless block_given? redis_pool.with do |conn| retryable = true begin yield conn rescue Redis::CommandError => ex #2550 Failover can cause the server to become a slave, need # to disconnect and reopen the socket to get back to the master. (conn.disconnect!; retryable = false; retry) if retryable && ex.message =~ /READONLY/ raise end end end
# File lib/sidekiq.rb, line 126 def self.redis=(hash) @redis = if hash.is_a?(ConnectionPool) hash else Sidekiq::RedisConnection.create(hash) end end
# File lib/sidekiq.rb, line 104 def self.redis_info redis do |conn| begin # admin commands can't go through redis-namespace starting # in redis-namespace 2.0 if conn.respond_to?(:namespace) conn.redis.info else conn.info end rescue Redis::CommandError => ex #2850 return fake version when INFO command has (probably) been renamed raise unless ex.message =~ /unknown command/ FAKE_INFO end end end
# File lib/sidekiq.rb, line 122 def self.redis_pool @redis ||= Sidekiq::RedisConnection.create end
# File lib/sidekiq.rb, line 85 def self.server? defined?(Sidekiq::CLI) end
# File lib/sidekiq.rb, line 140 def self.server_middleware @server_chain ||= default_server_middleware yield @server_chain if block_given? @server_chain end
# File lib/sidekiq.rb, line 51 def self.❨╯°□°❩╯︵┻━┻ puts "Calm down, yo." end