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,
  early_hints: nil,
  environment: 'development'.freeze,
  # Number of seconds to wait until we get the first data for the request
  first_data_timeout: 30,
  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,
  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,
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Configuration.


172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
# File 'lib/puma/configuration.rb', line 172

def initialize(user_options={}, default_options = {}, &block)
  default_options = self.puma_default_options.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

  if block
    configure(&block)
  end
end

Instance Attribute Details

#optionsObject (readonly)

Returns the value of attribute options.


190
191
192
# File 'lib/puma/configuration.rb', line 190

def options
  @options
end

#pluginsObject (readonly)

Returns the value of attribute plugins.


190
191
192
# File 'lib/puma/configuration.rb', line 190

def plugins
  @plugins
end

Class Method Details

.temp_pathObject


329
330
331
332
333
334
# File 'lib/puma/configuration.rb', line 329

def self.temp_path
  require 'tmpdir'

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

Instance Method Details

#appObject

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


285
286
287
288
289
290
291
292
293
294
295
# File 'lib/puma/configuration.rb', line 285

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)

274
275
276
# File 'lib/puma/configuration.rb', line 274

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

#clampObject

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


255
256
257
# File 'lib/puma/configuration.rb', line 255

def clamp
  @options.finalize_values
end

#config_filesObject


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

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

#configureObject


192
193
194
195
196
197
198
# File 'lib/puma/configuration.rb', line 192

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

#environmentObject

Return which environment we're running in


298
299
300
# File 'lib/puma/configuration.rb', line 298

def environment
  @options[:environment]
end

#final_optionsObject


325
326
327
# File 'lib/puma/configuration.rb', line 325

def final_options
  @options.final_options
end

#flattenObject


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

def flatten
  dup.flatten!
end

#flatten!Object


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

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

#initialize_copy(other) ⇒ Object


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

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

#loadObject


234
235
236
237
238
# File 'lib/puma/configuration.rb', line 234

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

  @options
end

#load_plugin(name) ⇒ Object


302
303
304
# File 'lib/puma/configuration.rb', line 302

def load_plugin(name)
  @plugins.create name
end

#puma_default_optionsObject


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

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

#puma_options_from_envObject


221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/puma/configuration.rb', line 221

def puma_options_from_env
  min = ENV['PUMA_MIN_THREADS'] || ENV['MIN_THREADS']
  max = ENV['PUMA_MAX_THREADS'] || ENV['MAX_THREADS']
  workers = ENV['WEB_CONCURRENCY']

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

#rackupObject


278
279
280
# File 'lib/puma/configuration.rb', line 278

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


309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
# File 'lib/puma/configuration.rb', line 309

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