Class: Sidekiq::CLI

Inherits:
Object
  • Object
show all
Includes:
Util, Singleton
Defined in:
lib/sidekiq/cli.rb

Constant Summary

Constants included from Util

Util::EXPIRY

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Util

#fire_event, #hostname, #identity, #logger, #process_nonce, #redis, #want_a_hertz_donut?, #watchdog

Methods included from ExceptionHandler

#handle_exception

Constructor Details

#initialize ⇒ CLI

Returns a new instance of CLI.



31
32
33
 
# File 'lib/sidekiq/cli.rb', line 31

def initialize
  @code = nil
end

Instance Attribute Details

#code ⇒ Object

Used for CLI testing



27
28
29
 
# File 'lib/sidekiq/cli.rb', line 27

def code
  @code
end

#environment ⇒ Object

Returns the value of attribute environment.



29
30
31
 
# File 'lib/sidekiq/cli.rb', line 29

def environment
  @environment
end

#launcher ⇒ Object

Returns the value of attribute launcher.



28
29
30
 
# File 'lib/sidekiq/cli.rb', line 28

def launcher
  @launcher
end

Class Method Details



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/sidekiq/cli.rb', line 104

def self.banner
%q{
     m,
     `$b
.ss,  $$b         .,d$
`$$P,d$P'    .,md$$P'  ____  _     _      _    _
 ,$$$$$$bmmd$$$^'     / ___|(_) __| | ___| | _(_) __ _
   ,d$$$$$$$$$$$P         \___ \| |/ _` |/ _ \ |/ / |/ _` |
   $s^' `"^$$$'            ___) | | (_| |  __/   <| | (_| |
   $:     ,$$P            |____/|_|\__,_|\___|_|\_\_|\__, |
   `b     :$$                                           |_|
      $$:
      $$
    .d$$
}
end

Instance Method Details

#handle_signal(sig) ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/sidekiq/cli.rb', line 121

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.manager.async.stop
    fire_event(:quiet, true)
  when 'USR2'
    if Sidekiq.options[: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['label']}"
      if thread.backtrace
        Sidekiq.logger.warn thread.backtrace.join("\n")
      else
        Sidekiq.logger.warn "<no backtrace available>"
      end
    end
  end
end

#parse(args = ARGV) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/sidekiq/cli.rb', line 35

def parse(args=ARGV)
  @code = nil

  setup_options(args)
  initialize_logger
  validate!
  daemonize
  write_pid
  load_celluloid
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.



49
50
51
52
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
 
# File 'lib/sidekiq/cli.rb', line 49

def run
  boot_system
  print_banner

  self_read, self_write = IO.pipe

  %w(INT TERM USR1 USR2 TTIN).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)

  fire_event(:startup)

  logger.debug {
    "Middleware: #{Sidekiq.server_middleware.map(&:klass).join(', ')}"
  }

  Sidekiq.redis do |conn|
    # touch the connection pool so it is created before we
    # launch the actors.
  end

  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
    fire_event(:shutdown, true)
    # Explicitly exit so busy Processor threads can't block
    # process shutdown.
    exit(0)
  end
end