Class: Sidekiq::CLI
- Inherits:
-
Object
show all
- Includes:
- Component, Singleton
- Defined in:
- lib/sidekiq/cli.rb
Constant Summary
collapse
- HOLIDAY_COLORS =
{
"3-17" => "\e[1;32m", "10-31" => "\e[38;5;208m" }
- SIGNAL_HANDLERS =
{
"INT" => ->(cli) { raise Interrupt },
"TERM" => ->(cli) { raise Interrupt },
"TSTP" => ->(cli) {
cli.logger.info "Received TSTP, no longer accepting new work"
cli.launcher.quiet
},
"TTIN" => ->(cli) {
Thread.list.each do |thread|
cli.logger.warn "Thread TID-#{(thread.object_id ^ ::Process.pid).to_s(36)} #{thread.name}"
if thread.backtrace
cli.logger.warn thread.backtrace.join("\n")
else
cli.logger.warn "<no backtrace available>"
end
end
}
}
- UNHANDLED_SIGNAL_HANDLER =
->(cli) { cli.logger.info "No signal handler registered, ignoring" }
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
Methods included from Component
#fire_event, #handle_exception, #hostname, #identity, #logger, #process_nonce, #redis, #safe_thread, #tid, #watchdog
Instance Attribute Details
#config ⇒ Object
Returns the value of attribute config.
24
25
26
|
# File 'lib/sidekiq/cli.rb', line 24
def config
@config
end
|
#environment ⇒ Object
Returns the value of attribute environment.
23
24
25
|
# File 'lib/sidekiq/cli.rb', line 23
def environment
@environment
end
|
#launcher ⇒ Object
Returns the value of attribute launcher.
22
23
24
|
# File 'lib/sidekiq/cli.rb', line 22
def launcher
@launcher
end
|
Class Method Details
.b ⇒ Object
162
163
164
|
# File 'lib/sidekiq/cli.rb', line 162
def self.b
@@b ||= HOLIDAY_COLORS[day] || "\e[30m"
end
|
.banner ⇒ Object
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
# File 'lib/sidekiq/cli.rb', line 175
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} $: #{b}'#{w},$$: #{r} / ___|(_) __| | ___| | _(_) __ _
#{w} `b :$$ #{r} \\___ \\| |/ _` |/ _ \\ |/ / |/ _` |
#{w} $$: #{r} ___) | | (_| | __/ <| | (_| |
#{w} $$ #{r}|____/|_|\\__,_|\\___|_|\\_\\_|\\__, |
#{w} .d$$ #{r} |_|
#{reset}}
end
|
.day ⇒ Object
151
152
153
154
155
156
|
# File 'lib/sidekiq/cli.rb', line 151
def self.day
@@day ||= begin
t = Date.today
"#{t.month}-#{t.day}"
end
end
|
.r ⇒ Object
158
159
160
|
# File 'lib/sidekiq/cli.rb', line 158
def self.r
@@r ||= HOLIDAY_COLORS[day] || "\e[1;31m"
end
|
.reset ⇒ Object
170
171
172
173
|
# File 'lib/sidekiq/cli.rb', line 170
def self.reset
@@b = @@r = @@day = nil
"\e[0m"
end
|
.w ⇒ Object
166
167
168
|
# File 'lib/sidekiq/cli.rb', line 166
def self.w
"\e[1;37m"
end
|
Instance Method Details
#handle_signal(sig) ⇒ Object
216
217
218
219
|
# File 'lib/sidekiq/cli.rb', line 216
def handle_signal(sig)
logger.debug "Got #{sig} signal"
SIGNAL_HANDLERS[sig].call(self)
end
|
#jruby? ⇒ Boolean
34
35
36
|
# File 'lib/sidekiq/cli.rb', line 34
def jruby?
defined?(::JRUBY_VERSION)
end
|
#launch(self_read) ⇒ Object
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
# File 'lib/sidekiq/cli.rb', line 116
def launch(self_read)
if environment == "development" && $stdout.tty?
logger.info "Starting processing, hit Ctrl-C to stop"
end
@launcher = Sidekiq::Launcher.new(@config)
begin
launcher.run
while self_read.wait_readable
signal = self_read.gets.strip
handle_signal(signal)
end
rescue Interrupt
logger.info "Shutting down"
launcher.stop
logger.info "Bye!"
exit(0)
end
end
|
#parse(args = ARGV.dup) ⇒ Object
26
27
28
29
30
31
32
|
# File 'lib/sidekiq/cli.rb', line 26
def parse(args = ARGV.dup)
@config ||= Sidekiq.default_configuration
setup_options(args)
initialize_logger
validate!
end
|
#run(boot_app: true, warmup: true) ⇒ 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.
41
42
43
44
45
46
47
48
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
103
104
105
106
107
108
109
110
111
112
113
114
|
# File 'lib/sidekiq/cli.rb', line 41
def run(boot_app: true, warmup: true)
boot_application if boot_app
if environment == "development" && $stdout.tty? && @config.logger.formatter.is_a?(Sidekiq::Logger::Formatters::Pretty)
print_banner
end
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]
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
rescue Exception => exc
puts ["Error in #{sig} handler", exc].inspect
end
end
self_write.puts(sig)
end
rescue ArgumentError
puts "Signal #{sig} not supported"
end
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)
info = @config.redis_info
ver = Gem::Version.new(info["redis_version"])
raise "You are connecting to Redis #{ver}, Sidekiq requires Redis 6.2.0 or greater" if ver < Gem::Version.new("6.2.0")
maxmemory_policy = info["maxmemory_policy"]
if maxmemory_policy != "noeviction" && maxmemory_policy != ""
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/sidekiq/sidekiq/wiki/Using-Redis#memory
EOM
end
@config.capsules.each_pair do |name, cap|
raise ArgumentError, "Pool size too small for #{name}" if cap.redis_pool.size < cap.concurrency
end
@config[:identity] = identity
@config.server_middleware
::Process.warmup if warmup && ::Process.respond_to?(:warmup)
fire_event(:startup, reverse: false, reraise: true)
logger.debug { "Client Middleware: #{@config.default_capsule.client_middleware.map(&:klass).join(", ")}" }
logger.debug { "Server Middleware: #{@config.default_capsule.server_middleware.map(&:klass).join(", ")}" }
launch(self_read)
end
|