class Sidekiq::CLI
Constants
- PROCTITLES
- SIGNAL_HANDLERS
Attributes
code[RW]
Used for CLI testing
environment[RW]
launcher[RW]
Public Class Methods
new()
click to toggle source
# File lib/sidekiq/cli.rb, line 30 def initialize @code = nil end
Public Instance Methods
handle_signal(sig)
click to toggle source
# File lib/sidekiq/cli.rb, line 168 def handle_signal(sig) Sidekiq.logger.debug "Got #{sig} signal" handy = SIGNAL_HANDLERS[sig] if handy handy.call(self) else Sidekiq.logger.info { "No signal handler for #{sig}" } end end
jruby?()
click to toggle source
# File lib/sidekiq/cli.rb, line 44 def jruby? defined?(::JRUBY_VERSION) end
parse(args=ARGV)
click to toggle source
# File lib/sidekiq/cli.rb, line 34 def parse(args=ARGV) @code = nil setup_options(args) initialize_logger validate! daemonize write_pid end
run()
click to toggle source
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.
# File lib/sidekiq/cli.rb, line 51 def run boot_system print_banner self_read, self_write = IO.pipe sigs = %w(INT TERM TTIN TSTP) # USR1 and USR2 don't work on the JVM if !jruby? sigs << 'USR1' sigs << 'USR2' end sigs.each do |sig| begin trap sig do self_write.write("#{sig}\n") end rescue ArgumentError puts "Signal #{sig} not supported" end end logger.info "Running in #{RUBY_DESCRIPTION}" logger.info Sidekiq::LICENSE logger.info "Upgrade to Sidekiq Pro for more features and support: http://sidekiq.org" unless defined?(::Sidekiq::Pro) # touch the connection pool so it is created before we # fire startup and start multithreading. ver = Sidekiq.redis_info['redis_version'] raise "You are using Redis v#{ver}, Sidekiq requires Redis v2.8.0 or greater" if ver < '2.8' # cache process identity Sidekiq.options[:identity] = identity # Touch middleware so it isn't lazy loaded by multiple threads, #3043 Sidekiq.server_middleware # 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(', ')}" } if !options[:daemon] logger.info 'Starting processing, hit Ctrl-C to stop' end require 'sidekiq/launcher' @launcher = Sidekiq::Launcher.new(options) begin launcher.run while readable_io = IO.select([self_read]) signal = readable_io.first[0].gets.strip handle_signal(signal) end rescue Interrupt logger.info 'Shutting down' launcher.stop # Explicitly exit so busy Processor threads can't block # process shutdown. logger.info "Bye!" exit(0) end end
Private Instance Methods
boot_system()
click to toggle source
# File lib/sidekiq/cli.rb, line 251 def boot_system ENV['RACK_ENV'] = ENV['RAILS_ENV'] = environment raise ArgumentError, "#{options[:require]} does not exist" unless File.exist?(options[:require]) if File.directory?(options[:require]) require 'rails' if ::Rails::VERSION::MAJOR < 4 raise "Sidekiq no longer supports this version of Rails" elsif ::Rails::VERSION::MAJOR == 4 # Painful contortions, see 1791 for discussion # No autoloading, we want to force eager load for everything. require File.expand_path("#{options[:require]}/config/application.rb") ::Rails::Application.initializer "sidekiq.eager_load" do ::Rails.application.config.eager_load = true end require 'sidekiq/rails' require File.expand_path("#{options[:require]}/config/environment.rb") else require 'sidekiq/rails' require File.expand_path("#{options[:require]}/config/environment.rb") end options[:tag] ||= default_tag else not_required_message = "#{options[:require]} was not required, you should use an explicit path: " + "./#{options[:require]} or /path/to/#{options[:require]}" require(options[:require]) || raise(ArgumentError, not_required_message) end end
daemonize()
click to toggle source
# File lib/sidekiq/cli.rb, line 189 def daemonize return unless options[:daemon] raise ArgumentError, "You really should set a logfile if you're going to daemonize" unless options[:logfile] files_to_reopen = [] ObjectSpace.each_object(File) do |file| files_to_reopen << file unless file.closed? end ::Process.daemon(true, true) files_to_reopen.each do |file| begin file.reopen file.path, "a+" file.sync = true rescue ::Exception end end [$stdout, $stderr].each do |io| File.open(options[:logfile], 'ab') do |f| io.reopen(f) end io.sync = true end $stdin.reopen('/dev/null') initialize_logger end
default_tag()
click to toggle source
# File lib/sidekiq/cli.rb, line 282 def default_tag dir = ::Rails.root name = File.basename(dir) if name.to_i != 0 && prevdir = File.dirname(dir) # Capistrano release directory? if File.basename(prevdir) == 'releases' return File.basename(File.dirname(prevdir)) end end name end
initialize_logger()
click to toggle source
# File lib/sidekiq/cli.rb, line 386 def initialize_logger Sidekiq::Logging.initialize_logger(options[:logfile]) if options[:logfile] Sidekiq.logger.level = ::Logger::DEBUG if options[:verbose] end
options()
click to toggle source
# File lib/sidekiq/cli.rb, line 247 def options Sidekiq.options end
parse_config(cfile)
click to toggle source
# File lib/sidekiq/cli.rb, line 401 def parse_config(cfile) opts = {} if File.exist?(cfile) opts = YAML.load(ERB.new(IO.read(cfile)).result) || opts if opts.respond_to? :deep_symbolize_keys! opts.deep_symbolize_keys! else symbolize_keys_deep!(opts) end opts = opts.merge(opts.delete(environment.to_sym) || {}) parse_queues(opts, opts.delete(:queues) || []) else # allow a non-existent config file so Sidekiq # can be deployed by cap with just the defaults. end ns = opts.delete(:namespace) if ns # logger hasn't been initialized yet, puts is all we have. puts("namespace should be set in your ruby initializer, is ignored in config file") puts("config.redis = { :url => ..., :namespace => '#{ns}' }") end opts end
parse_options(argv)
click to toggle source
# File lib/sidekiq/cli.rb, line 311 def parse_options(argv) opts = {} @parser = OptionParser.new do |o| o.on '-c', '--concurrency INT', "processor threads to use" do |arg| opts[:concurrency] = Integer(arg) end o.on '-d', '--daemon', "Daemonize process" do |arg| opts[:daemon] = arg end o.on '-e', '--environment ENV', "Application environment" do |arg| opts[:environment] = arg end o.on '-g', '--tag TAG', "Process tag for procline" do |arg| opts[:tag] = arg end # this index remains here for backwards compatibility but none of the Sidekiq # family use this value anymore. it was used by Pro's original reliable_fetch. o.on '-i', '--index INT', "unique process index on this machine" do |arg| opts[:index] = Integer(arg.match(/\d+/)[0]) end o.on "-q", "--queue QUEUE[,WEIGHT]", "Queues to process with optional weights" do |arg| queue, weight = arg.split(",") parse_queue opts, queue, weight end o.on '-r', '--require [PATH|DIR]', "Location of Rails application with workers or file to require" do |arg| opts[:require] = arg end o.on '-t', '--timeout NUM', "Shutdown timeout" do |arg| opts[:timeout] = Integer(arg) end o.on "-v", "--verbose", "Print more verbose output" do |arg| opts[:verbose] = arg end o.on '-C', '--config PATH', "path to YAML config file" do |arg| opts[:config_file] = arg end o.on '-L', '--logfile PATH', "path to writable logfile" do |arg| opts[:logfile] = arg end o.on '-P', '--pidfile PATH', "path to pidfile" do |arg| opts[:pidfile] = arg end o.on '-V', '--version', "Print version and exit" do |arg| puts "Sidekiq #{Sidekiq::VERSION}" die(0) end end @parser.banner = "sidekiq [options]" @parser.on_tail "-h", "--help", "Show help" do logger.info @parser die 1 end @parser.parse!(argv) %w[config/sidekiq.yml config/sidekiq.yml.erb].each do |filename| opts[:config_file] ||= filename if File.exist?(filename) end opts end
parse_queue(opts, q, weight=nil)
click to toggle source
# File lib/sidekiq/cli.rb, line 431 def parse_queue(opts, q, weight=nil) [weight.to_i, 1].max.times do (opts[:queues] ||= []) << q end opts[:strict] = false if weight.to_i > 0 end
parse_queues(opts, queues_and_weights)
click to toggle source
# File lib/sidekiq/cli.rb, line 427 def parse_queues(opts, queues_and_weights) queues_and_weights.each { |queue_and_weight| parse_queue(opts, *queue_and_weight) } end
set_environment(cli_env)
click to toggle source
# File lib/sidekiq/cli.rb, line 219 def set_environment(cli_env) @environment = cli_env || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development' end
setup_options(args)
click to toggle source
# File lib/sidekiq/cli.rb, line 234 def setup_options(args) opts = parse_options(args) set_environment opts[:environment] cfile = opts[:config_file] opts = parse_config(cfile).merge(opts) if cfile opts[:strict] = true if opts[:strict].nil? opts[:concurrency] = Integer(ENV["RAILS_MAX_THREADS"]) if !opts[:concurrency] && ENV["RAILS_MAX_THREADS"] options.merge!(opts) end
symbolize_keys_deep!(hash)
click to toggle source
# File lib/sidekiq/cli.rb, line 223 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].kind_of? Hash end end
validate!()
click to toggle source
# File lib/sidekiq/cli.rb, line 293 def validate! options[:queues] << 'default' if options[:queues].empty? if !File.exist?(options[:require]) || (File.directory?(options[:require]) && !File.exist?("#{options[:require]}/config/application.rb")) logger.info "==================================================================" logger.info " Please point sidekiq to a Rails 4/5 application or a Ruby file " logger.info " to load your worker classes with -r [DIR|FILE]." logger.info "==================================================================" logger.info @parser die(1) end [:concurrency, :timeout].each do |opt| raise ArgumentError, "#{opt}: #{options[opt]} is not a valid value" if options.has_key?(opt) && options[opt].to_i <= 0 end end
write_pid()
click to toggle source
# File lib/sidekiq/cli.rb, line 392 def write_pid if path = options[:pidfile] pidfile = File.expand_path(path) File.open(pidfile, 'w') do |f| f.puts ::Process.pid end end end