1
0
Fork 0
mirror of https://github.com/mperham/sidekiq.git synced 2022-11-09 13:52:34 -05:00
mperham--sidekiq/lib/sidekiq/cli.rb

428 lines
13 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
2012-06-19 11:41:41 -04:00
$stdout.sync = true
require "yaml"
require "singleton"
require "optparse"
require "erb"
require "fileutils"
2012-03-31 15:45:24 -04:00
require "sidekiq"
require "sidekiq/launcher"
require "sidekiq/util"
2012-01-16 19:14:47 -05:00
module Sidekiq
class CLI
2012-01-22 19:01:46 -05:00
include Util
include Singleton unless $TESTING
2012-01-22 19:01:46 -05:00
attr_accessor :launcher
2013-01-18 23:57:26 -05:00
attr_accessor :environment
2022-02-26 11:33:19 -05:00
def parse(args = ARGV.dup)
2013-01-18 23:57:26 -05:00
setup_options(args)
2012-12-11 06:32:22 -05:00
initialize_logger
2012-01-16 23:02:58 -05:00
validate!
2012-01-16 19:14:47 -05:00
end
def jruby?
defined?(::JRUBY_VERSION)
end
# Code within this method is not tested because it alters
# global process state irreversibly. PRs which improve the
# test coverage of Sidekiq::CLI are welcomed.
2020-07-21 12:57:56 -04:00
def run(boot_app: true)
boot_application if boot_app
if environment == "development" && $stdout.tty? && Sidekiq.log_formatter.is_a?(Sidekiq::Logger::Formatters::Pretty)
print_banner
end
2019-11-17 20:50:01 -05:00
logger.info "Booted Rails #{::Rails.version} application in #{environment} environment" if rails_app?
self_read, self_write = IO.pipe
sigs = %w[INT TERM TTIN TSTP]
2019-10-11 16:30:30 -04:00
# USR1 and USR2 don't work on the JVM
2020-07-27 14:51:10 -04:00
sigs << "USR2" if Sidekiq.pro? && !jruby?
sigs.each do |sig|
old_handler = Signal.trap(sig) do
if old_handler.respond_to?(:call)
begin
old_handler.call
2021-09-13 12:33:57 -04:00
rescue Exception => exc
# signal handlers can't use Logger so puts only
puts ["Error in #{sig} handler", exc].inspect
end
end
2019-09-05 09:02:55 -04:00
self_write.puts(sig)
end
rescue ArgumentError
puts "Signal #{sig} not supported"
end
2012-09-03 14:34:07 -04:00
logger.info "Running in #{RUBY_DESCRIPTION}"
logger.info Sidekiq::LICENSE
logger.info "Upgrade to Sidekiq Pro for more features and support: https://sidekiq.org" unless defined?(::Sidekiq::Pro)
2012-09-03 14:34:07 -04:00
# touch the connection pool so it is created before we
# fire startup and start multithreading.
2020-12-02 12:27:14 -05:00
info = Sidekiq.redis_info
ver = info["redis_version"]
raise "You are connecting to Redis v#{ver}, Sidekiq requires Redis v4.0.0 or greater" if ver < "4"
2015-10-20 18:48:36 -04:00
2020-12-02 12:27:14 -05:00
maxmemory_policy = info["maxmemory_policy"]
if maxmemory_policy != "noeviction"
2020-12-02 12:27:14 -05:00
logger.warn <<~EOM
WARNING: Your Redis instance will evict Sidekiq data under heavy load.
The 'noeviction' maxmemory policy is recommended (current policy: '#{maxmemory_policy}').
See: https://github.com/mperham/sidekiq/wiki/Using-Redis#memory
EOM
end
# Since the user can pass us a connection pool explicitly in the initializer, we
# need to verify the size is large enough or else Sidekiq's performance is dramatically slowed.
cursize = Sidekiq.redis_pool.size
needed = Sidekiq.options[:concurrency] + 2
raise "Your pool of #{cursize} Redis connections is too small, please increase the size to at least #{needed}" if cursize < needed
# cache process identity
2017-06-05 14:29:22 -04:00
Sidekiq.options[:identity] = identity
# Touch middleware so it isn't lazy loaded by multiple threads, #3043
Sidekiq.server_middleware
2015-10-20 18:48:36 -04:00
# Before this point, the process is initializing with just the main thread.
# Starting here the process will now have multiple threads running.
fire_event(:startup, reverse: false, reraise: true)
logger.debug { "Client Middleware: #{Sidekiq.client_middleware.map(&:klass).join(", ")}" }
logger.debug { "Server Middleware: #{Sidekiq.server_middleware.map(&:klass).join(", ")}" }
launch(self_read)
end
def launch(self_read)
if environment == "development" && $stdout.tty?
logger.info "Starting processing, hit Ctrl-C to stop"
2013-01-29 14:19:36 -05:00
end
@launcher = Sidekiq::Launcher.new(options)
2012-01-16 19:14:47 -05:00
begin
launcher.run
while self_read.wait_readable
signal = self_read.gets.strip
handle_signal(signal)
end
2012-01-16 19:14:47 -05:00
rescue Interrupt
logger.info "Shutting down"
launcher.stop
2015-10-30 18:19:19 -04:00
logger.info "Bye!"
2019-08-28 12:59:28 -04:00
# Explicitly exit so busy Processor threads won't block process shutdown.
#
# NB: slow at_exit handlers will prevent a timely exit if they take
# a while to run. If Sidekiq is getting here but the process isn't exiting,
# use the TTIN signal to determine where things are stuck.
exit(0)
2012-01-16 19:14:47 -05:00
end
end
def self.w
"\e[37m"
end
def self.r
"\e[31m"
end
def self.b
"\e[30m"
end
def self.reset
"\e[0m"
end
2014-06-12 23:28:28 -04:00
def self.banner
%{
#{w} m,
#{w} `$b
#{w} .ss, $$: .,d$
#{w} `$$P,d$P' .,md$P"'
#{w} ,$$$$$b#{b}/#{w}md$$$P^'
#{w} .d$$$$$$#{b}/#{w}$$$P'
#{w} $$^' `"#{b}/#{w}$$$' #{r}____ _ _ _ _
#{w} $: ,$$: #{r} / ___|(_) __| | ___| | _(_) __ _
#{w} `b :$$ #{r} \\___ \\| |/ _` |/ _ \\ |/ / |/ _` |
#{w} $$: #{r} ___) | | (_| | __/ <| | (_| |
#{w} $$ #{r}|____/|_|\\__,_|\\___|_|\\_\\_|\\__, |
#{w} .d$$ #{r} |_|
#{reset}}
2014-06-12 23:28:28 -04:00
end
2018-01-29 15:20:08 -05:00
SIGNAL_HANDLERS = {
# Ctrl-C in terminal
"INT" => ->(cli) { raise Interrupt },
2018-01-29 15:20:08 -05:00
# TERM is the signal that Sidekiq must exit.
# Heroku sends TERM and then waits 30 seconds for process to exit.
"TERM" => ->(cli) { raise Interrupt },
"TSTP" => ->(cli) {
Sidekiq.logger.info "Received TSTP, no longer accepting new work"
2018-01-29 15:20:08 -05:00
cli.launcher.quiet
},
"TTIN" => ->(cli) {
Thread.list.each do |thread|
Sidekiq.logger.warn "Thread TID-#{(thread.object_id ^ ::Process.pid).to_s(36)} #{thread.name}"
if thread.backtrace
Sidekiq.logger.warn thread.backtrace.join("\n")
else
Sidekiq.logger.warn "<no backtrace available>"
end
end
2020-03-17 16:38:48 -04:00
}
2018-01-29 15:20:08 -05:00
}
2019-09-05 09:02:55 -04:00
UNHANDLED_SIGNAL_HANDLER = ->(cli) { Sidekiq.logger.info "No signal handler registered, ignoring" }
SIGNAL_HANDLERS.default = UNHANDLED_SIGNAL_HANDLER
2018-01-29 15:20:08 -05:00
def handle_signal(sig)
Sidekiq.logger.debug "Got #{sig} signal"
2019-09-05 09:02:55 -04:00
SIGNAL_HANDLERS[sig].call(self)
end
private
def print_banner
puts "\e[31m"
puts Sidekiq::CLI.banner
puts "\e[0m"
end
2013-01-18 23:57:26 -05:00
def set_environment(cli_env)
2020-01-13 19:56:53 -05:00
# See #984 for discussion.
# APP_ENV is now the preferred ENV term since it is not tech-specific.
# Both Sinatra 2.0+ and Sidekiq support this term.
# RAILS_ENV and RACK_ENV are there for legacy support.
@environment = cli_env || ENV["APP_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
2013-01-18 23:57:26 -05:00
end
def symbolize_keys_deep!(hash)
hash.keys.each do |k|
symkey = k.respond_to?(:to_sym) ? k.to_sym : k
hash[symkey] = hash.delete k
symbolize_keys_deep! hash[symkey] if hash[symkey].is_a? Hash
end
end
2014-11-12 11:19:45 -05:00
alias_method :die, :exit
alias_method :, :exit
2013-01-18 23:57:26 -05:00
def setup_options(args)
# parse CLI options
opts = parse_options(args)
set_environment opts[:environment]
2013-01-18 23:57:26 -05:00
# check config file presence
if opts[:config_file]
2019-09-05 09:02:55 -04:00
unless File.exist?(opts[:config_file])
raise ArgumentError, "No such file #{opts[:config_file]}"
end
else
config_dir = if File.directory?(opts[:require].to_s)
File.join(opts[:require], "config")
else
File.join(options[:require], "config")
end
%w[sidekiq.yml sidekiq.yml.erb].each do |config_file|
path = File.join(config_dir, config_file)
opts[:config_file] ||= path if File.exist?(path)
end
end
# parse config file options
opts = parse_config(opts[:config_file]).merge(opts) if opts[:config_file]
# set defaults
opts[:queues] = ["default"] if opts[:queues].nil?
opts[:concurrency] = Integer(ENV["RAILS_MAX_THREADS"]) if opts[:concurrency].nil? && ENV["RAILS_MAX_THREADS"]
2013-01-18 23:57:26 -05:00
# merge with defaults
options.merge!(opts)
2013-01-18 23:57:26 -05:00
end
def options
Sidekiq.options
end
2020-07-21 12:57:56 -04:00
def boot_application
ENV["RACK_ENV"] = ENV["RAILS_ENV"] = environment
if File.directory?(options[:require])
require "rails"
if ::Rails::VERSION::MAJOR < 5
raise "Sidekiq no longer supports this version of Rails"
else
require "sidekiq/rails"
require File.expand_path("#{options[:require]}/config/environment.rb")
2014-06-24 11:37:33 -04:00
end
options[:tag] ||= default_tag
else
require options[:require]
end
2012-01-16 23:02:58 -05:00
end
def default_tag
dir = ::Rails.root
name = File.basename(dir)
prevdir = File.dirname(dir) # Capistrano release directory?
if name.to_i != 0 && prevdir
if File.basename(prevdir) == "releases"
return File.basename(File.dirname(prevdir))
end
end
name
end
2012-01-16 23:02:58 -05:00
def validate!
if !File.exist?(options[:require]) ||
(File.directory?(options[:require]) && !File.exist?("#{options[:require]}/config/application.rb"))
logger.info "=================================================================="
2019-08-28 12:59:28 -04:00
logger.info " Please point Sidekiq to a Rails application or a Ruby file "
logger.info " to load your worker classes with -r [DIR|FILE]."
logger.info "=================================================================="
logger.info @parser
die(1)
end
2015-05-15 12:42:43 -04:00
[:concurrency, :timeout].each do |opt|
raise ArgumentError, "#{opt}: #{options[opt]} is not a valid value" if options.key?(opt) && options[opt].to_i <= 0
end
2012-01-16 23:02:58 -05:00
end
def parse_options(argv)
opts = {}
@parser = option_parser(opts)
@parser.parse!(argv)
opts
end
2012-01-16 19:14:47 -05:00
def option_parser(opts)
parser = OptionParser.new { |o|
o.on "-c", "--concurrency INT", "processor threads to use" do |arg|
2013-01-31 16:39:21 -05:00
opts[:concurrency] = Integer(arg)
2012-01-16 19:14:47 -05:00
end
o.on "-d", "--daemon", "Daemonize process" do |arg|
2019-08-28 12:59:28 -04:00
puts "ERROR: Daemonization mode was removed in Sidekiq 6.0, please use a proper process supervisor to start and manage your services"
2013-01-29 14:19:36 -05:00
end
o.on "-e", "--environment ENV", "Application environment" do |arg|
opts[:environment] = arg
2012-01-24 01:08:38 -05:00
end
o.on "-g", "--tag TAG", "Process tag for procline" do |arg|
opts[:tag] = arg
end
o.on "-q", "--queue QUEUE[,WEIGHT]", "Queues to process with optional weights" do |arg|
queue, weight = arg.split(",")
parse_queue opts, queue, weight
2012-01-16 19:14:47 -05:00
end
2012-02-15 13:56:36 -05:00
o.on "-r", "--require [PATH|DIR]", "Location of Rails application with workers or file to require" do |arg|
2013-01-31 16:39:21 -05:00
opts[:require] = arg
end
o.on "-t", "--timeout NUM", "Shutdown timeout" do |arg|
2013-01-31 16:39:21 -05:00
opts[:timeout] = Integer(arg)
end
o.on "-v", "--verbose", "Print more verbose output" do |arg|
opts[:verbose] = arg
2012-02-15 13:56:36 -05:00
end
o.on "-C", "--config PATH", "path to YAML config file" do |arg|
opts[:config_file] = arg
end
2012-03-30 11:57:30 -04:00
o.on "-L", "--logfile PATH", "path to writable logfile" do |arg|
2019-08-28 12:59:28 -04:00
puts "ERROR: Logfile redirection was removed in Sidekiq 6.0, Sidekiq will only log to STDOUT"
2012-12-11 06:32:22 -05:00
end
o.on "-P", "--pidfile PATH", "path to pidfile" do |arg|
2019-08-28 12:59:28 -04:00
puts "ERROR: PID file creation was removed in Sidekiq 6.0, please use a proper process supervisor to start and manage your services"
2013-01-31 16:39:21 -05:00
end
o.on "-V", "--version", "Print version and exit" do |arg|
2012-03-30 11:57:30 -04:00
puts "Sidekiq #{Sidekiq::VERSION}"
die(0)
end
}
2012-01-16 19:14:47 -05:00
parser.banner = "sidekiq [options]"
parser.on_tail "-h", "--help", "Show help" do
logger.info parser
die 1
2012-01-16 19:14:47 -05:00
end
parser
2012-01-16 19:14:47 -05:00
end
2012-12-11 06:32:22 -05:00
def initialize_logger
2014-02-24 23:47:44 -05:00
Sidekiq.logger.level = ::Logger::DEBUG if options[:verbose]
2012-12-11 06:32:22 -05:00
end
def parse_config(path)
erb = ERB.new(File.read(path))
erb.filename = File.expand_path(path)
opts = load_yaml(erb.result) || {}
if opts.respond_to? :deep_symbolize_keys!
opts.deep_symbolize_keys!
2013-01-18 23:57:26 -05:00
else
symbolize_keys_deep!(opts)
end
opts = opts.merge(opts.delete(environment.to_sym) || {})
2020-07-13 10:51:52 -04:00
opts.delete(:strict)
parse_queues(opts, opts.delete(:queues) || [])
opts
end
def load_yaml(src)
if Psych::VERSION > "4.0"
YAML.safe_load(src, permitted_classes: [Symbol], aliases: true)
else
YAML.load(src)
end
end
def parse_queues(opts, queues_and_weights)
queues_and_weights.each { |queue_and_weight| parse_queue(opts, *queue_and_weight) }
end
def parse_queue(opts, queue, weight = nil)
opts[:queues] ||= []
opts[:strict] = true if opts[:strict].nil?
raise ArgumentError, "queues: #{queue} cannot be defined twice" if opts[:queues].include?(queue)
[weight.to_i, 1].max.times { opts[:queues] << queue.to_s }
opts[:strict] = false if weight.to_i > 0
end
2019-11-17 20:50:01 -05:00
def rails_app?
2020-01-08 11:46:49 -05:00
defined?(::Rails) && ::Rails.respond_to?(:application)
2019-11-17 20:50:01 -05:00
end
2012-01-16 19:14:47 -05:00
end
end
require "sidekiq/systemd"