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

Resulting configuration:

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::DefaultWorkerCheckInterval, ConfigDefault::DefaultWorkerShutdownTimeout, ConfigDefault::DefaultWorkerTimeout

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options, config) ⇒ DSL

Returns a new instance of DSL.



77
78
79
80
81
82
 
# File 'lib/puma/dsl.rb', line 77

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

  @plugins = []
end

Class Method Details

.ssl_bind_str(host, port, opts) ⇒ Object

convenience method so logic can be used in CI

See Also:



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

def self.ssl_bind_str(host, port, opts)
  verify = opts.fetch(:verify_mode, 'none').to_s

  tls_str =
    if opts[:no_tlsv1_1]  then '&no_tlsv1_1=true'
    elsif opts[:no_tlsv1] then '&no_tlsv1=true'
    else ''
    end

  ca_additions = "&ca=#{Puma::Util.escape(opts[:ca])}" if ['peer', 'force_peer'].include?(verify)

  backlog_str = opts[:backlog] ? "&backlog=#{Integer(opts[:backlog])}" : ''

  if defined?(JRUBY_VERSION)
    ssl_cipher_list = opts[:ssl_cipher_list] ?
      "&ssl_cipher_list=#{opts[:ssl_cipher_list]}" : nil

    keystore_additions = "keystore=#{opts[:keystore]}&keystore-pass=#{opts[:keystore_pass]}"

    "ssl://#{host}:#{port}?#{keystore_additions}#{ssl_cipher_list}" \
      "&verify_mode=#{verify}#{tls_str}#{ca_additions}#{backlog_str}"
  else
    ssl_cipher_filter = opts[:ssl_cipher_filter] ?
      "&ssl_cipher_filter=#{opts[:ssl_cipher_filter]}" : nil

    v_flags = (ary = opts[:verification_flags]) ?
      "&verification_flags=#{Array(ary).join ','}" : nil

    cert_flags = (cert = opts[:cert]) ? "cert=#{Puma::Util.escape(opts[:cert])}" : nil
    key_flags = (cert = opts[:key]) ? "&key=#{Puma::Util.escape(opts[:key])}" : nil

    "ssl://#{host}:#{port}?#{cert_flags}#{key_flags}" \
      "#{ssl_cipher_filter}&verify_mode=#{verify}#{tls_str}#{ca_additions}#{v_flags}#{backlog_str}"
  end
end

Instance Method Details

#_load_from(path) ⇒ Object 



84
85
86
87
88
89
90
91
 
# File 'lib/puma/dsl.rb', line 84

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

#_offer_plugins ⇒ Object 



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

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 }


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/puma/dsl.rb', line 167

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


610
611
612
613
 
# File 'lib/puma/dsl.rb', line 610

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

See Also:



145
146
147
148
149
150
151
 
# File 'lib/puma/dsl.rb', line 145

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


548
549
550
551
 
# File 'lib/puma/dsl.rb', line 548

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 not 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'

See Also:



225
226
227
228
 
# File 'lib/puma/dsl.rb', line 225

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

#bind_to_activated_sockets(bind = true) ⇒ Object

Bind to (systemd) activated sockets, regardless of configured binds.

Systemd can present sockets as file descriptors that are already opened. By default Puma will use these but only if it was explicitly told to bind to the socket. If not, it will close the activated sockets. This means all configuration is duplicated.

Binds can contain additional configuration, but only SSL config is really relevant since the unix and TCP socket options are ignored.

This means there is a lot of duplicated configuration for no additional value in most setups. This method tells the launcher to bind to all activated sockets, regardless of existing bind.

To clear configured binds, the value only can be passed. This will clear out any binds that may have been configured.

Examples:

Use any systemd activated sockets as well as configured binds

bind_to_activated_sockets

Only bind to systemd activated sockets, ignoring other binds

bind_to_activated_sockets 'only'


256
257
258
 
# File 'lib/puma/dsl.rb', line 256

def bind_to_activated_sockets(bind=true)
  @options[:bind_to_activated_sockets] = bind
end

#clean_thread_locals(which = true) ⇒ Object

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



283
284
285
 
# File 'lib/puma/dsl.rb', line 283

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

#clear_binds! ⇒ Object 



230
231
232
 
# File 'lib/puma/dsl.rb', line 230

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

#debug ⇒ Object

Show debugging info



376
377
378
 
# File 'lib/puma/dsl.rb', line 376

def debug
  @options[:debug] = true
end

#default_host ⇒ Object 



108
109
110
 
# File 'lib/puma/dsl.rb', line 108

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'


660
661
662
 
# File 'lib/puma/dsl.rb', line 660

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.

See Also:



292
293
294
 
# File 'lib/puma/dsl.rb', line 292

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

#early_hints(answer = true) ⇒ Object 



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

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'


303
304
305
 
# File 'lib/puma/dsl.rb', line 303

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']

See Also:

  • Launcher#extra_runtime_deps_directories


737
738
739
 
# File 'lib/puma/dsl.rb', line 737

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.

See Also:

  • Server.new


277
278
279
 
# File 'lib/puma/dsl.rb', line 277

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.

See Also:



315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/puma/dsl.rb', line 315

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.

Version:

  • 5.0.0



941
942
943
 
# File 'lib/puma/dsl.rb', line 941

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

#get(key, default = nil) ⇒ Object 



116
117
118
 
# File 'lib/puma/dsl.rb', line 116

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

#inject(&blk) ⇒ Object 



112
113
114
 
# File 'lib/puma/dsl.rb', line 112

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

#io_selector_backend(backend) ⇒ Object

Specify the backend for the IO selector.

Provided values will be passed directly to NIO::Selector.new, with the exception of :auto which will let nio4r choose the backend.

Check the documentation of NIO::Selector.backends for the list of valid options. Note that the available options on your system will depend on the operating system. If you want to use the pure Ruby backend (not recommended due to its comparatively low performance), set environment variable NIO4R_PURE to true.

The default is :auto.

See Also:



984
985
986
 
# File 'lib/puma/dsl.rb', line 984

def io_selector_backend(backend)
  @options[:io_selector_backend] = backend.to_sym
end

#load(file) ⇒ Object

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



194
195
196
197
 
# File 'lib/puma/dsl.rb', line 194

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

#log_formatter(&block) ⇒ Object 



414
415
416
 
# File 'lib/puma/dsl.rb', line 414

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

#log_requests(which = true) ⇒ Object

Enable request logging



370
371
372
 
# File 'lib/puma/dsl.rb', line 370

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


681
682
683
684
685
 
# File 'lib/puma/dsl.rb', line 681

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

#max_fast_inline(num_of_requests) ⇒ Object

The number of requests to attempt inline before sending a client back to the reactor to be subject to normal ordering.



965
966
967
 
# File 'lib/puma/dsl.rb', line 965

def max_fast_inline(num_of_requests)
  @options[:max_fast_inline] = Float(num_of_requests)
end

#mutate_stdout_and_stderr_to_sync_on_write(enabled = true) ⇒ Object 



988
989
990
 
# File 'lib/puma/dsl.rb', line 988

def mutate_stdout_and_stderr_to_sync_on_write(enabled=true)
  @options[:mutate_stdout_and_stderr_to_sync_on_write] = enabled
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.

See Also:

  • Cluster#nakayoshi_gc

Version:

  • 5.0.0



958
959
960
 
# File 'lib/puma/dsl.rb', line 958

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

Version:

  • 5.0.0



635
636
637
638
 
# File 'lib/puma/dsl.rb', line 635

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


337
338
339
340
 
# File 'lib/puma/dsl.rb', line 337

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


563
564
565
566
 
# File 'lib/puma/dsl.rb', line 563

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


595
596
597
598
 
# File 'lib/puma/dsl.rb', line 595

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


580
581
582
583
 
# File 'lib/puma/dsl.rb', line 580

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.



649
650
651
652
 
# File 'lib/puma/dsl.rb', line 649

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.

See Also:

  • Server.new


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

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'


356
357
358
 
# File 'lib/puma/dsl.rb', line 356

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

#plugin(name) ⇒ Object

Load the named plugin for use by this configuration



122
123
124
 
# File 'lib/puma/dsl.rb', line 122

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


264
265
266
267
 
# File 'lib/puma/dsl.rb', line 264

def port(port, host=nil)
  host ||= default_host
  bind URI::Generic.build(scheme: 'tcp', host: host, port: Integer(port)).to_s
end

#preload_app!(answer = true) ⇒ Object

Note:

Cluster mode only.

Preload the application before starting the workers; this conflicts with phased restart feature. On by default if your app uses more than 1 worker.

Examples:

preload_app!


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

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:



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

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.

See Also:



851
852
853
 
# File 'lib/puma/dsl.rb', line 851

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


364
365
366
 
# File 'lib/puma/dsl.rb', line 364

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

#rack_url_scheme(scheme = nil) ⇒ Object

Allows setting `env`. Only necessary if X-Forwarded-Proto is not being set by your proxy Normal values are 'http' or 'https'.



393
394
395
 
# File 'lib/puma/dsl.rb', line 393

def rack_url_scheme(scheme=nil)
  @options[:rack_url_scheme] = scheme
end

#rackup(path) ⇒ Object

Load path as a rackup file.

The default is “config.ru”.

Examples:

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


386
387
388
 
# File 'lib/puma/dsl.rb', line 386

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

See Also:



720
721
722
 
# File 'lib/puma/dsl.rb', line 720

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'


348
349
350
 
# File 'lib/puma/dsl.rb', line 348

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

#set_default_host(host) ⇒ Object 



104
105
106
 
# File 'lib/puma/dsl.rb', line 104

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 5 possible values:

  1. *:socket* (the default) - read the peername from the socket using the syscall. This is the normal behavior.

  2. *:localhost* - set the remote address to “127.0.0.1”

  3. **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.

  4. **proxy_protocol: :v1**- set the remote address to the value read from the HAproxy PROXY protocol, version 1. If the request does not have the PROXY protocol attached to it, will fall back to :socket

  5. **<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.



899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/puma/dsl.rb', line 899

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("-", "_")
    elsif protocol_version = val[:proxy_protocol]
      @options[:remote_address] = :proxy_protocol
      protocol_version = protocol_version.downcase.to_sym
      unless [:v1].include?(protocol_version)
        raise "Invalid value for proxy_protocol - #{protocol_version.inspect}"
      end
      @options[:remote_address_proxy_protocol] = protocol_version
    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.



859
860
861
 
# File 'lib/puma/dsl.rb', line 859

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

#silence_single_worker_warning ⇒ Object

Note:

Cluster mode only.

Disable warning message when running in cluster mode with a single worker.

Cluster mode has some overhead of running an additional 'control' process in order to manage the cluster. If only running a single worker it is likely not worth paying that overhead vs running in single mode with additional threads instead.

There are some scenarios where running cluster mode with a single worker may still be warranted and valid under certain deployment scenarios, see github.com/puma/puma/issues/2534

Moving from workers = 1 to workers = 0 will save 10-30% of memory use.



530
531
532
 
# File 'lib/puma/dsl.rb', line 530

def silence_single_worker_warning
  @options[:silence_single_worker_warning] = true
end

#ssl_bind(host, port, opts = {}) ⇒ Object

Instead of using bind and manually constructing a URI like:

bind 'ssl://127.0.0.1:9292?key=key_path&cert=cert_path'

you can use the this method.

When binding on localhost you don't need to specify cert and key, Puma will assume you are using the localhost gem and try to load the appropriate files.

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'
  verification_flags: flags,        # optional, not supported by JRuby
}

Using self-signed certificate with the localhost gem:

ssl_bind '127.0.0.1', '9292'

Alternatively, you can provide cert_pem and key_pem:

ssl_bind '127.0.0.1', '9292', {
  cert_pem: File.read(path_to_cert),
  key_pem: File.read(path_to_key),
}

For JRuby, two keys are required: keystore & keystore_pass

ssl_bind '127.0.0.1', '9292', {
  keystore: path_to_keystore,
  keystore_pass: password,
  ssl_cipher_list: cipher_list,     # optional
  verify_mode: verify_mode          # default 'none'
}


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

def ssl_bind(host, port, opts = {})
  add_pem_values_to_options_store(opts)
  bind self.class.ssl_bind_str(host, port, opts)
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'


490
491
492
 
# File 'lib/puma/dsl.rb', line 490

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

Version:

  • 5.0.0



500
501
502
 
# File 'lib/puma/dsl.rb', line 500

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


408
409
410
411
412
 
# File 'lib/puma/dsl.rb', line 408

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 ''


750
751
752
 
# File 'lib/puma/dsl.rb', line 750

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 the environment variables PUMA_MIN_THREADS / PUMA_MAX_THREADS (or MIN_THREADS / MAX_THREADS if the PUMA_ variables aren't set).

If these environment variables aren't set, the default is “0, 5” in MRI or “0, 16” for other interpreters.

Examples:

threads 0, 16
threads 5, 5


430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/puma/dsl.rb', line 430

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.

See Also:

Version:

  • 5.0.0



873
874
875
 
# File 'lib/puma/dsl.rb', line 873

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.

Examples:

worker_boot_timeout 60

See Also:

  • Cluster::Worker#ping_timeout


800
801
802
 
# File 'lib/puma/dsl.rb', line 800

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

#worker_check_interval(interval) ⇒ Object

Note:

Cluster mode only.

Change the default interval for checking workers.

The default value is 5 seconds.

Examples:

worker_check_interval 5

See Also:



763
764
765
 
# File 'lib/puma/dsl.rb', line 763

def worker_check_interval(interval)
  @options[:worker_check_interval] = Integer(interval)
end

#worker_culling_strategy(strategy) ⇒ Object

Note:

Cluster mode only.

Set the strategy for worker culling.

There are two possible values:

  1. *:youngest* - the youngest workers (i.e. the workers that were the most recently started) will be culled.

  2. *:oldest* - the oldest workers (i.e. the workers that were started the longest time ago) will be culled.

Examples:

worker_culling_strategy :oldest

See Also:



827
828
829
830
831
832
833
834
835
 
# File 'lib/puma/dsl.rb', line 827

def worker_culling_strategy(strategy)
  stategy = strategy.to_sym

  if ![:youngest, :oldest].include?(strategy)
    raise "Invalid value for worker_culling_strategy - #{stategy}"
  end

  @options[:worker_culling_strategy] = strategy
end

#worker_shutdown_timeout(timeout) ⇒ Object

Note:

Cluster mode only.

Set the timeout for worker shutdown.

See Also:

  • Cluster::Worker#term


809
810
811
 
# File 'lib/puma/dsl.rb', line 809

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

See Also:

  • Cluster::Worker#ping_timeout


779
780
781
782
783
784
785
786
787
788
 
# File 'lib/puma/dsl.rb', line 779

def worker_timeout(timeout)
  timeout = Integer(timeout)
  min = @options.fetch(:worker_check_interval, Puma::ConfigDefault::DefaultWorkerCheckInterval)

  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 the value of the environment variable WEB_CONCURRENCY if set, otherwise 0.

See Also:



512
513
514
 
# File 'lib/puma/dsl.rb', line 512

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