Class: Puma::DSL

Inherits:
Object
  • Object
show all
Includes:
ConfigDefault
Defined in:
lib/puma/dsl.rb

Overview

The methods that are available for use inside the configuration file. These same methods are used in Puma cli and the rack handler internally.

Used manually (via CLI class):

config = Configuration.new({}) do |user_config|
  user_config.port 3001
end
config.load

puts config.options[:binds]
"tcp://127.0.0.1:3001"

Used to load file:

$ cat puma_config.rb
  port 3002

config = Configuration.new(config_file: "puma_config.rb")
config.load

puts config.options[:binds]
# => "tcp://127.0.0.1:3002"

You can also find many examples being used by the test suite in test/config.

Constant Summary

Constants included from ConfigDefault

ConfigDefault::DefaultRackup, ConfigDefault::DefaultTCPHost, ConfigDefault::DefaultTCPPort, ConfigDefault::DefaultWorkerShutdownTimeout, ConfigDefault::DefaultWorkerTimeout

Instance Method Summary collapse

Constructor Details

#initialize(options, config) ⇒ DSL

Returns a new instance of DSL.


36
37
38
39
40
41
# File 'lib/puma/dsl.rb', line 36

def initialize(options, config)
  @config  = config
  @options = options

  @plugins = []
end

Instance Method Details

#_load_from(path) ⇒ Object


43
44
45
46
47
48
49
50
# File 'lib/puma/dsl.rb', line 43

def _load_from(path)
  if path
    @path = path
    instance_eval(File.read(path), path, 1)
  end
ensure
  _offer_plugins
end

#_offer_pluginsObject


52
53
54
55
56
57
58
59
60
61
# File 'lib/puma/dsl.rb', line 52

def _offer_plugins
  @plugins.each do |o|
    if o.respond_to? :config
      @options.shift
      o.config self
    end
  end

  @plugins.clear
end

#activate_control_app(url = "auto", opts = {}) ⇒ Object

Start the Puma control rack application on url. This application can be communicated with to control the main server. Additionally, you can provide an authentication token, so all requests to the control server will need to include that token as a query parameter. This allows for simple authentication.

Check out App::Status to see what the app has available.

Examples:

activate_control_app 'unix:///var/run/pumactl.sock'
activate_control_app 'unix:///var/run/pumactl.sock', { auth_token: '12345' }
activate_control_app 'unix:///var/run/pumactl.sock', { no_token: true }

123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/puma/dsl.rb', line 123

def activate_control_app(url="auto", opts={})
  if url == "auto"
    path = Configuration.temp_path
    @options[:control_url] = "unix://#{path}"
    @options[:control_url_temp] = path
  else
    @options[:control_url] = url
  end

  if opts[:no_token]
    # We need to use 'none' rather than :none because this value will be
    # passed on to an instance of OptionParser, which doesn't support
    # symbols as option values.
    #
    # See: https://github.com/puma/puma/issues/1193#issuecomment-305995488
    auth_token = 'none'
  else
    auth_token = opts[:auth_token]
    auth_token ||= Configuration.random_token
  end

  @options[:control_auth_token] = auth_token
  @options[:control_url_umask] = opts[:umask] if opts[:umask]
end

#after_worker_fork(&block) ⇒ Object Also known as: after_worker_boot

Note:

Cluster mode only.

Code to run in the master after a worker has been started. The worker's index is passed as an argument.

This is called everytime a worker is to be started.

Examples:

after_worker_fork do
  puts 'After worker fork...'
end

496
497
498
499
# File 'lib/puma/dsl.rb', line 496

def after_worker_fork(&block)
  @options[:after_worker_fork] ||= []
  @options[:after_worker_fork] = block
end

#app(obj = nil, &block) ⇒ Object

Use an object or block as the rack application. This allows the configuration file to be the application itself.

Examples:

app do |env|
  body = 'Hello, World!'

  [
    200,
    {
      'Content-Type' => 'text/plain',
      'Content-Length' => body.length.to_s
    },
    [body]
  ]
end

101
102
103
104
105
106
107
# File 'lib/puma/dsl.rb', line 101

def app(obj=nil, &block)
  obj ||= block

  raise "Provide either a #call'able or a block" unless obj

  @options[:app] = obj
end

#before_fork(&block) ⇒ Object

Note:

Cluster mode only.

Code to run immediately before master process forks workers (once on boot). These hooks can block if necessary to wait for background operations unknown to Puma to finish before the process terminates. This can be used to close any connections to remote servers (database, Redis, …) that were opened when preloading the code.

This can be called multiple times to add several hooks.

Examples:

before_fork do
  puts "Starting workers..."
end

434
435
436
437
# File 'lib/puma/dsl.rb', line 434

def before_fork(&block)
  @options[:before_fork] ||= []
  @options[:before_fork] << block
end

#bind(url) ⇒ Object

Bind the server to url. “tcp://”, “unix://” and “ssl://” are the only accepted protocols. Multiple urls can be bound to, calling `bind` does not overwrite previous bindings.

The default is “tcp://0.0.0.0:9292”.

You can use query parameters within the url to specify options:

- Set the socket backlog depth with +backlog+, default is 1024.
- Set up an SSL certificate with +key+ & +cert+.
- Set whether to optimize for low latency instead of throughput with
  +low_latency+, default is to optimize for low latency. This is done
  via +Socket::TCP_NODELAY+.
- Set socket permissions with +umask+.

Examples:

Backlog depth

bind 'unix:///var/run/puma.sock?backlog=512'

SSL cert

bind 'ssl://127.0.0.1:9292?key=key.key&cert=cert.pem'

Disable optimization for low latency

bind 'tcp://0.0.0.0:9292?low_latency=false'

Socket permissions

bind 'unix:///var/run/puma.sock?umask=0111'

178
179
180
181
# File 'lib/puma/dsl.rb', line 178

def bind(url)
  @options[:binds] ||= []
  @options[:binds] << url
end

#clean_thread_locals(which = true) ⇒ Object

Work around leaky apps that leave garbage in Thread locals across requests.


209
210
211
# File 'lib/puma/dsl.rb', line 209

def clean_thread_locals(which=true)
  @options[:clean_thread_locals] = which
end

#clear_binds!Object


183
184
185
# File 'lib/puma/dsl.rb', line 183

def clear_binds!
  @options[:binds] = []
end

#debugObject

Show debugging info


300
301
302
# File 'lib/puma/dsl.rb', line 300

def debug
  @options[:debug] = true
end

#default_hostObject


67
68
69
# File 'lib/puma/dsl.rb', line 67

def default_host
  @options[:default_host] || Configuration::DefaultTCPHost
end

#directory(dir) ⇒ Object

The directory to operate out of.

The default is the current directory.

Examples:

directory '/u/apps/lolcat'

545
546
547
# File 'lib/puma/dsl.rb', line 545

def directory(dir)
  @options[:directory] = dir.to_s
end

#drain_on_shutdown(which = true) ⇒ Object

When shutting down, drain the accept socket of pending connections and process them. This loops over the accept socket until there are no more read events and then stops looking and waits for the requests to finish.


217
218
219
# File 'lib/puma/dsl.rb', line 217

def drain_on_shutdown(which=true)
  @options[:drain_on_shutdown] = which
end

#early_hints(answer = true) ⇒ Object


314
315
316
# File 'lib/puma/dsl.rb', line 314

def early_hints(answer=true)
  @options[:early_hints] = answer
end

#environment(environment) ⇒ Object

Set the environment in which the rack's app will run. The value must be a string.

The default is “development”.

Examples:

environment 'production'

228
229
230
# File 'lib/puma/dsl.rb', line 228

def environment(environment)
  @options[:environment] = environment
end

#extra_runtime_dependencies(answer = []) ⇒ Object

When using prune_bundler, if extra runtime dependencies need to be loaded to initialize your app, then this setting can be used. This includes any Puma plugins.

Before bundler is pruned, the gem names supplied will be looked up in the bundler context and then loaded again after bundler is pruned. Only applies if prune_bundler is used.

Examples:

extra_runtime_dependencies ['gem_name_1', 'gem_name_2']
extra_runtime_dependencies ['puma_worker_killer', 'puma-heroku']

617
618
619
# File 'lib/puma/dsl.rb', line 617

def extra_runtime_dependencies(answer = [])
  @options[:extra_runtime_dependencies] = Array(answer)
end

#first_data_timeout(seconds) ⇒ Object

Define how long the tcp socket stays open, if no data has been received.


203
204
205
# File 'lib/puma/dsl.rb', line 203

def first_data_timeout(seconds)
  @options[:first_data_timeout] = Integer(seconds)
end

#force_shutdown_after(val = :forever) ⇒ Object

How long to wait for threads to stop when shutting them down. Defaults to :forever. Specifying :immediately will cause Puma to kill the threads immediately. Otherwise the value is the number of seconds to wait.

Puma always waits a few seconds after killing a thread for it to try to finish up it's work, even in :immediately mode.


239
240
241
242
243
244
245
246
247
248
249
250
# File 'lib/puma/dsl.rb', line 239

def force_shutdown_after(val=:forever)
  i = case val
      when :forever
        -1
      when :immediately
        0
      else
        Float(val)
      end

  @options[:force_shutdown_after] = i
end

#fork_worker(after_requests = 1000) ⇒ Object

Note:

Cluster mode only.

When enabled, workers will be forked from worker 0 instead of from the master process. This option is similar to `preload_app` because the app is preloaded before forking, but it is compatible with phased restart.

This option also enables the `refork` command (SIGURG), which optimizes copy-on-write performance in a running app.

A refork will automatically trigger once after the specified number of requests (default 1000), or pass 0 to disable auto refork.


759
760
761
# File 'lib/puma/dsl.rb', line 759

def fork_worker(after_requests=1000)
  @options[:fork_worker] = Integer(after_requests)
end

#get(key, default = nil) ⇒ Object


75
76
77
# File 'lib/puma/dsl.rb', line 75

def get(key,default=nil)
  @options[key.to_sym] || default
end

#inject(&blk) ⇒ Object


71
72
73
# File 'lib/puma/dsl.rb', line 71

def inject(&blk)
  instance_eval(&blk)
end

#load(file) ⇒ Object

Load additional configuration from a file Files get loaded later via Configuration#load


150
151
152
153
# File 'lib/puma/dsl.rb', line 150

def load(file)
  @options[:config_files] ||= []
  @options[:config_files] << file
end

#log_formatter(&block) ⇒ Object


331
332
333
# File 'lib/puma/dsl.rb', line 331

def log_formatter(&block)
  @options[:log_formatter] = block
end

#log_requests(which = true) ⇒ Object

Enable request logging


294
295
296
# File 'lib/puma/dsl.rb', line 294

def log_requests(which=true)
  @options[:log_requests] = which
end

#lowlevel_error_handler(obj = nil, &block) ⇒ Object

Use obj or block as the low level error handler. This allows the configuration file to change the default error on the server.

Examples:

lowlevel_error_handler do |err|
  [200, {}, ["error page"]]
end

566
567
568
569
570
# File 'lib/puma/dsl.rb', line 566

def lowlevel_error_handler(obj=nil, &block)
  obj ||= block
  raise "Provide either a #call'able or a block" unless obj
  @options[:lowlevel_error_handler] = obj
end

#nakayoshi_fork(enabled = true) ⇒ Object

When enabled, Puma will GC 4 times before forking workers. If available (Ruby 2.7+), we will also call GC.compact. Not recommended for non-MRI Rubies.

Based on the work of Koichi Sasada and Aaron Patterson, this option may decrease memory utilization of preload-enabled cluster-mode Pumas. It will also increase time to boot and fork. See your logs for details on how much time this adds to your boot process. For most apps, it will be less than one second.


772
773
774
# File 'lib/puma/dsl.rb', line 772

def nakayoshi_fork(enabled=true)
  @options[:nakayoshi_fork] = enabled
end

#on_refork(&block) ⇒ Object

Note:

Cluster mode with `fork_worker` enabled only.

When `fork_worker` is enabled, code to run in Worker 0 before all other workers are re-forked from this process, after the server has temporarily stopped serving requests (once per complete refork cycle).

This can be used to trigger extra garbage-collection to maximize copy-on-write efficiency, or close any connections to remote servers (database, Redis, …) that were opened while the server was running.

This can be called multiple times to add several hooks.

Examples:

on_refork do
  3.times {GC.start}
end

520
521
522
523
# File 'lib/puma/dsl.rb', line 520

def on_refork(&block)
  @options[:before_refork] ||= []
  @options[:before_refork] << block
end

#on_restart(&block) ⇒ Object

Code to run before doing a restart. This code should close log files, database connections, etc.

This can be called multiple times to add code each time.

Examples:

on_restart do
  puts 'On restart...'
end

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

def on_restart(&block)
  @options[:on_restart] ||= []
  @options[:on_restart] << block
end

#on_worker_boot(&block) ⇒ Object

Note:

Cluster mode only.

Code to run in a worker when it boots to setup the process before booting the app.

This can be called multiple times to add several hooks.

Examples:

on_worker_boot do
  puts 'Before worker boot...'
end

449
450
451
452
# File 'lib/puma/dsl.rb', line 449

def on_worker_boot(&block)
  @options[:before_worker_boot] ||= []
  @options[:before_worker_boot] << block
end

#on_worker_fork(&block) ⇒ Object

Note:

Cluster mode only.

Code to run in the master right before a worker is started. The worker's index is passed as an argument.

This can be called multiple times to add several hooks.

Examples:

on_worker_fork do
  puts 'Before worker fork...'
end

481
482
483
484
# File 'lib/puma/dsl.rb', line 481

def on_worker_fork(&block)
  @options[:before_worker_fork] ||= []
  @options[:before_worker_fork] << block
end

#on_worker_shutdown(&block) ⇒ Object

Note:

Cluster mode only.

Code to run immediately before a worker shuts down (after it has finished processing HTTP requests). These hooks can block if necessary to wait for background operations unknown to Puma to finish before the process terminates.

This can be called multiple times to add several hooks.

Examples:

on_worker_shutdown do
  puts 'On worker shutdown...'
end

466
467
468
469
# File 'lib/puma/dsl.rb', line 466

def on_worker_shutdown(&block)
  @options[:before_worker_shutdown] ||= []
  @options[:before_worker_shutdown] << block
end

#out_of_band(&block) ⇒ Object

Code to run out-of-band when the worker is idle. These hooks run immediately after a request has finished processing and there are no busy threads on the worker. The worker doesn't accept new requests until this code finishes.

This hook is useful for running out-of-band garbage collection or scheduling asynchronous tasks to execute after a response.

This can be called multiple times to add several hooks.


534
535
536
537
# File 'lib/puma/dsl.rb', line 534

def out_of_band(&block)
  @options[:out_of_band] ||= []
  @options[:out_of_band] << block
end

#persistent_timeout(seconds) ⇒ Object

Define how long persistent connections can be idle before Puma closes them.


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

def persistent_timeout(seconds)
  @options[:persistent_timeout] = Integer(seconds)
end

#pidfile(path) ⇒ Object

Store the pid of the server in the file at “path”.

Examples:

pidfile '/u/apps/lolcat/tmp/pids/puma.pid'

280
281
282
# File 'lib/puma/dsl.rb', line 280

def pidfile(path)
  @options[:pidfile] = path.to_s
end

#plugin(name) ⇒ Object

Load the named plugin for use by this configuration


81
82
83
# File 'lib/puma/dsl.rb', line 81

def plugin(name)
  @plugins << @config.load_plugin(name)
end

#port(port, host = nil) ⇒ Object

Define the TCP port to bind to. Use bind for more advanced options.

Examples:

port 9292

191
192
193
194
# File 'lib/puma/dsl.rb', line 191

def port(port, host=nil)
  host ||= default_host
  bind "tcp://#{host}:#{port}"
end

#preload_app!(answer = true) ⇒ Object

Note:

Cluster mode only.

Preload the application before starting the workers; this conflicts with phased restart feature. This is off by default.

Examples:

preload_app!

555
556
557
# File 'lib/puma/dsl.rb', line 555

def preload_app!(answer=true)
  @options[:preload_app] = answer
end

#prune_bundler(answer = true) ⇒ Object

Note:

This is incompatible with preload_app!.

Note:

This is only supported for RubyGems 2.2+

This option is used to allow your app and its gems to be properly reloaded when not using preload.

When set, if Puma detects that it's been invoked in the context of Bundler, it will cleanup the environment and re-run itself outside the Bundler environment, but directly using the files that Bundler has setup.

This means that Puma is now decoupled from your Bundler context and when each worker loads, it will be loading a new Bundler context and thus can float around as the release dictates.

See also: extra_runtime_dependencies


589
590
591
# File 'lib/puma/dsl.rb', line 589

def prune_bundler(answer=true)
  @options[:prune_bundler] = answer
end

#queue_requests(answer = true) ⇒ Object

When set to true (the default), workers accept all requests and queue them before passing them to the handlers. When set to false, each worker process accepts exactly as many requests as it is configured to simultaneously handle.

Queueing requests generally improves performance. In some cases, such as a single threaded application, it may be better to ensure requests get balanced across workers.

Note that setting this to false disables HTTP keepalive and slow clients will occupy a handler thread while the request is being sent. A reverse proxy, such as nginx, can handle slow clients and queue requests before they reach Puma.


686
687
688
# File 'lib/puma/dsl.rb', line 686

def queue_requests(answer=true)
  @options[:queue_requests] = answer
end

#quiet(which = true) ⇒ Object

Disable request logging, if this isn't used it'll be enabled by default.

Examples:

quiet

288
289
290
# File 'lib/puma/dsl.rb', line 288

def quiet(which=true)
  @options[:log_requests] = !which
end

#rackup(path) ⇒ Object

Load path as a rackup file.

The default is “config.ru”.

Examples:

rackup '/u/apps/lolcat/config.ru'

310
311
312
# File 'lib/puma/dsl.rb', line 310

def rackup(path)
  @options[:rackup] ||= path.to_s
end

#raise_exception_on_sigterm(answer = true) ⇒ Object

By default, Puma will raise SignalException when SIGTERM is received. In environments where SIGTERM is something expected, you can suppress these with this option.

This can be useful for example in Kubernetes, where rolling restart is guaranteed usually on infrastructure level.

Examples:

raise_exception_on_sigterm false

602
603
604
# File 'lib/puma/dsl.rb', line 602

def raise_exception_on_sigterm(answer=true)
  @options[:raise_exception_on_sigterm] = answer
end

#restart_command(cmd) ⇒ Object

Command to use to restart Puma. This should be just how to load Puma itself (ie. 'ruby -Ilib bin/puma'), not the arguments to Puma, as those are the same as the original process.

Examples:

restart_command '/u/app/lolcat/bin/restart_puma'

272
273
274
# File 'lib/puma/dsl.rb', line 272

def restart_command(cmd)
  @options[:restart_cmd] = cmd.to_s
end

#set_default_host(host) ⇒ Object


63
64
65
# File 'lib/puma/dsl.rb', line 63

def set_default_host(host)
  @options[:default_host] = host
end

#set_remote_address(val = :socket) ⇒ Object

Control how the remote address of the connection is set. This is configurable because to calculate the true socket peer address a kernel syscall is required which for very fast rack handlers slows down the handling significantly.

There are 4 possible values:

  • :socket (the default) - read the peername from the socket using the

    syscall. This is the normal behavior.
    
  • :localhost - set the remote address to “127.0.0.1”

  • header: http_header - set the remote address to the value of the

    provided http header. For instance:
    `set_remote_address header: "X-Real-IP"`.
    Only the first word (as separated by spaces or comma)
    is used, allowing headers such as X-Forwarded-For
    to be used as well.
    
  • Any string - this allows you to hardcode remote address to any value

    you wish. Because Puma never uses this field anyway, it's
    format is entirely in your hands.
    

726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
# File 'lib/puma/dsl.rb', line 726

def set_remote_address(val=:socket)
  case val
  when :socket
    @options[:remote_address] = val
  when :localhost
    @options[:remote_address] = :value
    @options[:remote_address_value] = "127.0.0.1".freeze
  when String
    @options[:remote_address] = :value
    @options[:remote_address_value] = val
  when Hash
    if hdr = val[:header]
      @options[:remote_address] = :header
      @options[:remote_address_header] = "HTTP_" + hdr.upcase.tr("-", "_")
    else
      raise "Invalid value for set_remote_address - #{val.inspect}"
    end
  else
    raise "Invalid value for set_remote_address - #{val}"
  end
end

#shutdown_debug(val = true) ⇒ Object

When a shutdown is requested, the backtraces of all the threads will be written to $stdout. This can help figure out why shutdown is hanging.


693
694
695
# File 'lib/puma/dsl.rb', line 693

def shutdown_debug(val=true)
  @options[:shutdown_debug] = val
end

#ssl_bind(host, port, opts) ⇒ Object

Instead of “bind 'ssl://127.0.0.1:9292?key=key_path&cert=cert_path'” you can also use the “ssl_bind” option.

Examples:

ssl_bind '127.0.0.1', '9292', {
  cert: path_to_cert,
  key: path_to_key,
  ssl_cipher_filter: cipher_filter, # optional
  verify_mode: verify_mode,         # default 'none'
}

For JRuby additional keys are required: keystore & keystore_pass.

ssl_bind '127.0.0.1', '9292', {
  cert: path_to_cert,
  key: path_to_key,
  ssl_cipher_filter: cipher_filter, # optional
  verify_mode: verify_mode,         # default 'none'
  keystore: path_to_keystore,
  keystore_pass: password
}

378
379
380
381
382
383
384
385
386
387
388
389
390
391
# File 'lib/puma/dsl.rb', line 378

def ssl_bind(host, port, opts)
  verify = opts.fetch(:verify_mode, 'none').to_s
  no_tlsv1 = opts.fetch(:no_tlsv1, 'false')
  no_tlsv1_1 = opts.fetch(:no_tlsv1_1, 'false')
  ca_additions = "&ca=#{opts[:ca]}" if ['peer', 'force_peer'].include?(verify)

  if defined?(JRUBY_VERSION)
    keystore_additions = "keystore=#{opts[:keystore]}&keystore-pass=#{opts[:keystore_pass]}"
    bind "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}&#{keystore_additions}&verify_mode=#{verify}&no_tlsv1=#{no_tlsv1}&no_tlsv1_1=#{no_tlsv1_1}#{ca_additions}"
  else
    ssl_cipher_filter = "&ssl_cipher_filter=#{opts[:ssl_cipher_filter]}" if opts[:ssl_cipher_filter]
    bind "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}#{ssl_cipher_filter}&verify_mode=#{verify}&no_tlsv1=#{no_tlsv1}&no_tlsv1_1=#{no_tlsv1_1}#{ca_additions}"
  end
end

#state_path(path) ⇒ Object

Use path as the file to store the server info state. This is used by pumactl to query and control the server.

Examples:

state_path '/u/apps/lolcat/tmp/pids/puma.state'

398
399
400
# File 'lib/puma/dsl.rb', line 398

def state_path(path)
  @options[:state] = path.to_s
end

#state_permission(permission) ⇒ Object

Use permission to restrict permissions for the state file.

Examples:

state_permission 0600

406
407
408
# File 'lib/puma/dsl.rb', line 406

def state_permission(permission)
  @options[:state_permission] = permission
end

#stdout_redirect(stdout = nil, stderr = nil, append = false) ⇒ Object

Redirect STDOUT and STDERR to files specified. The append parameter specifies whether the output is appended, the default is false.

Examples:

stdout_redirect '/app/lolcat/log/stdout', '/app/lolcat/log/stderr'
stdout_redirect '/app/lolcat/log/stdout', '/app/lolcat/log/stderr', true

325
326
327
328
329
# File 'lib/puma/dsl.rb', line 325

def stdout_redirect(stdout=nil, stderr=nil, append=false)
  @options[:redirect_stdout] = stdout
  @options[:redirect_stderr] = stderr
  @options[:redirect_append] = append
end

#tag(string) ⇒ Object

Additional text to display in process listing.

If you do not specify a tag, Puma will infer it. If you do not want Puma to add a tag, use an empty string.

Examples:

tag 'app name'
tag ''

630
631
632
# File 'lib/puma/dsl.rb', line 630

def tag(string)
  @options[:tag] = string.to_s
end

#threads(min, max) ⇒ Object

Configure min to be the minimum number of threads to use to answer requests and max the maximum.

The default is “0, 16”.

Examples:

threads 0, 16
threads 5, 5

344
345
346
347
348
349
350
351
352
353
354
355
356
357
# File 'lib/puma/dsl.rb', line 344

def threads(min, max)
  min = Integer(min)
  max = Integer(max)
  if min > max
    raise "The minimum (#{min}) number of threads must be less than or equal to the max (#{max})"
  end

  if max < 1
    raise "The maximum number of threads (#{max}) must be greater than 0"
  end

  @options[:min_threads] = min
  @options[:max_threads] = max
end

#wait_for_less_busy_worker(val = 0.005) ⇒ Object

Attempts to route traffic to less-busy workers by causing them to delay listening on the socket, allowing workers which are not processing any requests to pick up new requests first.

Only works on MRI. For all other interpreters, this setting does nothing.


703
704
705
# File 'lib/puma/dsl.rb', line 703

def wait_for_less_busy_worker(val=0.005)
  @options[:wait_for_less_busy_worker] = val.to_f
end

#worker_boot_timeout(timeout) ⇒ Object

Note:

Cluster mode only.

Change the default worker timeout for booting.

If unspecified, this defaults to the value of worker_timeout.

@example:

worker_boot_timeout 60

662
663
664
# File 'lib/puma/dsl.rb', line 662

def worker_boot_timeout(timeout)
  @options[:worker_boot_timeout] = Integer(timeout)
end

#worker_shutdown_timeout(timeout) ⇒ Object

Note:

Cluster mode only.

Set the timeout for worker shutdown


669
670
671
# File 'lib/puma/dsl.rb', line 669

def worker_shutdown_timeout(timeout)
  @options[:worker_shutdown_timeout] = Integer(timeout)
end

#worker_timeout(timeout) ⇒ Object

Note:

Cluster mode only.

Verifies that all workers have checked in to the master process within the given timeout. If not the worker process will be restarted. This is not a request timeout, it is to protect against a hung or dead process. Setting this value will not protect against slow requests.

The minimum value is 6 seconds, the default value is 60 seconds.

Examples:

worker_timeout 60

644
645
646
647
648
649
650
651
652
653
# File 'lib/puma/dsl.rb', line 644

def worker_timeout(timeout)
  timeout = Integer(timeout)
  min = Const::WORKER_CHECK_INTERVAL

  if timeout <= min
    raise "The minimum worker_timeout must be greater than the worker reporting interval (#{min})"
  end

  @options[:worker_timeout] = timeout
end

#workers(count) ⇒ Object

Note:

Cluster mode only.

How many worker processes to run. Typically this is set to the number of available cores.

The default is 0.


416
417
418
# File 'lib/puma/dsl.rb', line 416

def workers(count)
  @options[:workers] = count.to_i
end