puma 4.3.12 → 5.6.9

data/docs/stats.md

@@ -0,0 +1,142 @@
+## Accessing stats
+
+Stats can be accessed in two ways:
+
+### control server
+
+`$ pumactl stats` or `GET /stats`
+
+[Read more about `pumactl` and the control server in the README.](https://github.com/puma/puma#controlstatus-server).
+
+### Puma.stats
+
+`Puma.stats` produces a JSON string. `Puma.stats_hash` produces a ruby hash.
+
+#### in single mode
+
+Invoke `Puma.stats` anywhere in runtime, e.g. in a rails initializer:
+
+```ruby
+# config/initializers/puma_stats.rb
+
+Thread.new do
+  loop do
+    sleep 30
+    puts Puma.stats
+  end
+end
+```
+
+#### in cluster mode
+
+Invoke `Puma.stats` from the master process
+
+```ruby
+# config/puma.rb
+
+before_fork do
+  Thread.new do
+    loop do
+      puts Puma.stats
+      sleep 30
+    end
+  end
+end
+```
+
+
+## Explanation of stats
+
+`Puma.stats` returns different information and a different structure depending on if Puma is in single vs. cluster mode. There is one top-level attribute that is common to both modes:
+
+* started_at: when Puma was started
+
+### single mode and individual workers in cluster mode
+
+When Puma runs in single mode, these stats are available at the top level. When Puma runs in cluster mode, these stats are available within the `worker_status` array in a hash labeled `last_status`, in an array of hashes where one hash represents each worker.
+
+* backlog: requests that are waiting for an available thread to be available. if this is above 0, you need more capacity [always true?]
+* running: how many threads are running
+* pool_capacity: the number of requests that the server is capable of taking right now. For example, if the number is 5, then it means there are 5 threads sitting idle ready to take a request. If one request comes in, then the value would be 4 until it finishes processing. If the minimum threads allowed is zero, this number will still have a maximum value of the maximum threads allowed.
+* max_threads: the maximum number of threads Puma is configured to spool per worker
+* requests_count: the number of requests this worker has served since starting
+
+
+### cluster mode
+
+* phase: which phase of restart the process is in, during [phased restart](https://github.com/puma/puma/blob/master/docs/restart.md)
+* workers: ??
+* booted_workers: how many workers currently running?
+* old_workers: ??
+* worker_status: array of hashes of info for each worker (see below)
+
+### worker status
+
+* started_at: when the worker started
+* pid: the process id of the worker process
+* index: each worker gets a number. if Puma is configured to have 3 workers, then this will be 0, 1, or 2
+* booted: if it's done booting [?]
+* last_checkin: Last time the worker responded to the master process' heartbeat check.
+* last_status: a hash of info about the worker's state handling requests. See the explanation for this in "single mode and individual workers in cluster mode" section above.
+
+
+## Examples
+
+Here are two example stats hashes produced by `Puma.stats`:
+
+### single
+
+```json
+{
+  "started_at": "2021-01-14T07:12:35Z",
+  "backlog": 0,
+  "running": 5,
+  "pool_capacity": 5,
+  "max_threads": 5,
+  "requests_count": 3
+}
+```
+
+### cluster
+
+```json
+{
+  "started_at": "2021-01-14T07:09:17Z",
+  "workers": 2,
+  "phase": 0,
+  "booted_workers": 2,
+  "old_workers": 0,
+  "worker_status": [
+    {
+      "started_at": "2021-01-14T07:09:24Z",
+      "pid": 64136,
+      "index": 0,
+      "phase": 0,
+      "booted": true,
+      "last_checkin": "2021-01-14T07:11:09Z",
+      "last_status": {
+        "backlog": 0,
+        "running": 5,
+        "pool_capacity": 5,
+        "max_threads": 5,
+        "requests_count": 2
+      }
+    },
+    {
+      "started_at": "2021-01-14T07:09:24Z",
+      "pid": 64137,
+      "index": 1,
+      "phase": 0,
+      "booted": true,
+      "last_checkin": "2021-01-14T07:11:09Z",
+      "last_status": {
+        "backlog": 0,
+        "running": 5,
+        "pool_capacity": 5,
+        "max_threads": 5,
+        "requests_count": 1
+      }
+    }
+  ]
+}
+```

data/docs/systemd.md

@@ -1,21 +1,18 @@
 # systemd
 
-[systemd](https://www.freedesktop.org/wiki/Software/systemd/) is a
-commonly available init system (PID 1) on many Linux distributions. It
-offers process monitoring (including automatic restarts) and other
-useful features for running Puma in production.
+[systemd](https://www.freedesktop.org/wiki/Software/systemd/) is a commonly
+available init system (PID 1) on many Linux distributions. It offers process
+monitoring (including automatic restarts) and other useful features for running
+Puma in production.
 
 ## Service Configuration
 
-Below is a sample puma.service configuration file for systemd, which
-can be copied or symlinked to /etc/systemd/system/puma.service, or if
-desired, using an application or instance specific name.
+Below is a sample puma.service configuration file for systemd, which can be
+copied or symlinked to `/etc/systemd/system/puma.service`, or if desired, using
+an application or instance-specific name.
 
-Note that this uses the systemd preferred "simple" type where the
-start command remains running in the foreground (does not fork and
-exit). See also, the
-[Alternative Forking Configuration](#alternative-forking-configuration)
-below.
+Note that this uses the systemd preferred "simple" type where the start command
+remains running in the foreground (does not fork and exit).
 
 ~~~~ ini
 [Unit]
@@ -26,14 +23,21 @@ After=network.target
 # Requires=puma.socket
 
 [Service]
-# Foreground process (do not use --daemon in ExecStart or config.rb)
-Type=simple
+# Puma supports systemd's `Type=notify` and watchdog service
+# monitoring, if the [sd_notify](https://github.com/agis/ruby-sdnotify) gem is installed,
+# as of Puma 5.1 or later.
+# On earlier versions of Puma or JRuby, change this to `Type=simple` and remove
+# the `WatchdogSec` line.
+Type=notify
+
+# If your Puma process locks up, systemd's watchdog will restart it within seconds.
+WatchdogSec=10
 
 # Preferably configure a non-privileged user
 # User=
 
-# The path to the your application code root directory.
-# Also replace the "<YOUR_APP_PATH>" place holders below with this path.
+# The path to your application code root directory.
+# Also replace the "<YOUR_APP_PATH>" placeholders below with this path.
 # Example /home/username/myapp
 WorkingDirectory=<YOUR_APP_PATH>
 
@@ -59,33 +63,31 @@ Restart=always
 WantedBy=multi-user.target
 ~~~~
 
-See [systemd.exec](https://www.freedesktop.org/software/systemd/man/systemd.exec.html)
+See
+[systemd.exec](https://www.freedesktop.org/software/systemd/man/systemd.exec.html)
 for additional details.
 
 ## Socket Activation
 
-systemd and puma also support socket activation, where systemd opens
-the listening socket(s) in advance and provides them to the puma
-master process on startup. Among other advantages, this keeps
-listening sockets open across puma restarts and achieves graceful
-restarts, including when upgraded puma, and is compatible with both
-clustered mode and application preload.
-
-**Note:** Any wrapper scripts which `exec`, or other indirections in
-`ExecStart`, may result in activated socket file descriptors being closed
-before they reach the puma master process. For example, if using `bundle exec`,
-pass the `--keep-file-descriptors` flag. `bundle exec` can be avoided by using a
-`puma` executable generated by `bundle binstubs puma`. This is tracked in
-[#1499].
-
-**Note:** Socket activation doesn't currently work on jruby. This is
-tracked in [#1367].
-
-To use socket activation, configure one or more `ListenStream` sockets
-in a companion `*.socket` unit file. Also uncomment the associated
-`Requires` directive for the socket unit in the service file (see
-above.) Here is a sample puma.socket, matching the ports used in the
-above puma.service:
+systemd and Puma also support socket activation, where systemd opens the
+listening socket(s) in advance and provides them to the Puma master process on
+startup. Among other advantages, this keeps listening sockets open across puma
+restarts and achieves graceful restarts, including when upgraded Puma, and is
+compatible with both clustered mode and application preload.
+
+**Note:** Any wrapper scripts which `exec`, or other indirections in `ExecStart`
+may result in activated socket file descriptors being closed before reaching the
+puma master process. For example, if using `bundle exec`, pass the
+`--keep-file-descriptors` flag. `bundle exec` can be avoided by using a `puma`
+executable generated by `bundle binstubs puma`. This is tracked in [#1499].
+
+**Note:** Socket activation doesn't currently work on JRuby. This is tracked in
+[#1367].
+
+Configure one or more `ListenStream` sockets in a companion `*.socket` unit file
+to use socket activation. Also, uncomment the associated `Requires` directive
+for the socket unit in the service file (see above.) Here is a sample
+puma.socket, matching the ports used in the above puma.service:
 
 ~~~~ ini
 [Unit]
@@ -108,26 +110,42 @@ Backlog=1024
 WantedBy=sockets.target
 ~~~~
 
-See [systemd.socket](https://www.freedesktop.org/software/systemd/man/systemd.socket.html)
+See
+[systemd.socket](https://www.freedesktop.org/software/systemd/man/systemd.socket.html)
 for additional configuration details.
 
-Note that the above configurations will work with Puma in either
-single process or cluster mode.
+Note that the above configurations will work with Puma in either single process
+or cluster mode.
 
 ### Sockets and symlinks
 
-When using releases folders, you should set the socket path using the
-shared folder path (ex. `/srv/projet/shared/tmp/puma.sock`), not the
-release folder path (`/srv/projet/releases/1234/tmp/puma.sock`).
+When using releases folders, you should set the socket path using the shared
+folder path (ex. `/srv/projet/shared/tmp/puma.sock`), not the release folder
+path (`/srv/projet/releases/1234/tmp/puma.sock`).
 
 Puma will detect the release path socket as different than the one provided by
-systemd and attempt to bind it again, resulting in the exception
- `There is already a server bound to:`.
+systemd and attempt to bind it again, resulting in the exception `There is
+already a server bound to:`.
+
+### Binding
+
+By default, you need to configure Puma to have binds matching with all
+ListenStream statements. Any mismatched systemd ListenStreams will be closed by
+Puma.
+
+To automatically bind to all activated sockets, the option
+`--bind-to-activated-sockets` can be used. This matches the config DSL
+`bind_to_activated_sockets` statement. This will cause Puma to create a bind
+automatically for any activated socket. When systemd socket activation is not
+enabled, this option does nothing.
+
+This also accepts an optional argument `only` (DSL: `'only'`) to discard any
+binds that's not socket activated.
 
 ## Usage
 
-Without socket activation, use `systemctl` as root (e.g. via `sudo`) as
-with other system services:
+Without socket activation, use `systemctl` as root (i.e., via `sudo`) as with
+other system services:
 
 ~~~~ sh
 # After installing or making changes to puma.service
@@ -136,35 +154,35 @@ systemctl daemon-reload
 # Enable so it starts on boot
 systemctl enable puma.service
 
-# Initial start up.
+# Initial startup.
 systemctl start puma.service
 
 # Check status
 systemctl status puma.service
 
-# A normal restart. Warning: listeners sockets will be closed
+# A normal restart. Warning: listener's sockets will be closed
 # while a new puma process initializes.
 systemctl restart puma.service
 ~~~~
 
-With socket activation, several but not all of these commands should
-be run for both socket and service:
+With socket activation, several but not all of these commands should be run for
+both socket and service:
 
 ~~~~ sh
 # After installing or making changes to either puma.socket or
 # puma.service.
 systemctl daemon-reload
 
-# Enable both socket and service so they start on boot.  Alternatively
-# you could leave puma.service disabled and systemd will start it on
-# first use (with startup lag on first request)
+# Enable both socket and service, so they start on boot.  Alternatively
+# you could leave puma.service disabled, and systemd will start it on
+# the first use (with startup lag on the first request)
 systemctl enable puma.socket puma.service
 
-# Initial start up. The Requires directive (see above) ensures the
+# Initial startup. The Requires directive (see above) ensures the
 # socket is started before the service.
 systemctl start puma.socket puma.service
 
-# Check status of both socket and service.
+# Check the status of both socket and service.
 systemctl status puma.socket puma.service
 
 # A "hot" restart, with systemd keeping puma.socket listening and
@@ -177,8 +195,8 @@ systemctl restart puma.service
 systemctl restart puma.socket puma.service
 ~~~~
 
-Here is sample output from `systemctl status` with both service and
-socket running:
+Here is sample output from `systemctl status` with both service and socket
+running:
 
 ~~~~
 ● puma.socket - Puma HTTP Server Accept Sockets
@@ -209,76 +227,14 @@ Apr 07 08:40:19 hx puma[28320]: * Activated ssl://0.0.0.0:9234?key=key.pem&cert=
 Apr 07 08:40:19 hx puma[28320]: Use Ctrl-C to stop
 ~~~~
 
-## Alternative Forking Configuration
-
-Other systems/tools might expect or need puma to be run as a
-"traditional" forking server, for example so that the `pumactl`
-command can be used directly and outside of systemd for
-stop/start/restart. This use case is incompatible with systemd socket
-activation, so it should not be configured. Below is an alternative
-puma.service config sample, using `Type=forking` and the `--daemon`
-flag in `ExecStart`. Here systemd is playing a role more equivalent to
-SysV init.d, where it is responsible for starting Puma on boot
-(multi-user.target) and stopping it on shutdown, but is not performing
-continuous restarts. Therefore running Puma in cluster mode, where the
-master can restart workers, is highly recommended. See the systemd
-[Restart] directive for details.
-
-~~~~ ini
-[Unit]
-Description=Puma HTTP Forking Server
-After=network.target
-
-[Service]
-# Background process configuration (use with --daemon in ExecStart)
-Type=forking
-
-# Preferably configure a non-privileged user
-# User=
-
-# The path to the puma application root
-# Also replace the "<WD>" place holders below with this path.
-WorkingDirectory=
-
-# The command to start Puma
-# (replace "<WD>" below)
-ExecStart=bundle exec puma -C <WD>/shared/puma.rb --daemon
-
-# The command to stop Puma
-# (replace "<WD>" below)
-ExecStop=bundle exec pumactl -S <WD>/shared/tmp/pids/puma.state stop
-
-# Path to PID file so that systemd knows which is the master process
-PIDFile=<WD>/shared/tmp/pids/puma.pid
-
-# Should systemd restart puma?
-# Use "no" (the default) to ensure no interference when using
-# stop/start/restart via `pumactl`.  The "on-failure" setting might
-# work better for this purpose, but you must test it.
-# Use "always" if only `systemctl` is used for start/stop/restart, and
-# reconsider if you actually need the forking config.
-Restart=no
-
-# `puma_ctl restart` wouldn't work without this. It's because `pumactl`
-# changes PID on restart and systemd stops the service afterwards
-# because of the PID change. This option prevents stopping after PID
-# change.
-RemainAfterExit=yes
-
-[Install]
-WantedBy=multi-user.target
-~~~~
-
 ### capistrano3-puma
 
-By default,
-[capistrano3-puma](https://github.com/seuros/capistrano-puma) uses
-`pumactl` for deployment restarts, outside of systemd.  To learn the
-exact commands that this tool would use for `ExecStart` and
-`ExecStop`, use the following `cap` commands in dry-run mode, and
-update from the above forking service configuration accordingly. Note
-also that the configured `User` should likely be the same as the
-capistrano3-puma `:puma_user` option.
+By default, [capistrano3-puma](https://github.com/seuros/capistrano-puma) uses
+`pumactl` for deployment restarts outside of systemd. To learn the exact
+commands that this tool would use for `ExecStart` and `ExecStop`, use the
+following `cap` commands in dry-run mode, and update from the above forking
+service configuration accordingly. Note also that the configured `User` should
+likely be the same as the capistrano3-puma `:puma_user` option.
 
 ~~~~ sh
 stage=production # or different stage, as needed
@@ -288,3 +244,4 @@ cap $stage puma:stop  --dry-run
 
 [Restart]: https://www.freedesktop.org/software/systemd/man/systemd.service.html#Restart=
 [#1367]: https://github.com/puma/puma/issues/1367
+[#1499]: https://github.com/puma/puma/issues/1499

data/ext/puma_http11/PumaHttp11Service.java

@@ -1,18 +1,16 @@
 package puma;
 
 import java.io.IOException;
-        
+
 import org.jruby.Ruby;
 import org.jruby.runtime.load.BasicLibraryService;
 
 import org.jruby.puma.Http11;
-import org.jruby.puma.IOBuffer;
 import org.jruby.puma.MiniSSL;
 
-public class PumaHttp11Service implements BasicLibraryService { 
+public class PumaHttp11Service implements BasicLibraryService {
     public boolean basicLoad(final Ruby runtime) throws IOException {
         Http11.createHttp11(runtime);
-        IOBuffer.createIOBuffer(runtime);
         MiniSSL.createMiniSSL(runtime);
         return true;
     }

data/ext/puma_http11/ext_help.h

@@ -2,7 +2,7 @@
 #define ext_help_h
 
 #define RAISE_NOT_NULL(T) if(T == NULL) rb_raise(rb_eArgError, "%s", "NULL found for " # T " when shouldn't be.");
-#define DATA_GET(from,type,name) Data_Get_Struct(from,type,name); RAISE_NOT_NULL(name);
+#define DATA_GET(from,type,data_type,name) TypedData_Get_Struct(from,type,data_type,name); RAISE_NOT_NULL(name);
 #define REQUIRE_TYPE(V, T) if(TYPE(V) != T) rb_raise(rb_eTypeError, "%s", "Wrong argument type for " # V " required " # T);
 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
 

data/ext/puma_http11/extconf.rb

@@ -1,31 +1,51 @@
 require 'mkmf'
 
 dir_config("puma_http11")
+
 if $mingw && RUBY_VERSION >= '2.4'
-  append_cflags '-D_FORTIFY_SOURCE=2'
-  append_ldflags '-fstack-protector'
+  append_cflags  '-fstack-protector-strong -D_FORTIFY_SOURCE=2'
+  append_ldflags '-fstack-protector-strong -l:libssp.a'
   have_library 'ssp'
 end
 
 unless ENV["DISABLE_SSL"]
-  dir_config("openssl")
+  # don't use pkg_config('openssl') if '--with-openssl-dir' is used
+  has_openssl_dir = dir_config('openssl').any?
+  found_pkg_config = !has_openssl_dir && pkg_config('openssl')
 
-  if %w'crypto libeay32'.find {|crypto| have_library(crypto, 'BIO_read')} and
+  found_ssl = if (!$mingw || RUBY_VERSION >= '2.4') && found_pkg_config
+    puts 'using OpenSSL pkgconfig (openssl.pc)'
+    true
+  elsif %w'crypto libeay32'.find {|crypto| have_library(crypto, 'BIO_read')} &&
       %w'ssl ssleay32'.find {|ssl| have_library(ssl, 'SSL_CTX_new')}
+    true
+  else
+    puts '** Puma will be compiled without SSL support'
+    false
+  end
 
+  if found_ssl
     have_header "openssl/bio.h"
 
     # below is  yes for 1.0.2 & later
-    have_func  "DTLS_method"                  , "openssl/ssl.h"
+    have_func  "DTLS_method"                           , "openssl/ssl.h"
+
+    # below are yes for 1.1.0 & later
+    have_func  "TLS_server_method"                     , "openssl/ssl.h"
+    have_func  "SSL_CTX_set_min_proto_version(NULL, 0)", "openssl/ssl.h"
+
+    have_func  "X509_STORE_up_ref"
+    have_func "SSL_CTX_set_ecdh_auto(NULL, 0)"         , "openssl/ssl.h"
 
-    # below are yes for 1.1.0 & later, may need to check func rather than macro
-    # with versions after 1.1.1
-    have_func  "TLS_server_method"            , "openssl/ssl.h"
-    have_macro "SSL_CTX_set_min_proto_version", "openssl/ssl.h"
+    # below exists in 1.1.0 and later, but isn't documented until 3.0.0
+    have_func "SSL_CTX_set_dh_auto(NULL, 0)"           , "openssl/ssl.h"
+
+    # below is yes for 3.0.0 & later
+    have_func "SSL_get1_peer_certificate"              , "openssl/ssl.h"
 
     # Random.bytes available in Ruby 2.5 and later, Random::DEFAULT deprecated in 3.0
     if Random.respond_to?(:bytes)
-      $defs.push("-DHAVE_RANDOM_BYTES")
+      $defs.push "-DHAVE_RANDOM_BYTES"
       puts "checking for Random.bytes... yes"
     else
       puts "checking for Random.bytes... no"
@@ -33,4 +53,18 @@ unless ENV["DISABLE_SSL"]
   end
 end
 
+if ENV["MAKE_WARNINGS_INTO_ERRORS"]
+  # Make all warnings into errors
+  # Except `implicit-fallthrough` since most failures comes from ragel state machine generated code
+  if respond_to?(:append_cflags, true) # Ruby 2.5 and later
+    append_cflags(config_string('WERRORFLAG') || '-Werror')
+    append_cflags '-Wno-implicit-fallthrough'
+  else
+    # flag may not exist on some platforms, -Werror may not be defined on some platforms, but
+    # works with all in current CI
+    $CFLAGS << " #{config_string('WERRORFLAG') || '-Werror'}"
+    $CFLAGS << ' -Wno-implicit-fallthrough'
+  end
+end
+
 create_makefile("puma/puma_http11")