module Sidekiq

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

frozen_string_literal: true

Constants

DEFAULTS
DEFAULT_WORKER_OPTIONS
FAKE_INFO
LICENSE
NAME
VERSION

Public Class Methods

average_scheduled_poll_interval=(interval) click to toggle source

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 195
def self.average_scheduled_poll_interval=(interval)
  self.options[:average_scheduled_poll_interval] = interval
end
client_middleware() { |client_chain| ... } click to toggle source
# File lib/sidekiq.rb, line 132
def self.client_middleware
  @client_chain ||= Middleware::Chain.new
  yield @client_chain if block_given?
  @client_chain
end
configure_client() { |self| ... } click to toggle source

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 79
def self.configure_client
  yield self unless server?
end
configure_server() { |self| ... } click to toggle source

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 69
def self.configure_server
  yield self if server?
end
default_retries_exhausted() click to toggle source
# File lib/sidekiq.rb, line 172
def self.default_retries_exhausted
  @default_retries_exhausted
end
default_retries_exhausted=(prok) click to toggle source

::configure_server do |config|

config.default_retries_exhausted = -> (job, ex) do
end

end

# File lib/sidekiq.rb, line 169
def self.default_retries_exhausted=(prok)
  @default_retries_exhausted = prok
end
default_server_middleware() click to toggle source
# File lib/sidekiq.rb, line 144
def self.default_server_middleware
  require 'sidekiq/middleware/server/retry_jobs'
  require 'sidekiq/middleware/server/logging'

  Middleware::Chain.new do |m|
    m.add Middleware::Server::Logging
    m.add Middleware::Server::RetryJobs
    if defined?(::ActiveRecord::Base)
      require 'sidekiq/middleware/server/active_record'
      m.add Sidekiq::Middleware::Server::ActiveRecord
    end
  end
end
default_worker_options() click to toggle source
# File lib/sidekiq.rb, line 161
def self.default_worker_options
  defined?(@default_worker_options) ? @default_worker_options : DEFAULT_WORKER_OPTIONS
end
default_worker_options=(hash) click to toggle source
# File lib/sidekiq.rb, line 158
def self.default_worker_options=(hash)
  @default_worker_options = default_worker_options.merge(hash.stringify_keys)
end
dump_json(object) click to toggle source
# File lib/sidekiq.rb, line 179
def self.dump_json(object)
  JSON.generate(object)
end
error_handlers() click to toggle source

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 206
def self.error_handlers
  self.options[:error_handlers]
end
hook_rails!() click to toggle source
# File lib/sidekiq/rails.rb, line 3
def self.hook_rails!
  return if defined?(@delay_removed)

  ActiveSupport.on_load(:active_record) do
    include Sidekiq::Extensions::ActiveRecord
  end

  ActiveSupport.on_load(:action_mailer) do
    extend Sidekiq::Extensions::ActionMailer
  end

  Module.__send__(:include, Sidekiq::Extensions::Klass)
end
load_json(string) click to toggle source
# File lib/sidekiq.rb, line 176
def self.load_json(string)
  JSON.parse(string)
end
logger() click to toggle source
# File lib/sidekiq.rb, line 183
def self.logger
  Sidekiq::Logging.logger
end
logger=(log) click to toggle source
# File lib/sidekiq.rb, line 186
def self.logger=(log)
  Sidekiq::Logging.logger = log
end
on(event, &block) click to toggle source

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 218
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
options() click to toggle source
# File lib/sidekiq.rb, line 53
def self.options
  @options ||= DEFAULTS.dup
end
options=(opts) click to toggle source
# File lib/sidekiq.rb, line 56
def self.options=(opts)
  @options = opts
end
redis() { |conn| ... } click to toggle source
# File lib/sidekiq.rb, line 87
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
redis=(hash) click to toggle source
# File lib/sidekiq.rb, line 124
def self.redis=(hash)
  @redis = if hash.is_a?(ConnectionPool)
    hash
  else
    Sidekiq::RedisConnection.create(hash)
  end
end
redis_info() click to toggle source
# File lib/sidekiq.rb, line 102
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
redis_pool() click to toggle source
# File lib/sidekiq.rb, line 120
def self.redis_pool
  @redis ||= Sidekiq::RedisConnection.create
end
remove_delay!() click to toggle source

Removes the generic aliases which MAY clash with names of already

created methods by other applications. The methods `sidekiq_delay`,
`sidekiq_delay_for` and `sidekiq_delay_until` can be used instead.
# File lib/sidekiq/rails.rb, line 20
def self.remove_delay!
  @delay_removed = true

  [Extensions::ActiveRecord,
   Extensions::ActionMailer,
   Extensions::Klass].each do |mod|
    mod.module_eval do
      remove_method :delay if respond_to?(:delay)
      remove_method :delay_for if respond_to?(:delay_for)
      remove_method :delay_until if respond_to?(:delay_until)
    end
  end
end
server?() click to toggle source
# File lib/sidekiq.rb, line 83
def self.server?
  defined?(Sidekiq::CLI)
end
server_middleware() { |server_chain| ... } click to toggle source
# File lib/sidekiq.rb, line 138
def self.server_middleware
  @server_chain ||= default_server_middleware
  yield @server_chain if block_given?
  @server_chain
end
❨╯°□°❩╯︵┻━┻() click to toggle source
# File lib/sidekiq.rb, line 49
def self.❨╯°□°❩╯︵┻━┻
  puts "Calm down, yo."
end