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/actor.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: Actor, ExceptionHandler, Extensions, Generators, Logging, Middleware, Paginator, Scheduled, Util, WebHelpers, Worker
Classes: BasicFetch, CLI, Client, DeadSet, EmptyQueueError, Fetcher, 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,
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 =
"3.3.4"
Class Method Summary
collapse
Class Method Details
.client_middleware {|@client_chain| ... } ⇒ Object
94
95
96
97
98
|
# File 'lib/sidekiq.rb', line 94
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
69
70
71
|
# File 'lib/sidekiq.rb', line 69
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
59
60
61
|
# File 'lib/sidekiq.rb', line 59
def self.configure_server
yield self if server?
end
|
.default_worker_options ⇒ Object
110
111
112
|
# File 'lib/sidekiq.rb', line 110
def self.default_worker_options
defined?(@default_worker_options) ? @default_worker_options : DEFAULT_WORKER_OPTIONS
end
|
.default_worker_options=(hash) ⇒ Object
106
107
108
|
# File 'lib/sidekiq.rb', line 106
def self.default_worker_options=(hash)
@default_worker_options = default_worker_options.merge(hash.stringify_keys)
end
|
.dump_json(object) ⇒ Object
118
119
120
|
# File 'lib/sidekiq.rb', line 118
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.new {|ex,ctx_hash| MyErrorService.notify(ex, ctx_hash) }
end
The default error handler logs errors to Sidekiq.logger.
142
143
144
|
# File 'lib/sidekiq.rb', line 142
def self.error_handlers
self.options[:error_handlers]
end
|
.load_json(string) ⇒ Object
114
115
116
|
# File 'lib/sidekiq.rb', line 114
def self.load_json(string)
JSON.parse(string)
end
|
.logger=(log) ⇒ Object
126
127
128
|
# File 'lib/sidekiq.rb', line 126
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
154
155
156
157
158
|
# File 'lib/sidekiq.rb', line 154
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
42
43
44
|
# File 'lib/sidekiq.rb', line 42
def self.options
@options ||= DEFAULTS.dup
end
|
.options=(opts) ⇒ Object
46
47
48
|
# File 'lib/sidekiq.rb', line 46
def self.options=(opts)
@options = opts
end
|
.poll_interval=(interval) ⇒ Object
See sidekiq/scheduled.rb for an in-depth explanation of this value
131
132
133
|
# File 'lib/sidekiq.rb', line 131
def self.poll_interval=(interval)
self.options[:poll_interval] = interval
end
|
.redis(&block) ⇒ Object
77
78
79
80
|
# File 'lib/sidekiq.rb', line 77
def self.redis(&block)
raise ArgumentError, "requires a block" unless block
redis_pool.with(&block)
end
|
.redis=(hash) ⇒ Object
86
87
88
89
90
91
92
|
# File 'lib/sidekiq.rb', line 86
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
73
74
75
|
# File 'lib/sidekiq.rb', line 73
def self.server?
defined?(Sidekiq::CLI)
end
|
.server_middleware {|@server_chain| ... } ⇒ Object
100
101
102
103
104
|
# File 'lib/sidekiq.rb', line 100
def self.server_middleware
@server_chain ||= Processor.default_middleware
yield @server_chain if block_given?
@server_chain
end
|
.❨╯°□°❩╯︵┻━┻ ⇒ Object
38
39
40
|
# File 'lib/sidekiq.rb', line 38
def self.❨╯°□°❩╯︵┻━┻
puts "Calm down, bro"
end
|