Class: Puma::Cluster
Defined Under Namespace
Classes: Worker
Constant Summary
collapse
- WORKER_CHECK_INTERVAL =
5
Instance Method Summary
collapse
Methods inherited from Runner
#app, #before_restart, #daemon?, #debug, #development?, #error, #load_and_bind, #log, #output_header, #redirected_io?, #ruby_engine, #start_control, #start_server
Constructor Details
#initialize(cli, events) ⇒ Cluster
Returns a new instance of Cluster.
11
12
13
14
15
16
17
18
19
20
|
# File 'lib/puma/cluster.rb', line 11
def initialize(cli, events)
super cli, events
@phase = 0
@workers = []
@next_check = nil
@phased_state = :idle
@phased_restart = false
end
|
Instance Method Details
#all_workers_booted? ⇒ Boolean
166
167
168
|
# File 'lib/puma/cluster.rb', line 166
def all_workers_booted?
@workers.count { |w| !w.booted? } == 0
end
|
#check_workers(force = false) ⇒ Object
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
# File 'lib/puma/cluster.rb', line 170
def check_workers(force=false)
return if !force && @next_check && @next_check >= Time.now
@next_check = Time.now + WORKER_CHECK_INTERVAL
any = false
@workers.each do |w|
next if !w.booted? && !w.ping_timeout?(@options[:worker_boot_timeout])
if w.ping_timeout?(@options[:worker_timeout])
log "! Terminating timed out worker: #{w.pid}"
w.kill
any = true
end
end
sleep 1 if any
while @workers.any?
pid = Process.waitpid(-1, Process::WNOHANG)
break unless pid
@workers.delete_if { |w| w.pid == pid }
end
@workers.delete_if(&:dead?)
cull_workers
spawn_workers
if all_workers_booted?
w = @workers.find { |x| x.phase != @phase }
if w
if @phased_state == :idle
@phased_state = :waiting
log "- Stopping #{w.pid} for phased upgrade..."
end
w.term
log "- #{w.signal} sent to #{w.pid}..."
end
end
end
|
#cull_workers ⇒ Object
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
# File 'lib/puma/cluster.rb', line 144
def cull_workers
diff = @workers.size - @options[:workers]
return if diff < 1
debug "Culling #{diff.inspect} workers"
workers_to_cull = @workers[-diff,diff]
debug "Workers to cull: #{workers_to_cull.inspect}"
workers_to_cull.each do |worker|
log "- Worker #{worker.index} (pid: #{worker.pid}) terminating"
worker.term
end
end
|
#halt ⇒ Object
329
330
331
332
|
# File 'lib/puma/cluster.rb', line 329
def halt
@status = :halt
wakeup!
end
|
#next_worker_index ⇒ Object
159
160
161
162
163
164
|
# File 'lib/puma/cluster.rb', line 159
def next_worker_index
all_positions = 0...@options[:workers]
occupied_positions = @workers.map { |w| w.index }
available_positions = all_positions.to_a - occupied_positions
available_positions.first
end
|
#phased_restart ⇒ Object
308
309
310
311
312
313
314
315
|
# File 'lib/puma/cluster.rb', line 308
def phased_restart
return false if @options[:preload_app]
@phased_restart = true
wakeup!
true
end
|
#preload? ⇒ Boolean
347
348
349
|
# File 'lib/puma/cluster.rb', line 347
def preload?
@options[:preload_app]
end
|
#redirect_io ⇒ Object
44
45
46
47
48
|
# File 'lib/puma/cluster.rb', line 44
def redirect_io
super
@workers.each { |x| x.hup }
end
|
#reload_worker_directory ⇒ Object
334
335
336
337
338
|
# File 'lib/puma/cluster.rb', line 334
def reload_worker_directory
dir = @launcher.restart_dir
log "+ Changing to #{dir}"
Dir.chdir dir
end
|
#restart ⇒ Object
303
304
305
306
|
# File 'lib/puma/cluster.rb', line 303
def restart
@restart = true
stop
end
|
#run ⇒ Object
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
|
# File 'lib/puma/cluster.rb', line 386
def run
@status = :run
"cluster"
log "* Process workers: #{@options[:workers]}"
before = Thread.list
if preload?
log "* Preloading application"
load_and_bind
after = Thread.list
if after.size > before.size
threads = (after - before)
if threads.first.respond_to? :backtrace
log "! WARNING: Detected #{after.size-before.size} Thread(s) started in app boot:"
threads.each do |t|
log "! #{t.inspect} - #{t.backtrace ? t.backtrace.first : ''}"
end
else
log "! WARNING: Detected #{after.size-before.size} Thread(s) started in app boot"
end
end
else
log "* Phased restart available"
unless @launcher.config.app_configured?
error "No application configured, nothing to run"
exit 1
end
@launcher.binder.parse @options[:binds], self
end
read, @wakeup = Puma::Util.pipe
setup_signals
@check_pipe, @suicide_pipe = Puma::Util.pipe
if daemon?
log "* Daemonizing..."
Process.daemon(true)
else
log "Use Ctrl-C to stop"
end
redirect_io
Plugins.fire_background
@launcher.write_state
start_control
@master_read, @worker_write = read, @wakeup
@launcher.config.run_hooks :before_fork, nil
spawn_workers
Signal.trap "SIGINT" do
stop
end
@launcher.events.fire_on_booted!
begin
force_check = false
while @status == :run
begin
if @phased_restart
start_phased_restart
@phased_restart = false
end
check_workers force_check
force_check = false
res = IO.select([read], nil, nil, WORKER_CHECK_INTERVAL)
if res
req = read.read_nonblock(1)
next if !req || req == "!"
result = read.gets
pid = result.to_i
if w = @workers.find { |x| x.pid == pid }
case req
when "b"
w.boot!
log "- Worker #{w.index} (pid: #{pid}) booted, phase: #{w.phase}"
force_check = true
when "t"
w.dead!
force_check = true
when "p"
w.ping!(result.sub(/^\d+/,'').chomp)
end
else
log "! Out-of-sync worker list, no #{pid} worker"
end
end
rescue Interrupt
@status = :stop
end
end
stop_workers unless @status == :halt
ensure
@check_pipe.close
@suicide_pipe.close
read.close
@wakeup.close
end
end
|
#setup_signals ⇒ Object
We do this in a separate method to keep the lambda scope of the signals handlers as small as possible.
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
|
# File 'lib/puma/cluster.rb', line 353
def setup_signals
Signal.trap "SIGCHLD" do
wakeup!
end
Signal.trap "TTIN" do
@options[:workers] += 1
wakeup!
end
Signal.trap "TTOU" do
@options[:workers] -= 1 if @options[:workers] >= 2
wakeup!
end
master_pid = Process.pid
Signal.trap "SIGTERM" do
if Process.pid != master_pid
log "Early termination of worker"
exit! 0
else
stop_workers
stop
raise SignalException, "SIGTERM"
end
end
end
|
#spawn_workers ⇒ 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/puma/cluster.rb', line 116
def spawn_workers
diff = @options[:workers] - @workers.size
return if diff < 1
master = Process.pid
diff.times do
idx = next_worker_index
@launcher.config.run_hooks :before_worker_fork, idx
pid = fork { worker(idx, master) }
if !pid
log "! Complete inability to spawn new workers detected"
log "! Seppuku is the only choice."
exit! 1
end
debug "Spawned worker: #{pid}"
@workers << Worker.new(idx, pid, @phase, @options)
@launcher.config.run_hooks :after_worker_fork, idx
end
if diff > 0
@phased_state = :idle
end
end
|
#start_phased_restart ⇒ Object
33
34
35
36
37
38
39
40
41
42
|
# File 'lib/puma/cluster.rb', line 33
def start_phased_restart
@phase += 1
log "- Starting phased worker restart, phase: #{@phase}"
dir = @launcher.restart_dir
log "+ Changing to #{dir}"
Dir.chdir dir
end
|
#stats ⇒ Object
340
341
342
343
344
345
|
# File 'lib/puma/cluster.rb', line 340
def stats
old_worker_count = @workers.count { |w| w.phase != @phase }
booted_worker_count = @workers.count { |w| w.booted? }
worker_status = '[' + @workers.map { |w| %Q!{ "pid": #{w.pid}, "index": #{w.index}, "phase": #{w.phase}, "booted": #{w.booted?}, "last_checkin": "#{w.last_checkin.utc.iso8601}", "last_status": #{w.last_status} }!}.join(",") + ']'
%Q!{ "workers": #{@workers.size}, "phase": #{@phase}, "booted_workers": #{booted_worker_count}, "old_workers": #{old_worker_count}, "worker_status": #{worker_status} }!
end
|
#stop ⇒ Object
317
318
319
320
|
# File 'lib/puma/cluster.rb', line 317
def stop
@status = :stop
wakeup!
end
|
#stop_blocked ⇒ Object
322
323
324
325
326
327
|
# File 'lib/puma/cluster.rb', line 322
def stop_blocked
@status = :stop if @status == :run
wakeup!
@control.stop(true) if @control
Process.waitall
end
|
#stop_workers ⇒ Object
22
23
24
25
26
27
28
29
30
31
|
# File 'lib/puma/cluster.rb', line 22
def stop_workers
log "- Gracefully shutting down workers..."
@workers.each { |x| x.term }
begin
@workers.each { |w| Process.waitpid(w.pid) }
rescue Interrupt
log "! Cancelled waiting for workers"
end
end
|
#wakeup! ⇒ Object
221
222
223
224
225
226
227
228
229
|
# File 'lib/puma/cluster.rb', line 221
def wakeup!
return unless @wakeup
begin
@wakeup.write "!" unless @wakeup.closed?
rescue SystemCallError, IOError
Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
end
end
|
#worker(index, master) ⇒ Object
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
|
# File 'lib/puma/cluster.rb', line 231
def worker(index, master)
title = "puma: cluster worker #{index}: #{master}"
title += " [#{@options[:tag]}]" if @options[:tag] && !@options[:tag].empty?
$0 = title
Signal.trap "SIGINT", "IGNORE"
@workers = []
@master_read.close
@suicide_pipe.close
Thread.new do
IO.select [@check_pipe]
log "! Detected parent died, dying"
exit! 1
end
if !ENV['BUNDLE_GEMFILE']
if File.exist?("Gemfile")
log "+ Gemfile in context: #{File.expand_path("Gemfile")}"
elsif File.exist?("gems.rb")
log "+ Gemfile in context: #{File.expand_path("gems.rb")}"
end
end
@launcher.config.run_hooks :before_worker_boot, index
server = start_server
Signal.trap "SIGTERM" do
server.stop
end
begin
@worker_write << "b#{Process.pid}\n"
rescue SystemCallError, IOError
Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
STDERR.puts "Master seems to have exited, exiting."
return
end
Thread.new(@worker_write) do |io|
base_payload = "p#{Process.pid}"
while true
sleep WORKER_CHECK_INTERVAL
begin
b = server.backlog || 0
r = server.running || 0
payload = %Q!#{base_payload}{ "backlog":#{b}, "running":#{r} }\n!
io << payload
rescue IOError
Thread.current.purge_interrupt_queue if Thread.current.respond_to? :purge_interrupt_queue
break
end
end
end
server.run.join
@launcher.config.run_hooks :before_worker_shutdown, index
ensure
@worker_write << "t#{Process.pid}\n" rescue nil
@worker_write.close
end
|