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/sidekiq/middleware/server/retry_jobs.rb,
lib/sidekiq/middleware/server/active_record.rb

Defined Under Namespace

Modules: Actor, ExceptionHandler, Extensions, Logging, Middleware, Paginator, Scheduled, Util, WebHelpers, Worker Classes: BasicFetch, CLI, Client, DeadSet, EmptyQueueError, Fetcher, Job, JobSet, Launcher, Manager, 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 => [],
  :concurrency => 25,
  :require => '.',
  :environment => nil,
  :timeout => 8,
  :error_handlers => [],
  :lifecycle_events => {
    :startup => [],
    :quiet => [],
    :shutdown => [],
  },
}
%q{         s
 ss
   sss  sss         ss
   s  sss s   ssss sss   ____  _     _      _    _
   s     sssss ssss     / ___|(_) __| | ___| | _(_) __ _
  s         sss         \___ \| |/ _` |/ _ \ |/ / |/ _` |
  s sssss  s             ___) | | (_| |  __/   <| | (_| |
  ss    s  s            |____/|_|\__,_|\___|_|\_\_|\__, |
  s     s s                                           |_|
 s s
sss
sss }
VERSION = 
"3.0.0"

Class Method Summary collapse

Class Method Details

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

Yields:

  • (@client_chain) 


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

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



59
60
61
 
# File 'lib/sidekiq.rb', line 59

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



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

def self.configure_server
  yield self if server?
end

.default_worker_options ⇒ Object 



100
101
102
 
# File 'lib/sidekiq.rb', line 100

def self.default_worker_options
  defined?(@default_worker_options) ? @default_worker_options : { 'retry' => true, 'queue' => 'default' }
end

.default_worker_options=(hash) ⇒ Object 



96
97
98
 
# File 'lib/sidekiq.rb', line 96

def self.default_worker_options=(hash)
  @default_worker_options = default_worker_options.merge(hash)
end

.dump_json(object) ⇒ Object 



108
109
110
 
# File 'lib/sidekiq.rb', line 108

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.



131
132
133
 
# File 'lib/sidekiq.rb', line 131

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

.hook_rails! ⇒ Object 



2
3
4
5
6
7
8
9
10
 
# File 'lib/sidekiq/rails.rb', line 2

def self.hook_rails!
  if defined?(::ActiveRecord)
    ::ActiveRecord::Base.__send__(:include, Sidekiq::Extensions::ActiveRecord)
  end

  if defined?(::ActionMailer)
    ::ActionMailer::Base.extend(Sidekiq::Extensions::ActionMailer)
  end
end

.load_json(string) ⇒ Object 



104
105
106
 
# File 'lib/sidekiq.rb', line 104

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

.logger ⇒ Object 



112
113
114
 
# File 'lib/sidekiq.rb', line 112

def self.logger
  Sidekiq::Logging.logger
end

.logger=(log) ⇒ Object 



116
117
118
 
# File 'lib/sidekiq.rb', line 116

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) 


143
144
145
146
147
 
# File 'lib/sidekiq.rb', line 143

def self.on(event, &block)
  raise ArgumentError, "Symbols only please: #{event}" if !event.is_a?(Symbol)
  raise ArgumentError, "Invalid event name: #{event}" if !options[:lifecycle_events].keys.include?(event)
  options[:lifecycle_events][event] << block
end

.options ⇒ Object 



32
33
34
 
# File 'lib/sidekiq.rb', line 32

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

.options=(opts) ⇒ Object 



36
37
38
 
# File 'lib/sidekiq.rb', line 36

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

.poll_interval=(interval) ⇒ Object 



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

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

.redis(&block) ⇒ Object

Raises:

  • (ArgumentError) 


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

def self.redis(&block)
  raise ArgumentError, "requires a block" if !block
  redis_pool.with(&block)
end

.redis=(hash) ⇒ Object 



76
77
78
79
80
81
82
 
# File 'lib/sidekiq.rb', line 76

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

.redis_pool ⇒ Object 



72
73
74
 
# File 'lib/sidekiq.rb', line 72

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

.server? ⇒ Boolean

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/sidekiq.rb', line 63

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

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

Yields:

  • (@server_chain) 


90
91
92
93
94
 
# File 'lib/sidekiq.rb', line 90

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

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



28
29
30
 
# File 'lib/sidekiq.rb', line 28

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