Class: Sidekiq::CLI
- Inherits:
-
Object
- Object
- Sidekiq::CLI
- Includes:
- Util, Singleton
- Defined in:
- lib/sidekiq/cli.rb
Constant Summary collapse
- PROCTITLES =
[ proc { 'sidekiq'.freeze }, proc { Sidekiq::VERSION }, proc { |me, data| data['tag'] }, proc { |me, data| "[#{Processor::WORKER_STATE.size} of #{data['concurrency']} busy]" }, proc { |me, data| "stopping" if me.stopping? }, ]
Constants included from Util
Instance Attribute Summary collapse
-
#code ⇒ Object
Used for CLI testing.
-
#environment ⇒ Object
Returns the value of attribute environment.
-
#launcher ⇒ Object
Returns the value of attribute launcher.
Class Method Summary collapse
Instance Method Summary collapse
- #handle_signal(sig) ⇒ Object
-
#initialize ⇒ CLI
constructor
A new instance of CLI.
- #jruby? ⇒ Boolean
- #parse(args = ARGV) ⇒ Object
-
#run ⇒ Object
Code within this method is not tested because it alters global process state irreversibly.
Methods included from Util
#fire_event, #hostname, #identity, #logger, #process_nonce, #redis, #safe_thread, #watchdog
Methods included from ExceptionHandler
Constructor Details
#initialize ⇒ CLI
Returns a new instance of CLI.
32 33 34 |
# File 'lib/sidekiq/cli.rb', line 32 def initialize @code = nil end |
Instance Attribute Details
#code ⇒ Object
Used for CLI testing
28 29 30 |
# File 'lib/sidekiq/cli.rb', line 28 def code @code end |
#environment ⇒ Object
Returns the value of attribute environment.
30 31 32 |
# File 'lib/sidekiq/cli.rb', line 30 def environment @environment end |
#launcher ⇒ Object
Returns the value of attribute launcher.
29 30 31 |
# File 'lib/sidekiq/cli.rb', line 29 def launcher @launcher end |
Class Method Details
.banner ⇒ Object
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'lib/sidekiq/cli.rb', line 121 def self. %q{ m, `$b .ss, $$: .,d$ `$$P,d$P' .,md$P"' ,$$$$$bmmd$$$P^' .d$$$$$$$$$$P' $$^' `"^$$$' ____ _ _ _ _ $: ,$$: / ___|(_) __| | ___| | _(_) __ _ `b :$$ \___ \| |/ _` |/ _ \ |/ / |/ _` | $$: ___) | | (_| | __/ <| | (_| | $$ |____/|_|\__,_|\___|_|\_\_|\__, | .d$$ |_| } end |
Instance Method Details
#handle_signal(sig) ⇒ Object
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'lib/sidekiq/cli.rb', line 138 def handle_signal(sig) Sidekiq.logger.debug "Got #{sig} signal" case sig when 'INT' # Handle Ctrl-C in JRuby like MRI # http://jira.codehaus.org/browse/JRUBY-4637 raise Interrupt when 'TERM' # Heroku sends TERM and then waits 10 seconds for process to exit. raise Interrupt when 'USR1' Sidekiq.logger.info "Received USR1, no longer accepting new work" launcher.quiet when 'TSTP' # USR1 is not available on JVM, allow TSTP as an alternate signal Sidekiq.logger.info "Received TSTP, no longer accepting new work" launcher.quiet when 'USR2' if Sidekiq.[:logfile] Sidekiq.logger.info "Received USR2, reopening log file" Sidekiq::Logging.reopen_logs end when 'TTIN' Thread.list.each do |thread| Sidekiq.logger.warn "Thread TID-#{thread.object_id.to_s(36)} #{thread['sidekiq_label']}" if thread.backtrace Sidekiq.logger.warn thread.backtrace.join("\n") else Sidekiq.logger.warn "<no backtrace available>" end end end end |
#jruby? ⇒ Boolean
46 47 48 |
# File 'lib/sidekiq/cli.rb', line 46 def jruby? defined?(::JRUBY_VERSION) end |
#parse(args = ARGV) ⇒ Object
36 37 38 39 40 41 42 43 44 |
# File 'lib/sidekiq/cli.rb', line 36 def parse(args=ARGV) @code = nil (args) initialize_logger validate! daemonize write_pid end |
#run ⇒ Object
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.
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/sidekiq/cli.rb', line 53 def run boot_system 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.puts(sig) 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.[: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) logger.debug { "Client Middleware: #{Sidekiq.client_middleware.map(&:klass).join(', ')}" } logger.debug { "Server Middleware: #{Sidekiq.server_middleware.map(&:klass).join(', ')}" } if ![:daemon] logger.info 'Starting processing, hit Ctrl-C to stop' end require 'sidekiq/launcher' @launcher = Sidekiq::Launcher.new() 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 |