Module: Sidekiq
- Defined in:
- lib/sidekiq.rb,
lib/sidekiq/cli.rb,
lib/sidekiq/web.rb,
lib/sidekiq/util.rb,
lib/sidekiq/fetch.rb,
lib/sidekiq/rails.rb,
lib/sidekiq/stats.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/paginator.rb,
lib/sidekiq/processor.rb,
lib/sidekiq/scheduled.rb,
lib/sidekiq/testing/inline.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/timeout.rb,
lib/sidekiq/middleware/server/retry_jobs.rb,
lib/sidekiq/middleware/server/active_record.rb
Defined Under Namespace
Modules: ExceptionHandler, Extensions, Logging, Middleware, Paginator, Scheduled, Util, Worker
Classes: CLI, Client, Fetcher, Manager, Processor, Rails, RedisConnection, SprocketsMiddleware, Web
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,
:enable_rails_extensions => true,
}
- VERSION =
"2.3.1"
Class Method Summary
collapse
Class Method Details
.client_middleware {|@client_chain| ... } ⇒ Object
80
81
82
83
84
|
# File 'lib/sidekiq.rb', line 80
def self.client_middleware
@client_chain ||= Client.default_middleware
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/mydb' }
end
56
57
58
|
# File 'lib/sidekiq.rb', line 56
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/mydb' }
config.server_middleware do |chain|
chain.add MyServerHook
end
end
46
47
48
|
# File 'lib/sidekiq.rb', line 46
def self.configure_server
yield self if server?
end
|
.dump_json(object) ⇒ Object
96
97
98
|
# File 'lib/sidekiq.rb', line 96
def self.dump_json(object)
MultiJson.encode(object)
end
|
.info ⇒ Object
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
# File 'lib/sidekiq/stats.rb', line 4
def info
results = {}
processed, failed, queues = Sidekiq.redis { |conn|
conn.multi do
conn.get('stat:processed')
conn.get('stat:failed')
conn.smembers('queues')
end
}
results[:queues_with_sizes] = Sidekiq.redis do |conn|
queues.inject({}) { |memo, q|
memo[q] = conn.llen("queue:#{q}")
memo
}.sort_by { |_, size| size }
end
results[:processed] = (processed || 0).to_i
results[:failed] = (failed || 0).to_i
results[:backlog] = results[:queues_with_sizes].
map {|_, size| size }.
inject(0) {|memo, val| memo + val }
results
end
|
.load_json(string) ⇒ Object
92
93
94
|
# File 'lib/sidekiq.rb', line 92
def self.load_json(string)
MultiJson.decode(string)
end
|
.logger=(log) ⇒ Object
104
105
106
|
# File 'lib/sidekiq.rb', line 104
def self.logger=(log)
Sidekiq::Logging.logger = log
end
|
.options ⇒ Object
29
30
31
|
# File 'lib/sidekiq.rb', line 29
def self.options
@options ||= DEFAULTS.dup
end
|
.options=(opts) ⇒ Object
33
34
35
|
# File 'lib/sidekiq.rb', line 33
def self.options=(opts)
@options = opts
end
|
.poll_interval=(interval) ⇒ Object
108
109
110
|
# File 'lib/sidekiq.rb', line 108
def self.poll_interval=(interval)
self.options[:poll_interval] = interval
end
|
.redis(&block) ⇒ Object
64
65
66
67
68
|
# File 'lib/sidekiq.rb', line 64
def self.redis(&block)
@redis ||= Sidekiq::RedisConnection.create
raise ArgumentError, "requires a block" if !block
@redis.with(&block)
end
|
.redis=(hash) ⇒ Object
70
71
72
73
74
75
76
77
78
|
# File 'lib/sidekiq.rb', line 70
def self.redis=(hash)
if hash.is_a?(Hash)
@redis = RedisConnection.create(hash)
elsif hash.is_a?(ConnectionPool)
@redis = hash
else
raise ArgumentError, "redis= requires a Hash or ConnectionPool"
end
end
|
.server? ⇒ Boolean
60
61
62
|
# File 'lib/sidekiq.rb', line 60
def self.server?
defined?(Sidekiq::CLI)
end
|
.server_middleware {|@server_chain| ... } ⇒ Object
86
87
88
89
90
|
# File 'lib/sidekiq.rb', line 86
def self.server_middleware
@server_chain ||= Processor.default_middleware
yield @server_chain if block_given?
@server_chain
end
|
.size(*queues) ⇒ Object
27
28
29
30
31
32
33
34
35
|
# File 'lib/sidekiq/stats.rb', line 27
def size(*queues)
return info[:backlog] if queues.empty?
Sidekiq.redis { |conn|
conn.multi {
queues.map { |q| conn.llen("queue:#{q}") }
}
}.inject(0) { |memo, count| memo += count }
end
|