Class: Puma::Configuration

Inherits:
Object
  • Object
show all
Includes:
ConfigDefault
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

Constants included from ConfigDefault

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

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.


133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/puma/configuration.rb', line 133

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


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

def options
  @options
end

#pluginsObject (readonly)

Returns the value of attribute plugins


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

def plugins
  @plugins
end

Class Method Details

.temp_pathObject


290
291
292
293
294
295
# File 'lib/puma/configuration.rb', line 290

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.


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

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

  if @options[:log_requests]
    require 'puma/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)

243
244
245
# File 'lib/puma/configuration.rb', line 243

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


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

def clamp
  @options.finalize_values
end

#config_filesObject


209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/puma/configuration.rb', line 209

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

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

  first_default_file = %W(config/puma/#{environment_str}.rb config/puma.rb).find do |f|
    File.exist?(f)
  end

  [first_default_file]
end

#configureObject


153
154
155
156
157
158
159
# File 'lib/puma/configuration.rb', line 153

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

#default_max_threadsObject


176
177
178
# File 'lib/puma/configuration.rb', line 176

def default_max_threads
  Puma.mri? ? 5 : 16
end

#environmentObject

Return which environment we're running in


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

def environment
  @options[:environment]
end

#environment_strObject


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

def environment_str
  environment.respond_to?(:call) ? environment.call : environment
end

#flattenObject


167
168
169
# File 'lib/puma/configuration.rb', line 167

def flatten
  dup.flatten!
end

#flatten!Object


171
172
173
174
# File 'lib/puma/configuration.rb', line 171

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

#initialize_copy(other) ⇒ Object


161
162
163
164
165
# File 'lib/puma/configuration.rb', line 161

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

#loadObject


203
204
205
206
207
# File 'lib/puma/configuration.rb', line 203

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

  @options
end

#load_plugin(name) ⇒ Object


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

def load_plugin(name)
  @plugins.create name
end

#puma_default_optionsObject


180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
# File 'lib/puma/configuration.rb', line 180

def puma_default_options
  {
    :min_threads => Integer(ENV['PUMA_MIN_THREADS'] || ENV['MIN_THREADS'] || 0),
    :max_threads => Integer(ENV['PUMA_MAX_THREADS'] || ENV['MAX_THREADS'] || default_max_threads),
    :log_requests => false,
    :debug => false,
    :binds => ["tcp://#{DefaultTCPHost}:#{DefaultTCPPort}"],
    :workers => Integer(ENV['WEB_CONCURRENCY'] || 0),
    :mode => :http,
    :worker_timeout => DefaultWorkerTimeout,
    :worker_boot_timeout => DefaultWorkerTimeout,
    :worker_shutdown_timeout => DefaultWorkerShutdownTimeout,
    :remote_address => :socket,
    :tag => method(:infer_tag),
    :environment => -> { ENV['RACK_ENV'] || ENV['RAILS_ENV'] || "development" },
    :rackup => DefaultRackup,
    :logger => STDOUT,
    :persistent_timeout => Const::PERSISTENT_TIMEOUT,
    :first_data_timeout => Const::FIRST_DATA_TIMEOUT,
    :raise_exception_on_sigterm => true
  }
end

#rackupObject


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

def rackup
  @options[:rackup]
end

#run_hooks(key, arg, events) ⇒ Object


279
280
281
282
283
284
285
286
287
288
# File 'lib/puma/configuration.rb', line 279

def run_hooks(key, arg, events)
  @options.all_of(key).each do |b|
    begin
      b.call arg
    rescue => e
      events.log "WARNING hook #{key} failed with exception (#{e.class}) #{e.message}"
      events.debug e.backtrace.join("\n")
    end
  end
end