Class: Puma::Launcher
Relationships & Source Files | |
Inherits: | Object |
Defined in: | lib/puma/launcher.rb |
Overview
Launcher
is the single entry point for starting a ::Puma
server based on user configuration. It is responsible for taking user supplied arguments and resolving them with configuration in config/puma.rb
or config/puma/<env>.rb
.
It is responsible for either launching a cluster of ::Puma
workers or a single puma server.
Constant Summary
-
KEYS_NOT_TO_PERSIST_IN_STATE =
# File 'lib/puma/launcher.rb', line 18[ :logger, :lowlevel_error_handler, :before_worker_shutdown, :before_worker_boot, :before_worker_fork, :after_worker_boot, :before_fork, :on_restart ]
Class Method Summary
-
.new(conf, launcher_args = {}) ⇒ Launcher
constructor
Returns an instance of
Launcher
.
Instance Attribute Summary
- #binder readonly
- #config readonly
- #events readonly
- #options readonly
- #restart_dir readonly
- #clustered? ⇒ Boolean readonly private
- #prune_bundler readonly private
- #prune_bundler? ⇒ Boolean readonly private
Instance Method Summary
- #close_binder_listeners
-
#connected_port
Return which tcp port the launcher is using, if it’s using TCP.
-
#delete_pidfile
Delete the configured pidfile.
-
#halt
Begin async shutdown of the server.
-
#phased_restart
Begin a phased restart if supported.
-
#restart
Begin async restart of the server.
- #restart_args
-
#run
Run the server.
-
#stats
Return stats about the server.
-
#stop
Begin async shutdown of the server gracefully.
-
#write_state
Write a state file that can be used by pumactl to control the server.
- #dependencies_and_files_to_require_after_prune private
- #environment private
- #extra_runtime_deps_directories private
- #generate_restart_data private
- #graceful_stop private
- #log(str) private
- #log_thread_status private
- #puma_wild_location private
- #reload_worker_directory private
- #require_paths_for_gem(gem_spec) private
- #require_rubygems_min_version!(min_version, feature) private
- #restart! private
- #set_process_title private
- #set_rack_environment private
- #setup_signals private
- #spec_for_gem(gem_name) private
- #title private
- #unsupported(str) private
-
#write_pid
private
If configured, write the pid of the current process out to a file.
Constructor Details
.new(conf, launcher_args = {}) ⇒ Launcher
Returns an instance of Launcher
conf
A Configuration
object indicating how to run the server.
launcher_args
A Hash that currently has one required key :events
, this is expected to hold an object similar to an Events.stdio, this object will be responsible for broadcasting Puma’s internal state to a logging destination. An optional key :argv
can be supplied, this should be an array of strings, these arguments are re-used when restarting the puma server.
Examples:
conf = Puma::Configuration.new do |user_config|
user_config.threads 1, 10
user_config.app do |env|
[200, {}, ["hello world"]]
end
end
Puma::Launcher.new(conf, events: Puma::Events.stdio).run
# File 'lib/puma/launcher.rb', line 43
def initialize(conf, launcher_args={}) @runner = nil @events = launcher_args[:events] || Events::DEFAULT @argv = launcher_args[:argv] || [] @original_argv = @argv.dup @config = conf @binder = Binder.new(@events) @binder.import_from_env @environment = conf.environment # Advertise the Configuration Puma.cli_config = @config if defined?(Puma.cli_config) @config.load @options = @config. @config.clamp @events.formatter = Events::PidFormatter.new if clustered? @events.formatter = [:log_formatter] if @options[:log_formatter] generate_restart_data if clustered? && !Process.respond_to?(:fork) unsupported "worker mode not supported on #{RUBY_ENGINE} on this platform" end if @options[:daemon] && Puma.windows? unsupported 'daemon mode not supported on Windows' end Dir.chdir(@restart_dir) prune_bundler if prune_bundler? @environment = @options[:environment] if @options[:environment] set_rack_environment if clustered? @options[:logger] = @events @runner = Cluster.new(self, @events) else @runner = Single.new(self, @events) end Puma.stats_object = @runner @status = :run end
Instance Attribute Details
#binder (readonly)
[ GitHub ]# File 'lib/puma/launcher.rb', line 95
attr_reader :binder, :events, :config, :, :restart_dir
#clustered? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/puma/launcher.rb', line 311
def clustered? (@options[:workers] || 0) > 0 end
#config (readonly)
[ GitHub ]# File 'lib/puma/launcher.rb', line 95
attr_reader :binder, :events, :config, :, :restart_dir
#events (readonly)
[ GitHub ]# File 'lib/puma/launcher.rb', line 95
attr_reader :binder, :events, :config, :, :restart_dir
#options (readonly)
[ GitHub ]# File 'lib/puma/launcher.rb', line 95
attr_reader :binder, :events, :config, :, :restart_dir
#prune_bundler (readonly, private)
[ GitHub ]# File 'lib/puma/launcher.rb', line 277
def prune_bundler return unless defined?(Bundler) require_rubygems_min_version!(Gem::Version.new("2.2"), "prune_bundler") unless puma_wild_location log "! Unable to prune Bundler environment, continuing" return end deps, dirs = dependencies_and_files_to_require_after_prune log '* Pruning Bundler environment' home = ENV['GEM_HOME'] Bundler.with_clean_env do ENV['GEM_HOME'] = home ENV['PUMA_BUNDLER_PRUNED'] = '1' args = [Gem.ruby, puma_wild_location, '-I', dirs.join(':'), deps.join(',')] + @original_argv # Ruby 2.0+ defaults to true which breaks socket activation args += [{:close_others => false}] Kernel.exec(*args) end end
#prune_bundler? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/puma/launcher.rb', line 360
def prune_bundler? @options[:prune_bundler] && clustered? && !@options[:preload_app] end
#restart_dir (readonly)
[ GitHub ]Instance Method Details
#close_binder_listeners
[ GitHub ]# File 'lib/puma/launcher.rb', line 204
def close_binder_listeners @binder.close_listeners end
#connected_port
Return which tcp port the launcher is using, if it’s using TCP
# File 'lib/puma/launcher.rb', line 191
def connected_port @binder.connected_port end
#delete_pidfile
Delete the configured pidfile
# File 'lib/puma/launcher.rb', line 121
def delete_pidfile path = @options[:pidfile] File.unlink(path) if path && File.exist?(path) end
#dependencies_and_files_to_require_after_prune (private)
[ GitHub ]# File 'lib/puma/launcher.rb', line 249
def dependencies_and_files_to_require_after_prune puma = spec_for_gem("puma") deps = puma.runtime_dependencies.map do |d| "#{d.name}:#{spec_for_gem(d.name).version}" end [deps, require_paths_for_gem(puma) + extra_runtime_deps_directories] end
#environment (private)
[ GitHub ]# File 'lib/puma/launcher.rb', line 356
def environment @environment end
#extra_runtime_deps_directories (private)
[ GitHub ]# File 'lib/puma/launcher.rb', line 259
def extra_runtime_deps_directories Array(@options[:extra_runtime_dependencies]).map do |d_name| if (spec = spec_for_gem(d_name)) require_paths_for_gem(spec) else log "* Could not load extra dependency: #{d_name}" nil end end.flatten.compact end
#generate_restart_data (private)
[ GitHub ]# File 'lib/puma/launcher.rb', line 364
def generate_restart_data if dir = @options[:directory] @restart_dir = dir elsif Puma.windows? # I guess the value of PWD is garbage on windows so don't bother # using it. @restart_dir = Dir.pwd # Use the same trick as unicorn, namely favor PWD because # it will contain an unresolved symlink, useful for when # the pwd is /data/releases/current. elsif dir = ENV['PWD'] s_env = File.stat(dir) s_pwd = File.stat(Dir.pwd) if s_env.ino == s_pwd.ino and (Puma.jruby? or s_env.dev == s_pwd.dev) @restart_dir = dir end end @restart_dir ||= Dir.pwd # if $0 is a file in the current directory, then restart # it the same, otherwise add -S on there because it was # picked up in PATH. # if File.exist?($0) arg0 = [Gem.ruby, $0] else arg0 = [Gem.ruby, "-S", $0] end # Detect and reinject -Ilib from the command line, used for testing without bundler # cruby has an expanded path, jruby has just "lib" lib = File. "lib" arg0[1,0] = ["-I", lib] if [lib, "lib"].include?($LOAD_PATH[0]) if defined? Puma::WILD_ARGS @restart_argv = arg0 + Puma::WILD_ARGS + @original_argv else @restart_argv = arg0 + @original_argv end end
#graceful_stop (private)
[ GitHub ]#halt
Begin async shutdown of the server
# File 'lib/puma/launcher.rb', line 127
def halt @status = :halt @runner.halt end
#log(str) (private)
[ GitHub ]# File 'lib/puma/launcher.rb', line 307
def log(str) @events.log str end
#log_thread_status (private)
[ GitHub ]# File 'lib/puma/launcher.rb', line 326
def log_thread_status Thread.list.each do |thread| log "Thread TID-#{thread.object_id.to_s(36)} #{thread['label']}" logstr = "Thread: TID-#{thread.object_id.to_s(36)}" logstr += " #{thread.name}" if thread.respond_to?(:name) log logstr if thread.backtrace log thread.backtrace.join("\n") else log "<no backtrace available>" end end end
#phased_restart
Begin a phased restart if supported
#puma_wild_location (private)
[ GitHub ]# File 'lib/puma/launcher.rb', line 270
def puma_wild_location puma = spec_for_gem("puma") dirs = require_paths_for_gem(puma) puma_lib_dir = dirs.detect { |x| File.exist? File.join(x, '../bin/puma-wild') } File. (File.join(puma_lib_dir, "../bin/puma-wild")) end
#reload_worker_directory (private)
[ GitHub ]# File 'lib/puma/launcher.rb', line 223
def reload_worker_directory @runner.reload_worker_directory if @runner.respond_to?(:reload_worker_directory) end
#require_paths_for_gem(gem_spec) (private)
[ GitHub ]# File 'lib/puma/launcher.rb', line 303
def require_paths_for_gem(gem_spec) gem_spec.full_require_paths end
#require_rubygems_min_version!(min_version, feature) (private)
[ GitHub ]# File 'lib/puma/launcher.rb', line 468
def require_rubygems_min_version!(min_version, feature) return if min_version <= Gem::Version.new(Gem::VERSION) raise "#{feature} is not supported on your version of RubyGems. " \ "You must have RubyGems #{min_version}+ to use this feature." end
#restart
Begin async restart of the server
# File 'lib/puma/launcher.rb', line 139
def restart @status = :restart @runner.restart end
#restart! (private)
[ GitHub ]# File 'lib/puma/launcher.rb', line 227
def restart! @config.run_hooks :on_restart, self if Puma.jruby? close_binder_listeners require 'puma/jruby_restart' JRubyRestart.chdir_exec(@restart_dir, restart_args) elsif Puma.windows? close_binder_listeners argv = restart_args Dir.chdir(@restart_dir) Kernel.exec(*argv) else argv = restart_args Dir.chdir(@restart_dir) argv += [@binder.redirects_for_restart] Kernel.exec(*argv) end end
#restart_args
[ GitHub ]# File 'lib/puma/launcher.rb', line 195
def restart_args cmd = @options[:restart_cmd] if cmd cmd.split(' ') + @original_argv else @restart_argv end end
#run
Run the server. This blocks until the server is stopped
# File 'lib/puma/launcher.rb', line 154
def run previous_env = if defined?(Bundler) env = Bundler::ORIGINAL_ENV.dup # add -rbundler/setup so we load from Gemfile when restarting bundle = "-rbundler/setup" env["RUBYOPT"] = [env["RUBYOPT"], bundle].join(" ").lstrip unless env["RUBYOPT"].to_s.include?(bundle) env else ENV.to_h end @config.clamp @config.plugins.fire_starts self setup_signals set_process_title @runner.run case @status when :halt log "* Stopping immediately!" when :run, :stop graceful_stop when :restart log "* Restarting..." ENV.replace(previous_env) @runner.before_restart restart! when :exit # nothing end @binder.close_unix_paths end
#set_process_title (private)
[ GitHub ]#set_rack_environment (private)
[ GitHub ]# File 'lib/puma/launcher.rb', line 351
def set_rack_environment @options[:environment] = environment ENV['RACK_ENV'] = environment end
#setup_signals (private)
[ GitHub ]# File 'lib/puma/launcher.rb', line 409
def setup_signals begin Signal.trap "SIGUSR2" do restart end rescue Exception log "*** SIGUSR2 not implemented, signal based restart unavailable!" end unless Puma.jruby? begin Signal.trap "SIGUSR1" do phased_restart end rescue Exception log "*** SIGUSR1 not implemented, signal based restart unavailable!" end end begin Signal.trap "SIGTERM" do graceful_stop raise(SignalException, "SIGTERM") if @options[:raise_exception_on_sigterm] end rescue Exception log "*** SIGTERM not implemented, signal based gracefully stopping unavailable!" end begin Signal.trap "SIGINT" do stop end rescue Exception log "*** SIGINT not implemented, signal based gracefully stopping unavailable!" end begin Signal.trap "SIGHUP" do if @runner.redirected_io? @runner.redirect_io else stop end end rescue Exception log "*** SIGHUP not implemented, signal based logs reopening unavailable!" end begin Signal.trap "SIGINFO" do log_thread_status end rescue Exception # Not going to log this one, as SIGINFO is *BSD only and would be pretty annoying # to see this constantly on Linux. end end
#spec_for_gem(gem_name) (private)
[ GitHub ]# File 'lib/puma/launcher.rb', line 299
def spec_for_gem(gem_name) Bundler.rubygems.loaded_specs(gem_name) end
#stats
Return stats about the server
# File 'lib/puma/launcher.rb', line 98
def stats @runner.stats end
#stop
Begin async shutdown of the server gracefully
# File 'lib/puma/launcher.rb', line 133
def stop @status = :stop @runner.stop end
#title (private)
[ GitHub ]#unsupported(str) (private)
# File 'lib/puma/launcher.rb', line 315
def unsupported(str) @events.error(str) raise UnsupportedOption end
#write_pid (private)
If configured, write the pid of the current process out to a file.
# File 'lib/puma/launcher.rb', line 212
def write_pid path = @options[:pidfile] return unless path File.open(path, 'w') { |f| f.puts Process.pid } cur = Process.pid at_exit do delete_pidfile if cur == Process.pid end end
#write_state
Write a state file that can be used by pumactl to control the server