mirror of
https://github.com/mperham/sidekiq.git
synced 2022-11-09 13:52:34 -05:00
remove this junk
This commit is contained in:
Mike Perham
parent
918994d14a
commit
e52582e3ca
1 changed files with 0 additions and 257 deletions
257
config.rb
257
config.rb
|
|
@ -1,257 +0,0 @@
|
|||
require "forwardable"
|
||||
|
||||
require "sidekiq/redis_connection"
|
||||
|
||||
module Sidekiq
|
||||
# Sidekiq::Config represents the configuration for an instance of Sidekiq.
|
||||
class Config
|
||||
extend Forwardable
|
||||
|
||||
DEFAULTS = {
|
||||
queues: ["default"],
|
||||
labels: [],
|
||||
concurrency: 10,
|
||||
require: ".",
|
||||
strict: true,
|
||||
environment: nil,
|
||||
timeout: 25,
|
||||
poll_interval_average: nil,
|
||||
average_scheduled_poll_interval: 5,
|
||||
on_complex_arguments: :raise,
|
||||
error_handlers: [],
|
||||
death_handlers: [],
|
||||
lifecycle_events: {
|
||||
startup: [],
|
||||
quiet: [],
|
||||
shutdown: [],
|
||||
heartbeat: []
|
||||
},
|
||||
dead_max_jobs: 10_000,
|
||||
dead_timeout_in_seconds: 180 * 24 * 60 * 60, # 6 months
|
||||
reloader: proc { |&block| block.call }
|
||||
}
|
||||
|
||||
ERROR_HANDLER = ->(ex, ctx, cfg = Sidekiq.config) {
|
||||
l = cfg.logger
|
||||
l.warn(Sidekiq.dump_json(ctx)) unless ctx.empty?
|
||||
l.warn("#{ex.class.name}: #{ex.message}")
|
||||
l.warn(ex.backtrace.join("\n")) unless ex.backtrace.nil?
|
||||
}
|
||||
|
||||
def initialize(options = {})
|
||||
@options = DEFAULTS.merge(options)
|
||||
@options[:error_handlers] << ERROR_HANDLER if @options[:error_handlers].empty?
|
||||
@directory = {}
|
||||
end
|
||||
|
||||
def_delegators :@options, :[], :[]=, :fetch, :key?, :has_key?, :merge!
|
||||
attr_reader :options
|
||||
|
||||
# config.concurrency = 5
|
||||
def concurrency=(val)
|
||||
self[:concurrency] = Integer(val)
|
||||
end
|
||||
|
||||
# config.queues = %w( high default low ) # strict
|
||||
# config.queues = %w( high,3 default,2 low,1 ) # weighted
|
||||
# config.queues = %w( feature1,1 feature2,1 feature3,1 ) # random
|
||||
#
|
||||
# With weighted priority, queue will be checked first (weight / total) of the time.
|
||||
# high will be checked first (3/6) or 50% of the time.
|
||||
# I'd recommend setting weights between 1-10. Weights in the hundreds or thousands
|
||||
# are ridiculous and unnecessarily expensive. You can get random queue ordering
|
||||
# by explicitly setting all weights to 1.
|
||||
def queues=(val)
|
||||
self[:queues] = Array(val).each_with_object([]) do |qstr, memo|
|
||||
name, weight = qstr.split(",")
|
||||
self[:strict] = false if weight.to_i > 0
|
||||
[weight.to_i, 1].max.times do
|
||||
memo << name
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def redis
|
||||
raise ArgumentError, "requires a block" unless block_given?
|
||||
redis_pool.with do |conn|
|
||||
retryable = true
|
||||
begin
|
||||
yield conn
|
||||
rescue RedisClientAdapter::BaseError => ex
|
||||
# 2550 Failover can cause the server to become a replica, need
|
||||
# to disconnect and reopen the socket to get back to the primary.
|
||||
# 4495 Use the same logic if we have a "Not enough replicas" error from the primary
|
||||
# 4985 Use the same logic when a blocking command is force-unblocked
|
||||
# The same retry logic is also used in client.rb
|
||||
if retryable && ex.message =~ /READONLY|NOREPLICAS|UNBLOCKED/
|
||||
conn.close
|
||||
retryable = false
|
||||
retry
|
||||
end
|
||||
raise
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def register(name, instance)
|
||||
@directory[name] = instance
|
||||
end
|
||||
|
||||
def lookup(name)
|
||||
# JNDI is just a fancy name for a hash lookup
|
||||
@directory[name]
|
||||
end
|
||||
|
||||
def redis_info
|
||||
redis do |conn|
|
||||
conn.info
|
||||
rescue RedisClientAdapter::CommandError => ex
|
||||
# 2850 return fake version when INFO command has (probably) been renamed
|
||||
raise unless /unknown command/.match?(ex.message)
|
||||
{
|
||||
"redis_version" => "9.9.9",
|
||||
"uptime_in_days" => "9999",
|
||||
"connected_clients" => "9999",
|
||||
"used_memory_human" => "9P",
|
||||
"used_memory_peak_human" => "9P"
|
||||
}.freeze
|
||||
end
|
||||
end
|
||||
|
||||
def redis_pool
|
||||
# connection pool is lazy, it will not create connections unless you actually need them
|
||||
# so don't be skimpy!
|
||||
@redis ||= RedisConnection.create(size: required_pool_size, logger: logger)
|
||||
end
|
||||
|
||||
def redis=(hash)
|
||||
pool = if hash.is_a?(ConnectionPool)
|
||||
hash
|
||||
else
|
||||
RedisConnection.create(hash.merge(size: required_pool_size, logger: logger))
|
||||
end
|
||||
raise ArgumentError, "Your Redis connection pool is too small for Sidekiq. Your pool has #{pool.size} connections but must have at least #{required_pool_size}" if pool.size < required_pool_size
|
||||
@redis = pool
|
||||
end
|
||||
|
||||
# Sidekiq needs many 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
|
||||
def required_pool_size
|
||||
if Sidekiq.server?
|
||||
self[:concurrency] + 3
|
||||
elsif ENV["RAILS_MAX_THREADS"]
|
||||
Integer(ENV["RAILS_MAX_THREADS"])
|
||||
else
|
||||
5
|
||||
end
|
||||
end
|
||||
|
||||
def client_middleware
|
||||
@client_chain ||= Middleware::Chain.new
|
||||
yield @client_chain if block_given?
|
||||
@client_chain
|
||||
end
|
||||
|
||||
def server_middleware
|
||||
@server_chain ||= Middleware::Chain.new
|
||||
yield @server_chain if block_given?
|
||||
@server_chain
|
||||
end
|
||||
|
||||
##
|
||||
# Death handlers are called when all retries for a job have been exhausted and
|
||||
# the job dies. It's the notification to your application
|
||||
# that this job will not succeed without manual intervention.
|
||||
#
|
||||
# Sidekiq.configure_server do |config|
|
||||
# config.death_handlers << ->(job, ex) do
|
||||
# end
|
||||
# end
|
||||
def death_handlers
|
||||
@options[:death_handlers]
|
||||
end
|
||||
|
||||
# deprecated
|
||||
def log_formatter
|
||||
warn "config.log_formatter is deprecated, use `config.logger.formatter"
|
||||
logger.formatter
|
||||
end
|
||||
|
||||
def log_formatter=(log_formatter)
|
||||
warn "`config.log_formatter=` is deprecated, use `config.logger.formatter=`"
|
||||
logger.formatter = log_formatter
|
||||
end
|
||||
|
||||
def logger
|
||||
@logger ||= Sidekiq::Logger.new($stdout, level: :info).tap do |log|
|
||||
log.formatter = if ENV["DYNO"]
|
||||
Sidekiq::Logger::Formatters::WithoutTimestamp.new
|
||||
else
|
||||
Sidekiq::Logger::Formatters::Pretty.new
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def logger=(logger)
|
||||
if logger.nil?
|
||||
self.logger.level = Logger::FATAL
|
||||
return
|
||||
end
|
||||
|
||||
logger.extend(Sidekiq::LoggingUtils)
|
||||
@logger = logger
|
||||
end
|
||||
|
||||
# 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
|
||||
def average_scheduled_poll_interval=(interval)
|
||||
@options[:average_scheduled_poll_interval] = interval
|
||||
end
|
||||
|
||||
# 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 @logger.
|
||||
def error_handlers
|
||||
@options[:error_handlers]
|
||||
end
|
||||
|
||||
# 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
|
||||
def 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
|
||||
|
||||
# INTERNAL USE ONLY
|
||||
def handle_exception(ex, ctx = {})
|
||||
@options[:error_handlers].each do |handler|
|
||||
handler.call(ex, ctx, self)
|
||||
rescue => e
|
||||
l = logger
|
||||
l.error "!!! ERROR HANDLER THREW AN ERROR !!!"
|
||||
l.error e
|
||||
l.error e.backtrace.join("\n") unless e.backtrace.nil?
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
Loading…
Add table
Reference in a new issue