Module: Sidekiq

Defined in:
lib/sidekiq.rb,
lib/sidekiq/api.rb,
lib/sidekiq/cli.rb,
lib/sidekiq/web.rb,
lib/sidekiq/util.rb,
lib/sidekiq/fetch.rb,
lib/sidekiq/rails.rb,
lib/sidekiq/client.rb,
lib/sidekiq/worker.rb,
lib/sidekiq/logging.rb,
lib/sidekiq/manager.rb,
lib/sidekiq/testing.rb,
lib/sidekiq/version.rb,
lib/sidekiq/launcher.rb,
lib/sidekiq/paginator.rb,
lib/sidekiq/processor.rb,
lib/sidekiq/scheduled.rb,
lib/sidekiq/web_helpers.rb,
lib/sidekiq/middleware/chain.rb,
lib/sidekiq/redis_connection.rb,
lib/sidekiq/exception_handler.rb,
lib/sidekiq/extensions/action_mailer.rb,
lib/sidekiq/extensions/active_record.rb,
lib/sidekiq/extensions/class_methods.rb,
lib/sidekiq/extensions/generic_proxy.rb,
lib/sidekiq/middleware/server/logging.rb,
lib/generators/sidekiq/worker_generator.rb,
lib/sidekiq/middleware/server/retry_jobs.rb,
lib/sidekiq/middleware/server/active_record.rb

Defined Under Namespace

Modules: ExceptionHandler, Extensions, Generators, Logging, Middleware, Paginator, Queues, Scheduled, Util, WebHelpers, Worker Classes: BasicFetch, CLI, Client, DeadSet, EmptyQueueError, Job, JobSet, Launcher, Manager, Process, ProcessSet, Processor, Queue, Rails, RedisConnection, RetrySet, ScheduledSet, Shutdown, SortedEntry, SortedSet, Stats, Testing, Web, Workers

Constant Summary collapse

NAME = 
'Sidekiq'
LICENSE = 
'See LICENSE and the LGPL-3.0 for licensing details.'
DEFAULTS = 
{
  queues: [],
  labels: [],
  concurrency: 25,
  require: '.',
  environment: nil,
  timeout: 8,
  poll_interval_average: nil,
  average_scheduled_poll_interval: 15,
  error_handlers: [],
  lifecycle_events: {
    startup: [],
    quiet: [],
    shutdown: [],
  },
  dead_max_jobs: 10_000,
  dead_timeout_in_seconds: 180 * 24 * 60 * 60 # 6 months
}
DEFAULT_WORKER_OPTIONS = 
{
  'retry' => true,
  'queue' => 'default'
}
FAKE_INFO = 
{
  "redis_version" => "9.9.9",
  "uptime_in_days" => "9999",
  "connected_clients" => "9999",
  "used_memory_human" => "9P",
  "used_memory_peak_human" => "9P"
}.freeze
VERSION = 
"4.1.6"

Class Method Summary collapse

Class Method Details

.average_scheduled_poll_interval=(interval) ⇒ Object

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



195
196
197
 
# 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| ... } ⇒ Object

Yields:

  • (@client_chain) 


132
133
134
135
136
 
# 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| ... } ⇒ Object

Configuration for Sidekiq client, use like:

Sidekiq.configure_client do |config|
  config.redis = { :namespace => 'myapp', :size => 1, :url => 'redis://myhost:8877/0' }
end

Yields:

  • (_self)

Yield Parameters:

  • _self (Sidekiq) —

    the object that the method was called on



79
80
81
 
# File 'lib/sidekiq.rb', line 79

def self.configure_client
  yield self unless server?
end

.configure_server {|_self| ... } ⇒ Object

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

Yields:

  • (_self)

Yield Parameters:

  • _self (Sidekiq) —

    the object that the method was called on



69
70
71
 
# File 'lib/sidekiq.rb', line 69

def self.configure_server
  yield self if server?
end

.default_retries_exhausted ⇒ Object 



172
173
174
 
# File 'lib/sidekiq.rb', line 172

def self.default_retries_exhausted
  @default_retries_exhausted
end

.default_retries_exhausted=(prok) ⇒ Object

Sidekiq.configure_server do |config|

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

end



169
170
171
 
# File 'lib/sidekiq.rb', line 169

def self.default_retries_exhausted=(prok)
  @default_retries_exhausted = prok
end

.default_server_middleware ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
 
# 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 ⇒ Object 



161
162
163
 
# 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) ⇒ Object 



158
159
160
 
# 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) ⇒ Object 



179
180
181
 
# File 'lib/sidekiq.rb', line 179

def self.dump_json(object)
  JSON.generate(object)
end

.error_handlers ⇒ Object

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 Sidekiq.logger.



206
207
208
 
# File 'lib/sidekiq.rb', line 206

def self.error_handlers
  self.options[:error_handlers]
end

.hook_rails! ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
 
# 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) ⇒ Object 



176
177
178
 
# File 'lib/sidekiq.rb', line 176

def self.load_json(string)
  JSON.parse(string)
end

.logger ⇒ Object 



183
184
185
 
# File 'lib/sidekiq.rb', line 183

def self.logger
  Sidekiq::Logging.logger
end

.logger=(log) ⇒ Object 



186
187
188
 
# File 'lib/sidekiq.rb', line 186

def self.logger=(log)
  Sidekiq::Logging.logger = log
end

.on(event, &block) ⇒ Object

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

Raises:

  • (ArgumentError) 


218
219
220
221
222
 
# 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 ⇒ Object 



53
54
55
 
# File 'lib/sidekiq.rb', line 53

def self.options
  @options ||= DEFAULTS.dup
end

.options=(opts) ⇒ Object 



56
57
58
 
# File 'lib/sidekiq.rb', line 56

def self.options=(opts)
  @options = opts
end

.redis ⇒ Object

Raises:

  • (ArgumentError) 


87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# 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) ⇒ Object 



124
125
126
127
128
129
130
 
# 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 ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# 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 ⇒ Object 



120
121
122
 
# File 'lib/sidekiq.rb', line 120

def self.redis_pool
  @redis ||= Sidekiq::RedisConnection.create
end

.remove_delay! ⇒ Object

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.



20
21
22
23
24
25
26
27
28
29
30
31
32
 
# 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? ⇒ Boolean

Returns:

  • (Boolean) 


83
84
85
 
# File 'lib/sidekiq.rb', line 83

def self.server?
  defined?(Sidekiq::CLI)
end

.server_middleware {|@server_chain| ... } ⇒ Object

Yields:

  • (@server_chain) 


138
139
140
141
142
 
# File 'lib/sidekiq.rb', line 138

def self.server_middleware
  @server_chain ||= default_server_middleware
  yield @server_chain if block_given?
  @server_chain
end

.❨╯°□°❩╯︵┻━┻ ⇒ Object 



49
50
51
 
# File 'lib/sidekiq.rb', line 49

def self.