Class: Puma::Cluster

Inherits:
Runner show all
Defined in:
lib/puma/cluster.rb,
lib/puma/cluster/worker.rb,
lib/puma/cluster/worker_handle.rb

Overview

This class is instantiated by the `Puma::Launcher` and used to boot and serve a Ruby application when puma “workers” are needed i.e. when using multi-processes. For example `$ puma -w 5`

An instance of this class will spawn the number of processes passed in via the `spawn_workers` method call. Each worker will have it's own instance of a `Puma::Server`.

Defined Under Namespace

Classes: Worker, WorkerHandle

Instance Attribute Summary collapse

Attributes inherited from Runner

#app, #ruby_engine

Instance Method Summary collapse

Methods inherited from Runner

#close_control_listeners, #debug, #development?, #error, #load_and_bind, #log, #output_header, #redirected_io?, #start_control, #start_server, #stop_control, #test?

Constructor Details

#initialize(cli, events) ⇒ Cluster

Returns a new instance of Cluster.


20
21
22
23
24
25
26
27
28
# File 'lib/puma/cluster.rb', line 20

def initialize(cli, events)
  super cli, events

  @phase = 0
  @workers = []
  @next_check = Time.now

  @phased_restart = false
end

Instance Attribute Details

#next_worker_indexObject (readonly)


123
124
125
126
127
128
# File 'lib/puma/cluster.rb', line 123

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

#statsObject (readonly)

Inside of a child process, this will return all zeroes, as @workers is only populated in the master process.


238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
# File 'lib/puma/cluster.rb', line 238

def stats
  old_worker_count = @workers.count { |w| w.phase != @phase }
  worker_status = @workers.map do |w|
    {
      started_at: w.started_at.utc.iso8601,
      pid: w.pid,
      index: w.index,
      phase: w.phase,
      booted: w.booted?,
      last_checkin: w.last_checkin.utc.iso8601,
      last_status: w.last_status,
    }
  end

  {
    started_at: @started_at.utc.iso8601,
    workers: @workers.size,
    phase: @phase,
    booted_workers: worker_status.count { |w| w[:booted] },
    old_workers: old_worker_count,
    worker_status: worker_status,
  }
end

Instance Method Details

#all_workers_booted?Boolean

Returns:

  • (Boolean)

130
131
132
# File 'lib/puma/cluster.rb', line 130

def all_workers_booted?
  @workers.count { |w| !w.booted? } == 0
end

#check_workersObject


134
135
136
137
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
# File 'lib/puma/cluster.rb', line 134

def check_workers
  return if @next_check >= Time.now

  @next_check = Time.now + Const::WORKER_CHECK_INTERVAL

  timeout_workers
  wait_workers
  cull_workers
  spawn_workers

  if all_workers_booted?
    # If we're running at proper capacity, check to see if
    # we need to phase any workers out (which will restart
    # in the right phase).
    #
    w = @workers.find { |x| x.phase != @phase }

    if w
      log "- Stopping #{w.pid} for phased upgrade..."
      unless w.term?
        w.term
        log "- #{w.signal} sent to #{w.pid}..."
      end
    end
  end

  @next_check = [
    @workers.reject(&:term?).map(&:ping_timeout).min,
    @next_check
  ].compact.min
end

#cull_workersObject


107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/puma/cluster.rb', line 107

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

#fork_worker!Object

Version:

  • 5.0.0


267
268
269
270
271
272
# File 'lib/puma/cluster.rb', line 267

def fork_worker!
  if (worker = @workers.find { |w| w.index == 0 })
    worker.phase += 1
  end
  phased_restart
end

#haltObject


224
225
226
227
# File 'lib/puma/cluster.rb', line 224

def halt
  @status = :halt
  wakeup!
end

#phased_restartObject


203
204
205
206
207
208
209
210
# File 'lib/puma/cluster.rb', line 203

def phased_restart
  return false if @options[:preload_app]

  @phased_restart = true
  wakeup!

  true
end

#preload?Boolean

Returns:

  • (Boolean)

262
263
264
# File 'lib/puma/cluster.rb', line 262

def preload?
  @options[:preload_app]
end

#redirect_ioObject


56
57
58
59
60
# File 'lib/puma/cluster.rb', line 56

def redirect_io
  super

  @workers.each { |x| x.hup }
end

#reload_worker_directoryObject


229
230
231
232
233
# File 'lib/puma/cluster.rb', line 229

def reload_worker_directory
  dir = @launcher.restart_dir
  log "+ Changing to #{dir}"
  Dir.chdir dir
end

#restartObject


198
199
200
201
# File 'lib/puma/cluster.rb', line 198

def restart
  @restart = true
  stop
end

#runObject


327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
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
385
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
# File 'lib/puma/cluster.rb', line 327

def run
  @status = :run

  output_header "cluster"

  # This is aligned with the output from Runner, see Runner#output_header
  log "*      Workers: #{@options[:workers]}"

  # Threads explicitly marked as fork safe will be ignored.
  # Used in Rails, but may be used by anyone.
  before = Thread.list.reject { |t| t.thread_variable_get(:fork_safe) }

  if preload?
    log "*     Restarts: (\u2714) hot (\u2716) phased"
    log "* Preloading application"
    load_and_bind

    after = Thread.list.reject { |t| t.thread_variable_get(:fork_safe) }

    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 "*     Restarts: (\u2714) hot (\u2714) phased"

    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

  # Used by the workers to detect if the master process dies.
  # If select says that @check_pipe is ready, it's because the
  # master has exited and @suicide_pipe has been automatically
  # closed.
  #
  @check_pipe, @suicide_pipe = Puma::Util.pipe

  # Separate pipe used by worker 0 to receive commands to
  # fork new worker processes.
  @fork_pipe, @fork_writer = Puma::Util.pipe

  log "Use Ctrl-C to stop"

  single_worker_warning

  redirect_io

  Plugins.fire_background

  @launcher.write_state

  start_control

  @master_read, @worker_write = read, @wakeup

  @launcher.config.run_hooks :before_fork, nil, @launcher.events
  Puma::Util.nakayoshi_gc @events if @options[:nakayoshi_fork]

  spawn_workers

  Signal.trap "SIGINT" do
    stop
  end

  begin
    booted = false

    while @status == :run
      begin
        if @phased_restart
          start_phased_restart
          @phased_restart = false
        end

        check_workers

        res = IO.select([read], nil, nil, [0, @next_check - Time.now].max)

        if res
          req = read.read_nonblock(1)

          @next_check = Time.now if req == "!"
          next if !req || req == "!"

          result = read.gets
          pid = result.to_i

          if req == "b" || req == "f"
            pid, idx = result.split(':').map(&:to_i)
            w = @workers.find {|x| x.index == idx}
            w.pid = pid if w.pid.nil?
          end

          if w = @workers.find { |x| x.pid == pid }
            case req
            when "b"
              w.boot!
              log "- Worker #{w.index} (PID: #{pid}) booted in #{w.uptime.round(2)}s, phase: #{w.phase}"
              @next_check = Time.now
            when "e"
              # external term, see worker method, Signal.trap "SIGTERM"
              w.instance_variable_set :@term, true
            when "t"
              w.term unless w.term?
            when "p"
              w.ping!(result.sub(/^\d+/,'').chomp)
              @launcher.events.fire(:ping!, w)
              if !booted && @workers.none? {|worker| worker.last_status.empty?}
                @launcher.events.fire_on_booted!
                booted = true
              end
            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_signalsObject

We do this in a separate method to keep the lambda scope of the signals handlers as small as possible.


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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
# File 'lib/puma/cluster.rb', line 276

def setup_signals
  if @options[:fork_worker]
    Signal.trap "SIGURG" do
      fork_worker!
    end

    # Auto-fork after the specified number of requests.
    if (fork_requests = @options[:fork_worker].to_i) > 0
      @launcher.events.register(:ping!) do |w|
        fork_worker! if w.index == 0 &&
          w.phase == 0 &&
          w.last_status[:requests_count] >= fork_requests
      end
    end
  end

  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
    # The worker installs their own SIGTERM when booted.
    # Until then, this is run by the worker and the worker
    # should just exit if they get it.
    if Process.pid != master_pid
      log "Early termination of worker"
      exit! 0
    else
      @launcher.close_binder_listeners

      stop_workers
      stop

      raise(SignalException, "SIGTERM") if @options[:raise_exception_on_sigterm]
      exit 0 # Clean exit, workers were stopped
    end
  end
end

#spawn_worker(idx, master) ⇒ Object

Version:

  • 5.0.0


93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'lib/puma/cluster.rb', line 93

def spawn_worker(idx, master)
  @launcher.config.run_hooks :before_worker_fork, idx, @launcher.events

  pid = fork { worker(idx, master) }
  if !pid
    log "! Complete inability to spawn new workers detected"
    log "! Seppuku is the only choice."
    exit! 1
  end

  @launcher.config.run_hooks :after_worker_fork, idx, @launcher.events
  pid
end

#spawn_workersObject


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
# File 'lib/puma/cluster.rb', line 62

def spawn_workers
  diff = @options[:workers] - @workers.size
  return if diff < 1

  master = Process.pid
  if @options[:fork_worker]
    @fork_writer << "-1\n"
  end

  diff.times do
    idx = next_worker_index

    if @options[:fork_worker] && idx != 0
      @fork_writer << "#{idx}\n"
      pid = nil
    else
      pid = spawn_worker(idx, master)
    end

    debug "Spawned worker: #{pid}"
    @workers << WorkerHandle.new(idx, pid, @phase, @options)
  end

  if @options[:fork_worker] &&
    @workers.all? {|x| x.phase == @phase}

    @fork_writer << "0\n"
  end
end

#start_phased_restartObject


45
46
47
48
49
50
51
52
53
54
# File 'lib/puma/cluster.rb', line 45

def start_phased_restart
  @phase += 1
  log "- Starting phased worker restart, phase: #{@phase}"

  # Be sure to change the directory again before loading
  # the app. This way we can pick up new code.
  dir = @launcher.restart_dir
  log "+ Changing to #{dir}"
  Dir.chdir dir
end

#stopObject


212
213
214
215
# File 'lib/puma/cluster.rb', line 212

def stop
  @status = :stop
  wakeup!
end

#stop_blockedObject


217
218
219
220
221
222
# File 'lib/puma/cluster.rb', line 217

def stop_blocked
  @status = :stop if @status == :run
  wakeup!
  @control.stop(true) if @control
  Process.waitall
end

#stop_workersObject


30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/puma/cluster.rb', line 30

def stop_workers
  log "- Gracefully shutting down workers..."
  @workers.each { |x| x.term }

  begin
    loop do
      wait_workers
      break if @workers.reject {|w| w.pid.nil?}.empty?
      sleep 0.2
    end
  rescue Interrupt
    log "! Cancelled waiting for workers"
  end
end

#wakeup!Object


166
167
168
169
170
171
172
173
174
# File 'lib/puma/cluster.rb', line 166

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


176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'lib/puma/cluster.rb', line 176

def worker(index, master)
  @workers = []

  @master_read.close
  @suicide_pipe.close
  @fork_writer.close

  pipes = { check_pipe: @check_pipe, worker_write: @worker_write }
  if @options[:fork_worker]
    pipes[:fork_pipe] = @fork_pipe
    pipes[:wakeup] = @wakeup
  end

  server = start_server if preload?
  new_worker = Worker.new index: index,
                          master: master,
                          launcher: @launcher,
                          pipes: pipes,
                          server: server
  new_worker.run
end