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/delay.rb,
lib/sidekiq/fetch.rb,
lib/sidekiq/rails.rb,
lib/sidekiq/client.rb,
lib/sidekiq/logger.rb,
lib/sidekiq/worker.rb,
lib/sidekiq/manager.rb,
lib/sidekiq/testing.rb,
lib/sidekiq/version.rb,
lib/sidekiq/launcher.rb,
lib/sidekiq/job_retry.rb,
lib/sidekiq/paginator.rb,
lib/sidekiq/processor.rb,
lib/sidekiq/scheduled.rb,
lib/sidekiq/job_logger.rb,
lib/sidekiq/web/action.rb,
lib/sidekiq/web/router.rb,
lib/sidekiq/web/helpers.rb,
lib/sidekiq/web/application.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/generators/sidekiq/worker_generator.rb

Defined Under Namespace

Modules: Context, ExceptionHandler, Extensions, Generators, LoggingUtils, Middleware, Paginator, Queues, Scheduled, TestingClient, TestingExtensions, Util, WebHelpers, WebRouter, Worker Classes: BasicFetch, CLI, Client, DeadSet, EmptyQueueError, Job, JobLogger, JobRetry, JobSet, Launcher, Logger, Manager, Monitor, Process, ProcessSet, Processor, Queue, Rails, RedisConnection, RetrySet, ScheduledSet, Shutdown, SortedEntry, SortedSet, Stats, Testing, Web, WebAction, WebApplication, WebRoute, Workers

Constant Summary collapse

NAME = 
"Sidekiq"
LICENSE = 
"See LICENSE and the LGPL-3.0 for licensing details."
DEFAULTS = 
{
  queues: [],
  labels: [],
  concurrency: 10,
  require: ".",
  environment: nil,
  timeout: 25,
  poll_interval_average: nil,
  average_scheduled_poll_interval: 5,
  error_handlers: [],
  death_handlers: [],
  lifecycle_events: {
    startup: [],
    quiet: [],
    shutdown: [],
    heartbeat: [],
  },
  dead_max_jobs: 10_000,
  dead_timeout_in_seconds: 180 * 24 * 60 * 60, # 6 months
  reloader: proc { |&block| block.call },
}
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",
}
VERSION = 
"6.0.4"

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



222
223
224
 
# File 'lib/sidekiq.rb', line 222

def self.average_scheduled_poll_interval=(interval)
  options[:average_scheduled_poll_interval] = interval
end

.client_middleware {|@client_chain| ... } ⇒ Object

Yields:

  • (@client_chain) 


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

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



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

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



74
75
76
 
# File 'lib/sidekiq.rb', line 74

def self.configure_server
  yield self if server?
end

.death_handlers ⇒ Object

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.

Sidekiq.configure_server do |config|

config.death_handlers << ->(job, ex) do
end

end



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

def self.death_handlers
  options[:death_handlers]
end

.default_server_middleware ⇒ Object 



151
152
153
 
# File 'lib/sidekiq.rb', line 151

def self.default_server_middleware
  Middleware::Chain.new
end

.default_worker_options ⇒ Object 



160
161
162
 
# File 'lib/sidekiq.rb', line 160

def self.default_worker_options
  defined?(@default_worker_options) ? @default_worker_options : DEFAULT_WORKER_OPTIONS
end

.default_worker_options=(hash) ⇒ Object 



155
156
157
158
 
# File 'lib/sidekiq.rb', line 155

def self.default_worker_options=(hash)
  # stringify
  @default_worker_options = default_worker_options.merge(Hash[hash.map { |k, v| [k.to_s, v] }])
end

.dump_json(object) ⇒ Object 



181
182
183
 
# File 'lib/sidekiq.rb', line 181

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.



233
234
235
 
# File 'lib/sidekiq.rb', line 233

def self.error_handlers
  options[:error_handlers]
end

.load_json(string) ⇒ Object 



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

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

.log_formatter ⇒ Object 



185
186
187
188
189
190
191
 
# File 'lib/sidekiq.rb', line 185

def self.log_formatter
  @log_formatter ||= if ENV["DYNO"]
    Sidekiq::Logger::Formatters::WithoutTimestamp.new
  else
    Sidekiq::Logger::Formatters::Pretty.new
  end
end

.log_formatter=(log_formatter) ⇒ Object 



193
194
195
196
 
# File 'lib/sidekiq.rb', line 193

def self.log_formatter=(log_formatter)
  @log_formatter = log_formatter
  logger.formatter = log_formatter
end

.logger ⇒ Object 



198
199
200
 
# File 'lib/sidekiq.rb', line 198

def self.logger
  @logger ||= Sidekiq::Logger.new(STDOUT, level: Logger::INFO)
end

.logger=(logger) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/sidekiq.rb', line 202

def self.logger=(logger)
  if logger.nil?
    self.logger.level = Logger::FATAL
    return self.logger
  end

  logger.extend(Sidekiq::LoggingUtils)

  @logger = logger
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) 


245
246
247
248
249
 
# File 'lib/sidekiq.rb', line 245

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 



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

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

.options=(opts) ⇒ Object 



61
62
63
 
# File 'lib/sidekiq.rb', line 61

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

.pro? ⇒ Boolean

Returns:

  • (Boolean) 


213
214
215
 
# File 'lib/sidekiq.rb', line 213

def self.pro?
  defined?(Sidekiq::Pro)
end

.redis ⇒ Object

Raises:

  • (ArgumentError) 


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/sidekiq.rb', line 92

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 replica, need
      # to disconnect and reopen the socket to get back to the primary.
      if retryable && ex.message =~ /READONLY/
        conn.disconnect!
        retryable = false
        retry
      end
      raise
    end
  end
end

.redis=(hash) ⇒ Object 



131
132
133
134
135
136
137
 
# File 'lib/sidekiq.rb', line 131

def self.redis=(hash)
  @redis = if hash.is_a?(ConnectionPool)
    hash
  else
    Sidekiq::RedisConnection.create(hash)
  end
end

.redis_info ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/sidekiq.rb', line 111

def self.redis_info
  redis do |conn|
    # 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 /unknown command/.match?(ex.message)
    FAKE_INFO
  end
end

.redis_pool ⇒ Object 



127
128
129
 
# File 'lib/sidekiq.rb', line 127

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

.server? ⇒ Boolean

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/sidekiq.rb', line 88

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

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

Yields:

  • (@server_chain) 


145
146
147
148
149
 
# File 'lib/sidekiq.rb', line 145

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

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



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

def self.❨╯°□°❩╯︵┻━┻
  puts "Calm down, yo."
end