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 }
- DEFAULT_WORKER_OPTIONS =
{
'retry' => true,
'queue' => 'default'
}
- VERSION =
"4.1.0"
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
161
162
163
|
# File 'lib/sidekiq.rb', line 161
def self.average_scheduled_poll_interval=(interval)
self.options[:average_scheduled_poll_interval] = interval
end
|
.client_middleware {|@client_chain| ... } ⇒ Object
106
107
108
109
110
|
# File 'lib/sidekiq.rb', line 106
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
71
72
73
|
# File 'lib/sidekiq.rb', line 71
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
61
62
63
|
# File 'lib/sidekiq.rb', line 61
def self.configure_server
yield self if server?
end
|
.default_server_middleware ⇒ Object
.default_worker_options ⇒ Object
136
137
138
|
# File 'lib/sidekiq.rb', line 136
def self.default_worker_options
defined?(@default_worker_options) ? @default_worker_options : DEFAULT_WORKER_OPTIONS
end
|
.default_worker_options=(hash) ⇒ Object
132
133
134
|
# File 'lib/sidekiq.rb', line 132
def self.default_worker_options=(hash)
@default_worker_options = default_worker_options.merge(hash.stringify_keys)
end
|
.dump_json(object) ⇒ Object
144
145
146
|
# File 'lib/sidekiq.rb', line 144
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.
172
173
174
|
# File 'lib/sidekiq.rb', line 172
def self.error_handlers
self.options[:error_handlers]
end
|
.load_json(string) ⇒ Object
140
141
142
|
# File 'lib/sidekiq.rb', line 140
def self.load_json(string)
JSON.parse(string)
end
|
.logger=(log) ⇒ Object
152
153
154
|
# File 'lib/sidekiq.rb', line 152
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
184
185
186
187
188
|
# File 'lib/sidekiq.rb', line 184
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
44
45
46
|
# File 'lib/sidekiq.rb', line 44
def self.options
@options ||= DEFAULTS.dup
end
|
.options=(opts) ⇒ Object
48
49
50
|
# File 'lib/sidekiq.rb', line 48
def self.options=(opts)
@options = opts
end
|
.redis ⇒ Object
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
# File 'lib/sidekiq.rb', line 79
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
98
99
100
101
102
103
104
|
# File 'lib/sidekiq.rb', line 98
def self.redis=(hash)
@redis = if hash.is_a?(ConnectionPool)
hash
else
Sidekiq::RedisConnection.create(hash)
end
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.
19
20
21
22
23
24
25
26
27
28
29
30
31
|
# File 'lib/sidekiq/rails.rb', line 19
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
75
76
77
|
# File 'lib/sidekiq.rb', line 75
def self.server?
defined?(Sidekiq::CLI)
end
|
.server_middleware {|@server_chain| ... } ⇒ Object
112
113
114
115
116
|
# File 'lib/sidekiq.rb', line 112
def self.server_middleware
@server_chain ||= default_server_middleware
yield @server_chain if block_given?
@server_chain
end
|
.❨╯°□°❩╯︵┻━┻ ⇒ Object
40
41
42
|
# File 'lib/sidekiq.rb', line 40
def self.❨╯°□°❩╯︵┻━┻
puts "Calm down, yo."
end
|