Class: Puma::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/puma/configuration.rb

Overview

The main configuration class of Puma.

It can be initialized with a set of “user” options and “default” options. Defaults will be merged with ‘Configuration.puma_default_options`.

This class works together with 2 main other classes the ‘UserFileDefaultOptions` which stores configuration options in order so the precedence is that user set configuration wins over “file” based configuration wins over “default” configuration. These configurations are set via the `DSL` class. This class powers the Puma config file syntax and does double duty as a configuration DSL used by the `Puma::CLI` and Puma rack handler.

It also handles loading plugins.

Note:

‘:port` and `:host` are not valid keys. By the time they make it to the configuration options they are expected to be incorporated into a `:binds` key. Under the hood the DSL maps `port` and `host` calls to `:binds`

config = Configuration.new({}) do |user_config, file_config, default_config|
  user_config.port 3003
end
config.load
puts config.options[:port]
# => 3003

It is expected that ‘load` is called on the configuration instance after setting config. This method expands any values in `config_file` and puts them into the correct configuration option hash.

Once all configuration is complete it is expected that ‘clamp` will be called on the instance. This will expand any procs stored under “default” values. This is done because an environment variable may have been modified while loading configuration files.

Defined Under Namespace

Classes: ConfigMiddleware

Constant Summary collapse

DEFAULTS = 
{
  auto_trim_time: 30,
  binds: ['tcp://0.0.0.0:9292'.freeze],
  clean_thread_locals: false,
  debug: false,
  enable_keep_alives: true,
  early_hints: nil,
  environment: 'development'.freeze,
  # Number of seconds to wait until we get the first data for the request.
  first_data_timeout: 30,
  # Number of seconds to wait until the next request before shutting down.
  idle_timeout: nil,
  io_selector_backend: :auto,
  log_requests: false,
  logger: STDOUT,
  # How many requests to attempt inline before sending a client back to
  # the reactor to be subject to normal ordering. The idea here is that
  # we amortize the cost of going back to the reactor for a well behaved
  # but very "greedy" client across 10 requests. This prevents a not
  # well behaved client from monopolizing the thread forever.
  max_fast_inline: 10,
  max_threads: Puma.mri? ? 5 : 16,
  min_threads: 0,
  mode: :http,
  mutate_stdout_and_stderr_to_sync_on_write: true,
  out_of_band: [],
  # Number of seconds for another request within a persistent session.
  persistent_timeout: 20,
  queue_requests: true,
  rackup: 'config.ru'.freeze,
  raise_exception_on_sigterm: true,
  reaping_time: 1,
  remote_address: :socket,
  silence_single_worker_warning: false,
  silence_fork_callback_warning: false,
  tag: File.basename(Dir.getwd),
  tcp_host: '0.0.0.0'.freeze,
  tcp_port: 9292,
  wait_for_less_busy_worker: 0.005,
  worker_boot_timeout: 60,
  worker_check_interval: 5,
  worker_culling_strategy: :youngest,
  worker_shutdown_timeout: 30,
  worker_timeout: 60,
  workers: 0,
  http_content_length_limit: nil
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_options = {}, default_options = {}, env = ENV, &block) ⇒ Configuration

Returns a new instance of Configuration.



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

def initialize(user_options={}, default_options = {}, env = ENV, &block)
  default_options = self.puma_default_options(env).merge(default_options)

  @options     = UserFileDefaultOptions.new(user_options, default_options)
  @plugins     = PluginLoader.new
  @user_dsl    = DSL.new(@options.user_options, self)
  @file_dsl    = DSL.new(@options.file_options, self)
  @default_dsl = DSL.new(@options.default_options, self)

  if !@options[:prune_bundler]
    default_options[:preload_app] = (@options[:workers] > 1) && Puma.forkable?
  end

  @puma_bundler_pruned = env.key? 'PUMA_BUNDLER_PRUNED'

  if block
    configure(&block)
  end
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



196
197
198
 
# File 'lib/puma/configuration.rb', line 196

def options
  @options
end

#plugins ⇒ Object (readonly)

Returns the value of attribute plugins.



196
197
198
 
# File 'lib/puma/configuration.rb', line 196

def plugins
  @plugins
end

Class Method Details

.temp_path ⇒ Object 



340
341
342
343
344
345
 
# File 'lib/puma/configuration.rb', line 340

def self.temp_path
  require 'tmpdir'

  t = (Time.now.to_f * 1000).to_i
  "#{Dir.tmpdir}/puma-status-#{t}-#{$$}"
end

Instance Method Details

#app ⇒ Object

Load the specified rackup file, pull options from the rackup file, and set @app.



296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/puma/configuration.rb', line 296

def app
  found = options[:app] || load_rackup

  if @options[:log_requests]
    require_relative 'commonlogger'
    logger = @options[:logger]
    found = CommonLogger.new(found, logger)
  end

  ConfigMiddleware.new(self, found)
end

#app_configured? ⇒ Boolean

Indicate if there is a properly configured app

Returns:

  • (Boolean) 


285
286
287
 
# File 'lib/puma/configuration.rb', line 285

def app_configured?
  @options[:app] || File.exist?(rackup)
end

#clamp ⇒ Object

Call once all configuration (included from rackup files) is loaded to flesh out any defaults



266
267
268
 
# File 'lib/puma/configuration.rb', line 266

def clamp
  @options.finalize_values
end

#config_files ⇒ Object 



251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/puma/configuration.rb', line 251

def config_files
  files = @options.all_of(:config_files)

  return [] if files == ['-']
  return files if files.any?

  first_default_file = %W(config/puma/#{@options[:environment]}.rb config/puma.rb).find do |f|
    File.exist?(f)
  end

  [first_default_file]
end

#configure ⇒ Object 



198
199
200
201
202
203
204
 
# File 'lib/puma/configuration.rb', line 198

def configure
  yield @user_dsl, @file_dsl, @default_dsl
ensure
  @user_dsl._offer_plugins
  @file_dsl._offer_plugins
  @default_dsl._offer_plugins
end

#environment ⇒ Object

Return which environment we’re running in



309
310
311
 
# File 'lib/puma/configuration.rb', line 309

def environment
  @options[:environment]
end

#final_options ⇒ Object 



336
337
338
 
# File 'lib/puma/configuration.rb', line 336

def final_options
  @options.final_options
end

#flatten ⇒ Object 



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

def flatten
  dup.flatten!
end

#flatten! ⇒ Object 



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

def flatten!
  @options = @options.flatten
  self
end

#initialize_copy(other) ⇒ Object 



206
207
208
209
210
 
# File 'lib/puma/configuration.rb', line 206

def initialize_copy(other)
  @conf        = nil
  @cli_options = nil
  @options     = @options.dup
end

#load ⇒ Object 



245
246
247
248
249
 
# File 'lib/puma/configuration.rb', line 245

def load
  config_files.each { |config_file| @file_dsl._load_from(config_file) }

  @options
end

#load_plugin(name) ⇒ Object 



313
314
315
 
# File 'lib/puma/configuration.rb', line 313

def load_plugin(name)
  @plugins.create name
end

#puma_default_options(env = ENV) ⇒ Object 



221
222
223
224
225
 
# File 'lib/puma/configuration.rb', line 221

def puma_default_options(env = ENV)
  defaults = DEFAULTS.dup
  puma_options_from_env(env).each { |k,v| defaults[k] = v if v }
  defaults
end

#puma_options_from_env(env = ENV) ⇒ Object 



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/puma/configuration.rb', line 227

def puma_options_from_env(env = ENV)
  min = env['PUMA_MIN_THREADS'] || env['MIN_THREADS']
  max = env['PUMA_MAX_THREADS'] || env['MAX_THREADS']
  workers = if env['WEB_CONCURRENCY'] == 'auto'
    require_processor_counter
    ::Concurrent.available_processor_count
  else
    env['WEB_CONCURRENCY']
  end

  {
    min_threads: min && min != "" && Integer(min),
    max_threads: max && max != "" && Integer(max),
    workers: workers && workers != "" && Integer(workers),
    environment: env['APP_ENV'] || env['RACK_ENV'] || env['RAILS_ENV'],
  }
end

#rackup ⇒ Object 



289
290
291
 
# File 'lib/puma/configuration.rb', line 289

def rackup
  @options[:rackup]
end

#run_hooks(key, arg, log_writer, hook_data = nil) ⇒ Object

Parameters:

  • key (:Symbol) —

    hook to run

  • arg (Launcher, Int) —

    ‘:on_restart` passes Launcher



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/puma/configuration.rb', line 320

def run_hooks(key, arg, log_writer, hook_data = nil)
  @options.all_of(key).each do |b|
    begin
      if Array === b
        hook_data[b[1]] ||= Hash.new
        b[0].call arg, hook_data[b[1]]
      else
        b.call arg
      end
    rescue => e
      log_writer.log "WARNING hook #{key} failed with exception (#{e.class}) #{e.message}"
      log_writer.debug e.backtrace.join("\n")
    end
  end
end