puma 5.1.1 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a6a1bfd1d41d66c8aef6c52a2a043a0e537a1ddb51e20c778bb2da023d9a964
-  data.tar.gz: d256171ae36d0c5d1646ecbea4476df3e1bf7fbba5415c6ca6672eacbc5bd995
+  metadata.gz: d702fffe078664ed49a411a31910737455c819d6acadd3875c89e00368f68dd8
+  data.tar.gz: 972f53b07a05363ff839b6f176150bdf4cbc19f7445601ad10f41e9bcaf73af2
 SHA512:
-  metadata.gz: 9d6e9dfa206d98785ff62d7c03cd5193d5745918d684bf2a7d78027294ae345eb34d32d819ffda08ba34629cda589b0138faf1fdc91606a0cbab352615c859f3
-  data.tar.gz: 6775ccd4eaf9abdda6191c07b7d668588b813dbc96b71496b98cb0ee2ffefb94dd3db068159d8a2c746e5bcc4e4456fa6c4f12c721b66f6c5bed13b9e19718e2
+  metadata.gz: fff3451918f8e34324189c0fa6c161baa1860181920f934541a4db9b5e484d20edae74dd9ac33baa3c14514c75d052cbb5d42539f371bf33cca82e644aa52c57
+  data.tar.gz: 86c7ba8cb909bedb1dceb259d28677295a71e66b53ed1f1fb6ce324ddab0dbe05c5469aaa120f50f7427cc257d6fa6b6898c7b0346810871f1fceb2ad25bab93

data/History.md

@@ -1,8 +1,38 @@
+## 5.2.1 / 2021-02-05
+
+* Bugfixes
+  * Fix TCP cork/uncork operations to work with ssl clients ([#2550])
+  * Require rack/common_logger explicitly if :verbose is true ([#2547])
+  * MiniSSL::Socket#write - use data.byteslice(wrote..-1) ([#2543])
+  * Set `@env[CONTENT_LENGTH]` value as string. ([#2549])
+
+## 5.2.0 / 2021-01-27
+
+* Features
+  * 10x latency improvement for MRI on ssl connections by reducing overhead ([#2519])
+  * Add option to specify the desired IO selector backend for libev ([#2522])
+  * Add ability to set OpenSSL verification flags (MRI only) ([#2490])
+  * Uses `flush` after writing messages to avoid mutating $stdout and $stderr using `sync=true` ([#2486])
+
+* Bugfixes
+  * MiniSSL - Update dhparam to 2048 bit for use with SSL_CTX_set_tmp_dh ([#2535])
+  * Change 'Goodbye!' message to be output after listeners are closed ([#2529])
+  * Fix ssl bind logging with 0.0.0.0 and localhost ([#2533])
+  * Fix compiler warnings, but skipped warnings related to ragel state machine generated code ([#1953])
+  * Fix phased restart errors related to nio4r gem when using the Puma control server ([#2516])
+  * Add `#string` method to `Puma::NullIO` ([#2520])
+  * Fix binding via Rack handler to IPv6 addresses ([#2521])
+
+* Refactor
+  * Refactor MiniSSL::Context on MRI, fix MiniSSL::Socket#write ([#2519])
+  * Remove `Server#read_body` ([#2531])
+  * Fail build if compiling extensions raises warnings on GH Actions, configurable via `MAKE_WARNINGS_INTO_ERRORS` ([#1953])
+
 ## 5.1.1 / 2020-12-10
 
-* Bugfixes 
+* Bugfixes
   * Fix over eager matching against banned header names ([#2510])
-  
+
 ## 5.1.0 / 2020-11-30
 
 * Features
@@ -98,7 +128,7 @@
   * Daemonization has been removed without replacement. ([#2170])
   * Changed #connected_port to #connected_ports ([#2076])
   * Configuration: `environment` is read from `RAILS_ENV`, if `RACK_ENV` can't be found ([#2022])
-  * Log binding on http:// for TCP bindings to make it clickable
+  * Log binding on http:// for TCP bindings to make it clickable  ([#2300])
 
 * Bugfixes
   * Fix JSON loading issues on phased-restarts ([#2269])
@@ -144,16 +174,16 @@
   * Support parallel tests in verbose progress reporting ([#2223])
   * Refactor error handling in server accept loop ([#2239])
 
-## 4.3.6 / 2020-09-05
+## 4.3.7 / 2020-11-30
 
 * Bugfixes
-  * Explicitly include ctype.h to fix compilation warning and build error on macOS with Xcode 12 ([#2304])
-  * Don't require json at boot ([#2269])
+  * Backport set CONTENT_LENGTH for chunked requests (Originally: [#2287], backport: [#2496])
 
-## 4.3.7 / 2020-11-30
+## 4.3.6 / 2020-09-05
 
 * Bugfixes
-  * Backport set CONTENT_LENGTH for chunked requests (Originally: [#2287], backport: [#2496])
+  * Explicitly include ctype.h to fix compilation warning and build error on macOS with Xcode 12 ([#2304])
+  * Don't require json at boot ([#2269])
 
 ## 4.3.4/4.3.5 and 3.12.5/3.12.6 / 2020-05-22
 
@@ -1672,7 +1702,23 @@ be added back in a future date when a java Puma::MiniSSL is added.
 * Bugfixes
   * Your bugfix goes here <Most recent on the top, like GitHub> (#Github Number)
 
-[#2510]:https://github.com/puma/puma/pull/2510     "PR by @micke"
+[#2550]:https://github.com/puma/puma/pull/2550     "PR by @MSP-Greg, merged 2021-02-05"
+[#2547]:https://github.com/puma/puma/pull/2547     "PR by @wildmaples, merged 2021-02-03"
+[#2543]:https://github.com/puma/puma/pull/2543     "PR by @MSP-Greg, merged 2021-02-01"
+[#2549]:https://github.com/puma/puma/pull/2549     "PR by @nmb, merged 2021-02-04"
+[#2519]:https://github.com/puma/puma/pull/2519     "PR by @MSP-Greg, merged 2021-01-26"
+[#2522]:https://github.com/puma/puma/pull/2522     "PR by @jcmfernandes, merged 2021-01-12"
+[#2490]:https://github.com/puma/puma/pull/2490     "PR by @Bonias, merged 2020-12-07"
+[#2486]:https://github.com/puma/puma/pull/2486     "PR by @ccverak, merged 2020-12-02"
+[#2535]:https://github.com/puma/puma/pull/2535     "PR by @MSP-Greg, merged 2021-01-27"
+[#2529]:https://github.com/puma/puma/pull/2529     "PR by @MSP-Greg, merged 2021-01-24"
+[#2533]:https://github.com/puma/puma/pull/2533     "PR by @MSP-Greg, merged 2021-01-24"
+[#1953]:https://github.com/puma/puma/issues/1953   "Issue by @nateberkopec, closed 2020-12-01"
+[#2516]:https://github.com/puma/puma/pull/2516     "PR by @cjlarose, merged 2020-12-17"
+[#2520]:https://github.com/puma/puma/pull/2520     "PR by @dentarg, merged 2021-01-04"
+[#2521]:https://github.com/puma/puma/pull/2521     "PR by @ojab, merged 2021-01-04"
+[#2531]:https://github.com/puma/puma/pull/2531     "PR by @wjordan, merged 2021-01-19"
+[#2510]:https://github.com/puma/puma/pull/2510     "PR by @micke, merged 2020-12-10"
 [#2472]:https://github.com/puma/puma/pull/2472     "PR by @ccverak, merged 2020-11-02"
 [#2438]:https://github.com/puma/puma/pull/2438     "PR by @ekohl, merged 2020-10-26"
 [#2406]:https://github.com/puma/puma/pull/2406     "PR by @fdel15, merged 2020-10-19"
@@ -1736,6 +1782,7 @@ be added back in a future date when a java Puma::MiniSSL is added.
 [#2170]:https://github.com/puma/puma/pull/2170     "PR by @nateberkopec, merged 2020-03-10"
 [#2076]:https://github.com/puma/puma/pull/2076     "PR by @drews256, merged 2020-02-27"
 [#2022]:https://github.com/puma/puma/pull/2022     "PR by @olleolleolle, merged 2019-11-11"
+[#2300]:https://github.com/puma/puma/pull/2300     "PR by @alexeevit, merged 2020-07-06"
 [#2269]:https://github.com/puma/puma/pull/2269     "PR by @MSP-Greg, merged 2020-08-31"
 [#2312]:https://github.com/puma/puma/pull/2312     "PR by @MSP-Greg, merged 2020-07-20"
 [#2338]:https://github.com/puma/puma/issues/2338   "Issue by @micahhainlinestitchfix, closed 2020-08-18"
@@ -1771,8 +1818,8 @@ be added back in a future date when a java Puma::MiniSSL is added.
 [#2124]:https://github.com/puma/puma/pull/2124     "PR by @wjordan, merged 2020-04-14"
 [#2223]:https://github.com/puma/puma/pull/2223     "PR by @wjordan, merged 2020-04-20"
 [#2239]:https://github.com/puma/puma/pull/2239     "PR by @wjordan, merged 2020-05-15"
-[#2304]:https://github.com/puma/puma/issues/2304   "Issue by @mpeltomaa, closed 2020-09-05"
 [#2496]:https://github.com/puma/puma/pull/2496     "PR by @TheRusskiy, merged 2020-11-30"
+[#2304]:https://github.com/puma/puma/issues/2304   "Issue by @mpeltomaa, closed 2020-09-05"
 [#2132]:https://github.com/puma/puma/issues/2132   "Issue by @bmclean, closed 2020-02-28"
 [#2010]:https://github.com/puma/puma/pull/2010     "PR by @nateberkopec, merged 2019-10-07"
 [#2012]:https://github.com/puma/puma/pull/2012     "PR by @headius, merged 2019-10-07"
@@ -2119,7 +2166,7 @@ be added back in a future date when a java Puma::MiniSSL is added.
 [#646]:https://github.com/puma/puma/pull/646       "PR by @mkonecny, merged 2015-02-05"
 [#630]:https://github.com/puma/puma/issues/630     "Issue by @jelmd, closed 2015-01-20"
 [#622]:https://github.com/puma/puma/issues/622     "Issue by @sabamotto, closed 2015-01-20"
-[#583]:https://github.com/puma/puma/issues/583     "Issue by @emq, closed 2015-01-20"
+[#583]:https://github.com/puma/puma/issues/583     "Issue by @rwojsznis, closed 2015-01-20"
 [#586]:https://github.com/puma/puma/issues/586     "Issue by @ponchik, closed 2015-01-20"
 [#359]:https://github.com/puma/puma/issues/359     "Issue by @natew, closed 2014-12-13"
 [#633]:https://github.com/puma/puma/issues/633     "Issue by @joevandyk, closed 2015-01-20"

data/README.md

@@ -212,6 +212,23 @@ Disable TLS v1 with the `no_tlsv1` option:
 $ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert&no_tlsv1=true'
 ```
 
+#### Controlling OpenSSL Verification Flags
+
+To enable verification flags offered by OpenSSL, use `verification_flags` (not available for JRuby):
+
+```
+$ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert&verification_flags=PARTIAL_CHAIN'
+```
+
+You can also set multiple verification flags (by separating them with coma):
+
+```
+$ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert&verification_flags=PARTIAL_CHAIN,CRL_CHECK'
+```
+
+List of available flags: `USE_CHECK_TIME`, `CRL_CHECK`, `CRL_CHECK_ALL`, `IGNORE_CRITICAL`, `X509_STRICT`, `ALLOW_PROXY_CERTS`, `POLICY_CHECK`, `EXPLICIT_POLICY`, `INHIBIT_ANY`, `INHIBIT_MAP`, `NOTIFY_POLICY`, `EXTENDED_CRL_SUPPORT`, `USE_DELTAS`, `CHECK_SS_SIGNATURE`, `TRUSTED_FIRST`, `SUITEB_128_LOS_ONLY`, `SUITEB_192_LOS`, `SUITEB_128_LOS`, `PARTIAL_CHAIN`, `NO_ALT_CHAINS`, `NO_CHECK_TIME`
+(see https://www.openssl.org/docs/manmaster/man3/X509_VERIFY_PARAM_set_hostflags.html#VERIFICATION-FLAGS).
+
 ### Control/Status Server
 
 Puma has a built-in status and control app that can be used to query and control Puma.
@@ -238,7 +255,7 @@ You can also provide a configuration file with the `-C` (or `--config`) flag:
 $ puma -C /path/to/config
 ```
 
-If no configuration file is specified, Puma will look for a configuration file at `config/puma.rb`. If an environment is specified, either via the `-e` and `--environment` flags, or through the `RACK_ENV` or the `RAILS_ENV` environment variables, Puma looks for configuration at `config/puma/<environment_name>.rb`.
+If no configuration file is specified, Puma will look for a configuration file at `config/puma.rb`. If an environment is specified, either via the `-e` and `--environment` flags, or through the `RACK_ENV` or the `RAILS_ENV` environment variables, Puma first looks for configuration at `config/puma/<environment_name>.rb`, and then falls back to `config/puma.rb`.
 
 If you want to prevent Puma from looking for a configuration file in those locations, provide a dash as the argument to the `-C` (or `--config`) flag:
 
@@ -266,6 +283,7 @@ Some platforms do not support all Puma features.
 
   * **JRuby**, **Windows**: server sockets are not seamless on restart, they must be closed and reopened. These platforms have no way to pass descriptors into a new process that is exposed to Ruby. Also, cluster mode is not supported due to a lack of fork(2).
   * **Windows**: Cluster mode is not supported due to a lack of fork(2).
+  * **Kubernetes**: The way Kubernetes handles pod shutdowns interacts poorly with server processes implementing graceful shutdown, like Puma. See the [kubernetes section of the documentation](docs/kubernetes.md) for more details.
 
 ## Known Bugs
 
@@ -291,6 +309,10 @@ reliability in production environments:
 * [rc.d](docs/jungle/rc.d/README.md)
 * [systemd](docs/systemd.md)
 
+Community guides: 
+
+* [Deploying Puma on OpenBSD using relayd and httpd](https://gist.github.com/anon987654321/4532cf8d6c59c1f43ec8973faa031103)
+
 ## Community Extensions
 
 ### Plugins

data/docs/compile_options.md

@@ -1,19 +1,19 @@
 # Compile Options
 
-There provide some `cflags` to change Puma's default configuration for C.
+There are some `cflags` provided to change Puma's default configuration for its C extension.
 
-## Query String
+## Query String, `PUMA_QUERY_STRING_MAX_LENGTH`
 
-By default, the max length of `QUERY_STRING` is `1024 * 10`. But you may want to adjust it to allow accept large queries in the GET requests.
+By default, the max length of `QUERY_STRING` is `1024 * 10`. But you may want to adjust it to allow accept larger queries in GET requests.
 
-For manual install
+For manual install, pass the `PUMA_QUERY_STRING_MAX_LENGTH` option like this:
 
 ```
 gem install puma -- --with-cflags="-D PUMA_QUERY_STRING_MAX_LENGTH=64000"
 ```
 
-For bundler config
+For Bundler, use its configuration system:
 
 ```
-bundle config build.puma --with-cflags="-D PUMA_QUERY_STRING_MAX_LENGTH=64000"
+bundle config build.puma "--with-cflags='-D PUMA_QUERY_STRING_MAX_LENGTH=64000'"
 ```

data/docs/deployment.md

@@ -29,7 +29,7 @@ Here are some rules of thumb for cluster mode:
 * Use cluster mode and set the number of workers to 1.5x the number of cpu cores
   in the machine, minimum 2.
 * Set the number of threads to desired concurrent requests / number of workers.
-  Puma defaults to 16 and that's a decent number.
+  Puma defaults to 5 and that's a decent number.
 
 #### Migrating from Unicorn
 

data/docs/kubernetes.md

@@ -0,0 +1,66 @@
+# Kubernetes
+
+## Running Puma in Kubernetes
+
+In general running Puma in Kubernetes works as-is, no special configuration is needed beyond what you would write anyway to get a new Kubernetes Deployment going. There is one known interaction between the way Kubernetes handles pod termination and how Puma handles `SIGINT`, where some request might be sent to Puma after it has already entered graceful shutdown mode and is no longer accepting requests. This can lead to dropped requests during rolling deploys. A workaround for this is listed at the end of this article.
+
+## Basic setup
+
+Assuming you already have a running cluster and docker image repository, you can run a simple Puma app with the following example Dockerfile and Deployment specification. These are meant as examples only and are deliberately very minimal to the point of skipping many options that are recommended for running in production, like healthchecks and envvar configuration with ConfigMaps. In general you should check the [Kubernetes documentation](https://kubernetes.io/docs/home/) and [Docker documentation](https://docs.docker.com/) for a more comprehensive overview of the available options.
+
+A basic Dockerfile example: 
+```
+FROM ruby:2.5.1-alpine # can be updated to newer ruby versions
+RUN apk update && apk add build-base # and any other packages you need 
+
+# Only rebuild gem bundle if Gemfile changes
+COPY Gemfile Gemfile.lock ./
+RUN bundle install
+
+# Copy over the rest of the files
+COPY . .
+
+# Open up port and start the service
+EXPOSE 9292
+CMD bundle exec rackup -o 0.0.0.0
+```
+
+A sample `deployment.yaml`:
+```
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: my-awesome-puma-app
+spec:
+  selector:
+    matchLabels:
+      app: my-awesome-puma-app
+  template:
+    metadata:
+      labels:
+        app: my-awesome-puma-app
+        service: my-awesome-puma-app
+    spec:
+      containers:
+      - name: my-awesome-puma-app
+        image: <your image here>
+        ports:
+        - containerPort: 9292
+``` 
+
+## Graceful shutdown and pod termination
+
+For some high-throughput systems, it is possible that some HTTP requests will return responses with response codes in the 5XX range during a rolling deploy to a new version. This is caused by [the way that Kubernetes terminates a pod during rolling deploys](https://cloud.google.com/blog/products/gcp/kubernetes-best-practices-terminating-with-grace):
+
+1. The replication controller determines a pod should be shut down.
+2. The Pod is set to the “Terminating” State and removed from the endpoints list of all Services, so that it receives no more requests.
+3. The pods pre-stop hook get called. The default for this is to send `SIGTERM` to the process inside the pod.
+4. The pod has up to `terminationGracePeriodSeconds` (default: 30 seconds) to gracefully shut down. Puma will do this (after it receives SIGTERM) by closing down the socket that accepts new requests and finishing any requests already running before exiting the Puma process.
+5. If the pod is still running after `terminationGracePeriodSeconds` has elapsed, the pod receives `SIGKILL` to make sure the process inside it stops. After that, the container exits and all other Kubernetes objects associated with it are cleaned up.
+
+There is a subtle race condition between step 2 and 3: The replication controller does not synchronously remove the pod from the Services AND THEN call the pre-stop hook of the pod, but rather it asynchronously sends "remove this pod from your endpoints" requests to the Services and then immediately proceeds to invoke the pods' pre-stop hook. If the Service controller (typically something like nginx or haproxy) receives this request handles this request "too" late (due to internal lag or network latency between the replication and Service controllers) then it is possible that the Service controller will send one or more requests to a Puma process which has already shut down its listening socket. These requests will then fail with 5XX error codes.
+
+The way Kubernetes works this way, rather than handling step 2 synchronously, is due to the CAP theorem: in a distributed system there is no way to guarantuee that any message will arrive promptly. In particular, waiting for all Service controllers to report back might get stuck for an indefinite time if one of them has already been terminated or if there has been a net split. A way to work around this is to add a sleep to the pre-stop hook of the same time as the `terminationGracePeriodSeconds` time. This will allow the Puma process to keep serving new requests during the entire grace period, although it will no longer receive new requests after all Service controllers have propagated the removal of the pod from their endpoint lists. Then, after `terminationGracePeriodSeconds`, the pod receives `SIGKILL` and closes down. If your process can't handle SIGKILL properly, for example because it needs to release locks in different services, you can also sleep for a shorter period (and/or increase `terminationGracePeriodSeconds`) as long as the time slept is longer than the time that your Service controllers take to propagate the pod removal. The downside of this workaround is that all pods will take at minimum the amount of time slept to shut down and this will increase the time required for your rolling deploy.
+
+More discussions and links to relevant articles can be found in https://github.com/puma/puma/issues/2343.

data/docs/plugins.md

@@ -8,7 +8,7 @@ operations.
 * [tmp\_restart](https://github.com/puma/puma/blob/master/lib/puma/plugin/tmp_restart.rb):
   Restarts the server if the file `tmp/restart.txt` is touched
 * [heroku](https://github.com/puma/puma-heroku/blob/master/lib/puma/plugin/heroku.rb):
-  Packages up the default configuration used by puma on Heroku
+  Packages up the default configuration used by puma on Heroku (being sunset with the release of Puma 5.0)
 
 Plugins are activated in a puma configuration file (such as `config/puma.rb'`)
 by adding `plugin "name"`, such as `plugin "heroku"`.

data/docs/rails_dev_mode.md

@@ -0,0 +1,29 @@
+# Running Puma in Rails Development Mode
+
+## "Loopback requests" 
+
+Be cautious of "loopback requests", where a Rails application executes a request to a server that in turn, results in another request back to the same Rails application before the first request is completed. Having a loopback request will trigger [Rails' load interlock](https://guides.rubyonrails.org/threading_and_code_execution.html#load-interlock) mechanism. The load interlock mechanism prevents a thread from using Rails autoloading mechanism to load constants while the application code is still running inside another thread.
+
+This issue only occurs in the development environment as Rails' load interlock is not used in production environments. Although we're not sure, we believe this issue may not occur with the new `zeitwerk` code loader.
+
+### Solutions
+
+
+#### 1. Bypass Rails' load interlock with `.permit_concurrent_loads`
+
+Wrap the first request inside a block that will allow concurrent loads, [`ActiveSupport::Dependencies.interlock.permit_concurrent_loads`](https://guides.rubyonrails.org/threading_and_code_execution.html#permit-concurrent-loads). Anything wrapped inside the `.permit_concurrent_loads` block will bypass the load interlock mechanism, allowing new threads to access the Rails environment and boot properly. 
+
+###### Example 
+
+```ruby
+response = ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+  # Your HTTP request code here. For example:
+  Faraday.post url, data: 'foo'
+end
+
+do_something_with response
+```
+
+####  2. Use multiple processes on Puma
+
+Alternatively, you may also enable multiple (single-threaded) workers on Puma. By doing so, you are sidestepping the problem by creating multiple processes rather than new threads. However, this workaround is not ideal because debugging tools such as [byebug](https://github.com/deivid-rodriguez/byebug/issues/487) and [pry](https://github.com/pry/pry/issues/2153), work poorly with any multi-process web server. 

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 is run in single mode, these stats ar available at the top level. When Puma is run in cluster mode, these stats are available within the `worker_status` array in a hash labeled `last_status`, in an array of hashes, one hash for 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 up 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 was 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
+      }
+    }
+  ]
+}
+```