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/worker.rb,
lib/sidekiq/logging.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,
lib/sidekiq/middleware/server/active_record.rb
Defined Under Namespace
Modules: ExceptionHandler, Extensions, Generators, Logging, Middleware, Paginator, Queues, Scheduled, Util, WebHelpers, WebRouter, Worker
Classes: BasicFetch, CLI, Client, DeadSet, EmptyQueueError, Job, JobLogger, JobRetry, JobSet, Launcher, Manager, Process, ProcessSet, Processor, Queue, Rails, RedisConnection, RetrySet, ScheduledSet, Shutdown, SortedEntry, SortedSet, Stats, Testing, Web, WebAction, WebApplication, WebRoute, Workers
Constant Summary
collapse
- NAME =
'Sidekiq'.freeze
- 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: [],
heartbeat: [],
},
dead_max_jobs: 10_000,
dead_timeout_in_seconds: 180 * 24 * 60 * 60, 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"
}.freeze
- VERSION =
"5.0.5"
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
190
191
192
|
# File 'lib/sidekiq.rb', line 190
def self.average_scheduled_poll_interval=(interval)
self.options[:average_scheduled_poll_interval] = interval
end
|
.client_middleware {|@client_chain| ... } ⇒ Object
135
136
137
138
139
|
# File 'lib/sidekiq.rb', line 135
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
82
83
84
|
# File 'lib/sidekiq.rb', line 82
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
72
73
74
|
# File 'lib/sidekiq.rb', line 72
def self.configure_server
yield self if server?
end
|
.default_retries_exhausted ⇒ Object
167
168
169
|
# File 'lib/sidekiq.rb', line 167
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
163
164
165
|
# File 'lib/sidekiq.rb', line 163
def self.default_retries_exhausted=(prok)
@default_retries_exhausted = prok
end
|
.default_server_middleware ⇒ Object
147
148
149
|
# File 'lib/sidekiq.rb', line 147
def self.default_server_middleware
Middleware::Chain.new
end
|
.default_worker_options ⇒ Object
155
156
157
|
# File 'lib/sidekiq.rb', line 155
def self.default_worker_options
defined?(@default_worker_options) ? @default_worker_options : DEFAULT_WORKER_OPTIONS
end
|
.default_worker_options=(hash) ⇒ Object
151
152
153
154
|
# File 'lib/sidekiq.rb', line 151
def self.default_worker_options=(hash)
@default_worker_options = default_worker_options.merge(Hash[hash.map{|k, v| [k.to_s, v]}])
end
|
.dump_json(object) ⇒ Object
174
175
176
|
# File 'lib/sidekiq.rb', line 174
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.
201
202
203
|
# File 'lib/sidekiq.rb', line 201
def self.error_handlers
self.options[:error_handlers]
end
|
.load_json(string) ⇒ Object
171
172
173
|
# File 'lib/sidekiq.rb', line 171
def self.load_json(string)
JSON.parse(string)
end
|
.logger=(log) ⇒ Object
181
182
183
|
# File 'lib/sidekiq.rb', line 181
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
213
214
215
216
217
|
# File 'lib/sidekiq.rb', line 213
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
56
57
58
|
# File 'lib/sidekiq.rb', line 56
def self.options
@options ||= DEFAULTS.dup
end
|
.options=(opts) ⇒ Object
59
60
61
|
# File 'lib/sidekiq.rb', line 59
def self.options=(opts)
@options = opts
end
|
.redis ⇒ Object
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
# File 'lib/sidekiq.rb', line 90
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
(conn.disconnect!; retryable = false; retry) if retryable && ex.message =~ /READONLY/
raise
end
end
end
|
.redis=(hash) ⇒ Object
127
128
129
130
131
132
133
|
# File 'lib/sidekiq.rb', line 127
def self.redis=(hash)
@redis = if hash.is_a?(ConnectionPool)
hash
else
Sidekiq::RedisConnection.create(hash)
end
end
|
.redis_info ⇒ Object
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
# File 'lib/sidekiq.rb', line 105
def self.redis_info
redis do |conn|
begin
if conn.respond_to?(:namespace)
conn.redis.info
else
conn.info
end
rescue Redis::CommandError => ex
raise unless ex.message =~ /unknown command/
FAKE_INFO
end
end
end
|
.server? ⇒ Boolean
86
87
88
|
# File 'lib/sidekiq.rb', line 86
def self.server?
defined?(Sidekiq::CLI)
end
|
.server_middleware {|@server_chain| ... } ⇒ Object
141
142
143
144
145
|
# File 'lib/sidekiq.rb', line 141
def self.server_middleware
@server_chain ||= default_server_middleware
yield @server_chain if block_given?
@server_chain
end
|
.❨╯°□°❩╯︵┻━┻ ⇒ Object
52
53
54
|
# File 'lib/sidekiq.rb', line 52
def self.❨╯°□°❩╯︵┻━┻
puts "Calm down, yo."
end
|