class Sidekiq::RedisConnection
Public Class Methods
create(options={})
click to toggle source
# File lib/sidekiq/redis_connection.rb, line 10 def create(options={}) options[:url] ||= determine_redis_provider size = options[:size] || (Sidekiq.server? ? (Sidekiq.options[:concurrency] + 5) : 5) verify_sizing(size, Sidekiq.options[:concurrency]) if Sidekiq.server? pool_timeout = options[:pool_timeout] || 1 log_info(options) ConnectionPool.new(:timeout => pool_timeout, :size => size) do build_client(options) end end
Private Class Methods
build_client(options)
click to toggle source
# File lib/sidekiq/redis_connection.rb, line 39 def build_client(options) namespace = options[:namespace] client = Redis.new client_opts(options) if namespace begin require 'redis/namespace' Redis::Namespace.new(namespace, :redis => client) rescue LoadError Sidekiq.logger.error("Your Redis configuration use the namespace '#{namespace}' but the redis-namespace gem not included in Gemfile." "Add the gem to your Gemfile in case you would like to keep using a namespace, otherwise remove the namespace parameter.") exit(-127) end else client end end
client_opts(options)
click to toggle source
# File lib/sidekiq/redis_connection.rb, line 57 def client_opts(options) opts = options.dup if opts[:namespace] opts.delete(:namespace) end if opts[:network_timeout] opts[:timeout] = opts[:network_timeout] opts.delete(:network_timeout) end opts[:driver] = opts[:driver] || 'ruby' opts end
determine_redis_provider()
click to toggle source
# File lib/sidekiq/redis_connection.rb, line 91 def determine_redis_provider ENV[ENV['REDIS_PROVIDER'] || 'REDIS_URL'] end
log_info(options)
click to toggle source
# File lib/sidekiq/redis_connection.rb, line 73 def log_info(options) # Don't log Redis AUTH password redacted = "REDACTED" scrubbed_options = options.dup if scrubbed_options[:url] && (uri = URI.parse(scrubbed_options[:url])) && uri.password uri.password = redacted scrubbed_options[:url] = uri.to_s end if scrubbed_options[:password] scrubbed_options[:password] = redacted end if Sidekiq.server? Sidekiq.logger.info("Booting Sidekiq #{Sidekiq::VERSION} with redis options #{scrubbed_options}") else Sidekiq.logger.debug("#{Sidekiq::NAME} client with redis options #{scrubbed_options}") end end
verify_sizing(size, concurrency)
click to toggle source
Sidekiq needs a lot of concurrent Redis connections.
We need a connection for each Processor. We need a connection for Pro's real-time change listener We need a connection to various features to call Redis every few seconds:
- the process heartbeat. - enterprise's leader election - enterprise's cron support
# File lib/sidekiq/redis_connection.rb, line 35 def verify_sizing(size, concurrency) raise ArgumentError, "Your Redis connection pool is too small for Sidekiq to work, your pool has #{size} connections but really needs to have at least #{concurrency + 2}" if size <= concurrency end