puma 5.3.2 → 5.5.1
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of puma might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/History.md +76 -8
- data/README.md +42 -6
- data/docs/architecture.md +49 -16
- data/docs/compile_options.md +4 -2
- data/docs/deployment.md +53 -67
- data/docs/plugins.md +15 -15
- data/docs/rails_dev_mode.md +2 -3
- data/docs/restart.md +6 -6
- data/docs/signals.md +10 -10
- data/docs/stats.md +8 -8
- data/docs/systemd.md +64 -67
- data/ext/puma_http11/extconf.rb +18 -1
- data/ext/puma_http11/http11_parser.c +19 -12
- data/ext/puma_http11/http11_parser_common.rl +1 -1
- data/ext/puma_http11/mini_ssl.c +16 -1
- data/ext/puma_http11/org/jruby/puma/Http11Parser.java +34 -34
- data/lib/puma/app/status.rb +4 -4
- data/lib/puma/binder.rb +33 -2
- data/lib/puma/cli.rb +5 -0
- data/lib/puma/client.rb +49 -8
- data/lib/puma/cluster/worker.rb +3 -13
- data/lib/puma/cluster.rb +1 -13
- data/lib/puma/configuration.rb +1 -1
- data/lib/puma/const.rb +4 -2
- data/lib/puma/control_cli.rb +1 -1
- data/lib/puma/dsl.rb +20 -3
- data/lib/puma/{json.rb → json_serialization.rb} +1 -1
- data/lib/puma/launcher.rb +2 -0
- data/lib/puma/minissl.rb +6 -21
- data/lib/puma/plugin.rb +1 -1
- data/lib/puma/rack/builder.rb +1 -1
- data/lib/puma/request.rb +4 -4
- data/lib/puma/runner.rb +19 -6
- data/lib/puma/server.rb +17 -8
- data/lib/puma/thread_pool.rb +6 -4
- data/lib/puma/util.rb +8 -1
- data/lib/puma.rb +2 -2
- metadata +6 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 79c6d8e0b864d27712116c6e235baddf99aaf663d8b152b11287b16ecf2a80a1
|
4
|
+
data.tar.gz: 4fc99948c0655ffc08e3304a758a50b0370553912cc9bf808bed40abc6501458
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7d2b50dca388c1ea1494a2c8cf326d159d1e1c8ebdb4d68f4e07a120a10bf623b3545f1b991dce15da6ab0fe8d97b27c1612170dbc2f296bdeca04748268274b
|
7
|
+
data.tar.gz: cfa324c8ce8353ca3454c133c0f10c351c2171a7e355ffec3cd72ba774e97badb1c027d48ea3a7c30472678c528be3a7a8f3f083aa195a88527157ae8223a4b4
|
data/History.md
CHANGED
@@ -1,14 +1,50 @@
|
|
1
|
+
## 5.5.1 / 2021-10-12
|
2
|
+
|
3
|
+
* Security
|
4
|
+
* Do not allow LF as a line ending in a header (CVE-2021-41136)
|
5
|
+
|
6
|
+
## 5.5.0 / 2021-09-19
|
7
|
+
|
8
|
+
* Features
|
9
|
+
* Automatic SSL certificate provisioning for localhost, via localhost gem ([#2610], [#2257])
|
10
|
+
* add support for the PROXY protocol (v1 only) ([#2654], [#2651])
|
11
|
+
* Add a semantic CLI option for no config file ([#2689])
|
12
|
+
|
13
|
+
* Bugfixes
|
14
|
+
* More elaborate exception handling - lets some dead pumas die. ([#2700], [#2699])
|
15
|
+
* allow multiple after_worker_fork hooks ([#2690])
|
16
|
+
* Preserve BUNDLE_APP_CONFIG on worker fork ([#2688], [#2687])
|
17
|
+
|
18
|
+
* Performance
|
19
|
+
* Fix performance of server-side SSL connection close. ([#2675])
|
20
|
+
|
21
|
+
## 5.4.0 / 2021-07-28
|
22
|
+
|
23
|
+
* Features
|
24
|
+
* Better/expanded names for threadpool threads ([#2657])
|
25
|
+
* Allow pkg_config for OpenSSL ([#2648], [#1412])
|
26
|
+
* Add `rack_url_scheme` to Puma::DSL, allows setting of `rack.url_scheme` header ([#2586], [#2569])
|
27
|
+
|
28
|
+
* Bugfixes
|
29
|
+
* `Binder#parse` - allow for symlinked unix path, add create_activated_fds debug ENV ([#2643], [#2638])
|
30
|
+
* Fix deprecation warning: minissl.c - Use Random.bytes if available ([#2642])
|
31
|
+
* Client certificates: set session id context while creating SSLContext ([#2633])
|
32
|
+
* Fix deadlock issue in thread pool ([#2656])
|
33
|
+
|
34
|
+
* Refactor
|
35
|
+
* Replace `IO.select` with `IO#wait_*` when checking a single IO ([#2666])
|
36
|
+
|
1
37
|
## 5.3.2 / 2021-05-21
|
2
38
|
|
3
39
|
* Bugfixes
|
4
|
-
* Gracefully handle Rack not accepting CLI options (#2630, #2626)
|
5
|
-
* Fix sigterm misbehavior (#2629)
|
6
|
-
* Improvements to keepalive-connection shedding (#2628)
|
40
|
+
* Gracefully handle Rack not accepting CLI options ([#2630], [#2626])
|
41
|
+
* Fix sigterm misbehavior ([#2629])
|
42
|
+
* Improvements to keepalive-connection shedding ([#2628])
|
7
43
|
|
8
44
|
## 5.3.1 / 2021-05-11
|
9
45
|
|
10
46
|
* Security
|
11
|
-
* Close keepalive connections after the maximum number of fast inlined requests (#2625)
|
47
|
+
* Close keepalive connections after the maximum number of fast inlined requests (CVE-2021-29509) ([#2625])
|
12
48
|
|
13
49
|
## 5.3.0 / 2021-05-07
|
14
50
|
|
@@ -220,10 +256,15 @@
|
|
220
256
|
* Support parallel tests in verbose progress reporting ([#2223])
|
221
257
|
* Refactor error handling in server accept loop ([#2239])
|
222
258
|
|
259
|
+
## 4.3.9 / 2021-10-12
|
260
|
+
|
261
|
+
* Security
|
262
|
+
* Do not allow LF as a line ending in a header (CVE-2021-41136)
|
263
|
+
|
223
264
|
## 4.3.8 / 2021-05-11
|
224
265
|
|
225
266
|
* Security
|
226
|
-
* Close keepalive connections after the maximum number of fast inlined requests (#2625)
|
267
|
+
* Close keepalive connections after the maximum number of fast inlined requests (CVE-2021-29509) ([#2625])
|
227
268
|
|
228
269
|
## 4.3.7 / 2020-11-30
|
229
270
|
|
@@ -1753,6 +1794,33 @@ be added back in a future date when a java Puma::MiniSSL is added.
|
|
1753
1794
|
* Bugfixes
|
1754
1795
|
* Your bugfix goes here <Most recent on the top, like GitHub> (#Github Number)
|
1755
1796
|
|
1797
|
+
[#2610]:https://github.com/puma/puma/pull/2610 "PR by @ye-lin-aung, merged 2021-08-18"
|
1798
|
+
[#2257]:https://github.com/puma/puma/issues/2257 "Issue by @nateberkopec, closed 2021-08-18"
|
1799
|
+
[#2654]:https://github.com/puma/puma/pull/2654 "PR by @Roguelazer, merged 2021-09-07"
|
1800
|
+
[#2651]:https://github.com/puma/puma/issues/2651 "Issue by @Roguelazer, closed 2021-09-07"
|
1801
|
+
[#2689]:https://github.com/puma/puma/pull/2689 "PR by @jacobherrington, merged 2021-09-05"
|
1802
|
+
[#2700]:https://github.com/puma/puma/pull/2700 "PR by @ioquatix, merged 2021-09-16"
|
1803
|
+
[#2699]:https://github.com/puma/puma/issues/2699 "Issue by @ioquatix, closed 2021-09-16"
|
1804
|
+
[#2690]:https://github.com/puma/puma/pull/2690 "PR by @doits, merged 2021-09-06"
|
1805
|
+
[#2688]:https://github.com/puma/puma/pull/2688 "PR by @jdelStrother, merged 2021-09-03"
|
1806
|
+
[#2687]:https://github.com/puma/puma/issues/2687 "Issue by @jdelStrother, closed 2021-09-03"
|
1807
|
+
[#2675]:https://github.com/puma/puma/pull/2675 "PR by @devwout, merged 2021-09-08"
|
1808
|
+
[#2657]:https://github.com/puma/puma/pull/2657 "PR by @olivierbellone, merged 2021-07-13"
|
1809
|
+
[#2648]:https://github.com/puma/puma/pull/2648 "PR by @MSP-Greg, merged 2021-06-27"
|
1810
|
+
[#1412]:https://github.com/puma/puma/issues/1412 "Issue by @x-yuri, closed 2021-06-27"
|
1811
|
+
[#2586]:https://github.com/puma/puma/pull/2586 "PR by @MSP-Greg, merged 2021-05-26"
|
1812
|
+
[#2569]:https://github.com/puma/puma/issues/2569 "Issue by @tarragon, closed 2021-05-26"
|
1813
|
+
[#2643]:https://github.com/puma/puma/pull/2643 "PR by @MSP-Greg, merged 2021-06-27"
|
1814
|
+
[#2638]:https://github.com/puma/puma/issues/2638 "Issue by @gingerlime, closed 2021-06-27"
|
1815
|
+
[#2642]:https://github.com/puma/puma/pull/2642 "PR by @MSP-Greg, merged 2021-06-16"
|
1816
|
+
[#2633]:https://github.com/puma/puma/pull/2633 "PR by @onlined, merged 2021-06-04"
|
1817
|
+
[#2656]:https://github.com/puma/puma/pull/2656 "PR by @olivierbellone, merged 2021-07-07"
|
1818
|
+
[#2666]:https://github.com/puma/puma/pull/2666 "PR by @MSP-Greg, merged 2021-07-25"
|
1819
|
+
[#2630]:https://github.com/puma/puma/pull/2630 "PR by @seangoedecke, merged 2021-05-20"
|
1820
|
+
[#2626]:https://github.com/puma/puma/issues/2626 "Issue by @rorymckinley, closed 2021-05-20"
|
1821
|
+
[#2629]:https://github.com/puma/puma/pull/2629 "PR by @ye-lin-aung, merged 2021-05-20"
|
1822
|
+
[#2628]:https://github.com/puma/puma/pull/2628 "PR by @wjordan, merged 2021-05-20"
|
1823
|
+
[#2625]:https://github.com/puma/puma/issues/2625 "Issue by @jarthod, closed 2021-05-11"
|
1756
1824
|
[#2564]:https://github.com/puma/puma/pull/2564 "PR by @MSP-Greg, merged 2021-04-24"
|
1757
1825
|
[#2526]:https://github.com/puma/puma/issues/2526 "Issue by @nerdrew, closed 2021-04-24"
|
1758
1826
|
[#2559]:https://github.com/puma/puma/pull/2559 "PR by @ylecuyer, merged 2021-03-11"
|
@@ -1767,11 +1835,11 @@ be added back in a future date when a java Puma::MiniSSL is added.
|
|
1767
1835
|
[#2605]:https://github.com/puma/puma/pull/2605 "PR by @pascalbetz, merged 2021-04-26"
|
1768
1836
|
[#2584]:https://github.com/puma/puma/issues/2584 "Issue by @kaorihinata, closed 2021-04-26"
|
1769
1837
|
[#2607]:https://github.com/puma/puma/pull/2607 "PR by @calvinxiao, merged 2021-04-23"
|
1770
|
-
[#2552]:https://github.com/puma/puma/issues/2552 "Issue by @feliperaul,
|
1838
|
+
[#2552]:https://github.com/puma/puma/issues/2552 "Issue by @feliperaul, closed 2021-05-24"
|
1771
1839
|
[#2606]:https://github.com/puma/puma/pull/2606 "PR by @wjordan, merged 2021-04-20"
|
1772
1840
|
[#2574]:https://github.com/puma/puma/issues/2574 "Issue by @darkhelmet, closed 2021-04-20"
|
1773
|
-
[#2567]:https://github.com/puma/puma/pull/2567 "PR by @
|
1774
|
-
[#2566]:https://github.com/puma/puma/issues/2566 "Issue by @
|
1841
|
+
[#2567]:https://github.com/puma/puma/pull/2567 "PR by @kddnewton, merged 2021-04-19"
|
1842
|
+
[#2566]:https://github.com/puma/puma/issues/2566 "Issue by @kddnewton, closed 2021-04-19"
|
1775
1843
|
[#2596]:https://github.com/puma/puma/pull/2596 "PR by @MSP-Greg, merged 2021-04-18"
|
1776
1844
|
[#2588]:https://github.com/puma/puma/pull/2588 "PR by @dentarg, merged 2021-04-02"
|
1777
1845
|
[#2556]:https://github.com/puma/puma/issues/2556 "Issue by @gamecreature, closed 2021-04-02"
|
data/README.md
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
<img src="https://puma.io/images/logos/puma-logo-large.png">
|
3
3
|
</p>
|
4
4
|
|
5
|
-
# Puma: A Ruby Web Server Built For
|
5
|
+
# Puma: A Ruby Web Server Built For Parallelism
|
6
6
|
|
7
7
|
[![Actions MRI](https://github.com/puma/puma/workflows/MRI/badge.svg?branch=master)](https://github.com/puma/puma/actions?query=workflow%3AMRI)
|
8
8
|
[![Actions non MRI](https://github.com/puma/puma/workflows/non_MRI/badge.svg?branch=master)](https://github.com/puma/puma/actions?query=workflow%3Anon_MRI)
|
@@ -10,11 +10,11 @@
|
|
10
10
|
[![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=puma&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=puma&package-manager=bundler&version-scheme=semver)
|
11
11
|
[![StackOverflow](https://img.shields.io/badge/stackoverflow-Puma-blue.svg)]( https://stackoverflow.com/questions/tagged/puma )
|
12
12
|
|
13
|
-
Puma is a **simple, fast, multi-threaded, and highly
|
13
|
+
Puma is a **simple, fast, multi-threaded, and highly parallel HTTP 1.1 server for Ruby/Rack applications**.
|
14
14
|
|
15
|
-
## Built For Speed &
|
15
|
+
## Built For Speed & Parallelism
|
16
16
|
|
17
|
-
Puma processes requests using a C-optimized Ragel extension (inherited from Mongrel) that provides fast, accurate HTTP 1.1 protocol parsing in a portable way. Puma then serves the request using a thread pool. Each request is served in a separate thread, so truly
|
17
|
+
Puma processes requests using a C-optimized Ragel extension (inherited from Mongrel) that provides fast, accurate HTTP 1.1 protocol parsing in a portable way. Puma then serves the request using a thread pool. Each request is served in a separate thread, so truly parallel Ruby implementations (JRuby, Rubinius) will use all available CPU cores.
|
18
18
|
|
19
19
|
Originally designed as a server for [Rubinius](https://github.com/rubinius/rubinius), Puma also works well with Ruby (MRI) and JRuby.
|
20
20
|
|
@@ -187,6 +187,38 @@ Need a bit of security? Use SSL sockets:
|
|
187
187
|
```
|
188
188
|
$ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert'
|
189
189
|
```
|
190
|
+
#### Self-signed SSL certificates (via the [`localhost`] gem, for development use):
|
191
|
+
|
192
|
+
Puma supports the [`localhost`] gem for self-signed certificates. This is particularly useful if you want to use Puma with SSL locally, and self-signed certificates will work for your use-case. Currently, the integration can only be used in MRI.
|
193
|
+
|
194
|
+
Puma automatically configures SSL when the [`localhost`] gem is loaded in a `development` environment:
|
195
|
+
|
196
|
+
```ruby
|
197
|
+
# Add the gem to your Gemfile
|
198
|
+
group(:development) do
|
199
|
+
gem 'localhost'
|
200
|
+
end
|
201
|
+
|
202
|
+
# And require it implicitly using bundler
|
203
|
+
require "bundler"
|
204
|
+
Bundler.require(:default, ENV["RACK_ENV"].to_sym)
|
205
|
+
|
206
|
+
# Alternatively, you can require the gem in config.ru:
|
207
|
+
require './app'
|
208
|
+
require 'localhost'
|
209
|
+
run Sinatra::Application
|
210
|
+
```
|
211
|
+
|
212
|
+
Additionally, Puma must be listening to an SSL socket:
|
213
|
+
|
214
|
+
```shell
|
215
|
+
$ puma -b 'ssl://localhost:9292' config.ru
|
216
|
+
|
217
|
+
# The following options allow you to reach Puma over HTTP as well:
|
218
|
+
$ puma -b ssl://localhost:9292 -b tcp://localhost:9393 config.ru
|
219
|
+
```
|
220
|
+
|
221
|
+
[`localhost`]: https://github.com/socketry/localhost
|
190
222
|
|
191
223
|
#### Controlling SSL Cipher Suites
|
192
224
|
|
@@ -255,11 +287,15 @@ You can also provide a configuration file with the `-C` (or `--config`) flag:
|
|
255
287
|
$ puma -C /path/to/config
|
256
288
|
```
|
257
289
|
|
258
|
-
If no configuration file is specified, Puma will look for a configuration file at `config/puma.rb`. If an environment is specified
|
290
|
+
If no configuration file is specified, Puma will look for a configuration file at `config/puma.rb`. If an environment is specified (via the `--environment` flag or through the `APP_ENV`, `RACK_ENV`, or `RAILS_ENV` environment variables) Puma looks for a configuration file at `config/puma/<environment_name>.rb` and then falls back to `config/puma.rb`.
|
259
291
|
|
260
|
-
If you want to prevent Puma from looking for a configuration file in those locations,
|
292
|
+
If you want to prevent Puma from looking for a configuration file in those locations, include the `--no-config` flag:
|
261
293
|
|
262
294
|
```
|
295
|
+
$ puma --no-config
|
296
|
+
|
297
|
+
# or
|
298
|
+
|
263
299
|
$ puma -C "-"
|
264
300
|
```
|
265
301
|
|
data/docs/architecture.md
CHANGED
@@ -4,38 +4,71 @@
|
|
4
4
|
|
5
5
|
![https://bit.ly/2iJuFky](images/puma-general-arch.png)
|
6
6
|
|
7
|
-
Puma is a threaded Ruby HTTP application server
|
7
|
+
Puma is a threaded Ruby HTTP application server processing requests across a TCP
|
8
|
+
and/or UNIX socket.
|
8
9
|
|
9
10
|
|
10
|
-
Puma processes (there can be one or many) accept connections from the socket via
|
11
|
+
Puma processes (there can be one or many) accept connections from the socket via
|
12
|
+
a thread (in the [`Reactor`](../lib/puma/reactor.rb) class). The connection,
|
13
|
+
once fully buffered and read, moves into the `todo` list, where an available
|
14
|
+
thread will pick it up (in the [`ThreadPool`](../lib/puma/thread_pool.rb)
|
15
|
+
class).
|
11
16
|
|
12
|
-
Puma works in two main modes: cluster and single. In single mode, only one Puma
|
17
|
+
Puma works in two main modes: cluster and single. In single mode, only one Puma
|
18
|
+
process boots. In cluster mode, a `master` process is booted, which prepares
|
19
|
+
(and may boot) the application and then uses the `fork()` system call to create
|
20
|
+
one or more `child` processes. These `child` processes all listen to the same
|
21
|
+
socket. The `master` process does not listen to the socket or process requests -
|
22
|
+
its purpose is primarily to manage and listen for UNIX signals and possibly kill
|
23
|
+
or boot `child` processes.
|
13
24
|
|
14
|
-
We sometimes call `child` processes (or Puma processes in `single` mode)
|
25
|
+
We sometimes call `child` processes (or Puma processes in `single` mode)
|
26
|
+
_workers_, and we sometimes call the threads created by Puma's
|
27
|
+
[`ThreadPool`](../lib/puma/thread_pool.rb) _worker threads_.
|
15
28
|
|
16
29
|
## How Requests Work
|
17
30
|
|
18
31
|
![https://bit.ly/2zwzhEK](images/puma-connection-flow.png)
|
19
32
|
|
20
33
|
* Upon startup, Puma listens on a TCP or UNIX socket.
|
21
|
-
* The backlog of this socket is configured (with a default of 1024).
|
22
|
-
|
23
|
-
|
24
|
-
|
34
|
+
* The backlog of this socket is configured (with a default of 1024). The
|
35
|
+
backlog determines the size of the queue for unaccepted connections.
|
36
|
+
Generally, you'll never hit the backlog cap in production. If the backlog is
|
37
|
+
full, the operating system refuses new connections.
|
38
|
+
* This socket backlog is distinct from the `backlog` of work as reported by
|
39
|
+
`Puma.stats` or the control server. The backlog that `Puma.stats` refers to
|
40
|
+
represents the number of connections in the process' `todo` set waiting for
|
41
|
+
a thread from the [`ThreadPool`](../lib/puma/thread_pool.rb).
|
42
|
+
* By default, a single, separate thread (created by the
|
43
|
+
[`Reactor`](../lib/puma/reactor.rb) class) reads and buffers requests from the
|
44
|
+
socket.
|
45
|
+
* When at least one worker thread is available for work, the reactor thread
|
46
|
+
listens to the socket and accepts a request (if one is waiting).
|
25
47
|
* The reactor thread waits for the entire HTTP request to be received.
|
26
|
-
*
|
27
|
-
|
48
|
+
* Puma exposes the time spent waiting for the HTTP request body to be
|
49
|
+
received to the Rack app as `env['puma.request_body_wait']`
|
50
|
+
(milliseconds).
|
51
|
+
* Once fully buffered and received, the connection is pushed into the "todo"
|
52
|
+
set.
|
28
53
|
* Worker threads pop work off the "todo" set for processing.
|
29
|
-
* The worker thread processes the request via `call`ing the configured Rack
|
30
|
-
|
31
|
-
*
|
54
|
+
* The worker thread processes the request via `call`ing the configured Rack
|
55
|
+
application. The Rack application generates the HTTP response.
|
56
|
+
* The worker thread writes the response to the connection. While Puma buffers
|
57
|
+
requests via a separate thread, it does not use a separate thread for
|
58
|
+
responses.
|
59
|
+
* Once done, the thread becomes available to process another connection in the
|
60
|
+
"todo" set.
|
32
61
|
|
33
62
|
### `queue_requests`
|
34
63
|
|
35
64
|
![https://bit.ly/2zxCJ1Z](images/puma-connection-flow-no-reactor.png)
|
36
65
|
|
37
|
-
The `queue_requests` option is `true` by default, enabling the separate reactor
|
66
|
+
The `queue_requests` option is `true` by default, enabling the separate reactor
|
67
|
+
thread used to buffer requests as described above.
|
38
68
|
|
39
|
-
If set to `false`, this buffer will not be used for connections while waiting
|
69
|
+
If set to `false`, this buffer will not be used for connections while waiting
|
70
|
+
for the request to arrive.
|
40
71
|
|
41
|
-
In this mode, when a connection is accepted, it is added to the "todo" queue
|
72
|
+
In this mode, when a connection is accepted, it is added to the "todo" queue
|
73
|
+
immediately, and a worker will synchronously do any waiting necessary to read
|
74
|
+
the HTTP request from the socket.
|
data/docs/compile_options.md
CHANGED
@@ -1,10 +1,12 @@
|
|
1
1
|
# Compile Options
|
2
2
|
|
3
|
-
There are some `cflags` provided to change Puma's default configuration for its
|
3
|
+
There are some `cflags` provided to change Puma's default configuration for its
|
4
|
+
C extension.
|
4
5
|
|
5
6
|
## Query String, `PUMA_QUERY_STRING_MAX_LENGTH`
|
6
7
|
|
7
|
-
By default, the max length of `QUERY_STRING` is `1024 * 10`. But you may want to
|
8
|
+
By default, the max length of `QUERY_STRING` is `1024 * 10`. But you may want to
|
9
|
+
adjust it to accept longer queries in GET requests.
|
8
10
|
|
9
11
|
For manual install, pass the `PUMA_QUERY_STRING_MAX_LENGTH` option like this:
|
10
12
|
|
data/docs/deployment.md
CHANGED
@@ -1,35 +1,32 @@
|
|
1
1
|
# Deployment engineering for Puma
|
2
2
|
|
3
|
-
Puma
|
4
|
-
|
5
|
-
it in their production deployments as well.
|
3
|
+
Puma expects to be run in a deployed environment eventually. You can use it as
|
4
|
+
your development server, but most people use it in their production deployments.
|
6
5
|
|
7
|
-
To that end, this
|
8
|
-
|
6
|
+
To that end, this document serves as a foundation of wisdom regarding deploying
|
7
|
+
Puma to production while increasing happiness and decreasing downtime.
|
9
8
|
|
10
9
|
## Specifying Puma
|
11
10
|
|
12
|
-
Most people
|
13
|
-
|
11
|
+
Most people will specify Puma by including `gem "puma"` in a Gemfile, so we'll
|
12
|
+
assume this is how you're using Puma.
|
14
13
|
|
15
|
-
|
14
|
+
## Single vs. Cluster mode
|
16
15
|
|
17
|
-
|
16
|
+
Initially, Puma was conceived as a thread-only web server, but support for
|
17
|
+
processes was added in version 2.
|
18
18
|
|
19
|
-
|
20
|
-
|
19
|
+
To run `puma` in single mode (i.e., as a development environment), set the
|
20
|
+
number of workers to 0; anything higher will run in cluster mode.
|
21
21
|
|
22
|
-
|
23
|
-
set the number of workers to 0, anything above will run in cluster mode.
|
24
|
-
|
25
|
-
Here are some rules of thumb for cluster mode:
|
22
|
+
Here are some tips for cluster mode:
|
26
23
|
|
27
24
|
### MRI
|
28
25
|
|
29
|
-
* Use cluster mode and set the number of workers to 1.5x the number of
|
30
|
-
in the machine, minimum 2.
|
31
|
-
* Set the number of threads to desired concurrent requests
|
32
|
-
Puma defaults to 5 and that's a decent number.
|
26
|
+
* Use cluster mode and set the number of workers to 1.5x the number of CPU cores
|
27
|
+
in the machine, starting from a minimum of 2.
|
28
|
+
* Set the number of threads to desired concurrent requests/number of workers.
|
29
|
+
Puma defaults to 5, and that's a decent number.
|
33
30
|
|
34
31
|
#### Migrating from Unicorn
|
35
32
|
|
@@ -37,7 +34,7 @@ Here are some rules of thumb for cluster mode:
|
|
37
34
|
* Set workers to half the number of unicorn workers you're using
|
38
35
|
* Set threads to 2
|
39
36
|
* Enjoy 50% memory savings
|
40
|
-
* As you grow more confident in the thread
|
37
|
+
* As you grow more confident in the thread-safety of your app, you can tune the
|
41
38
|
workers down and the threads up.
|
42
39
|
|
43
40
|
#### Ubuntu / Systemd (Systemctl) Installation
|
@@ -48,69 +45,58 @@ See [systemd.md](systemd.md)
|
|
48
45
|
|
49
46
|
**How do you know if you've got enough (or too many workers)?**
|
50
47
|
|
51
|
-
A good question. Due to MRI's GIL, only one thread can be executing Ruby code at
|
52
|
-
But since so many apps are waiting on IO from DBs, etc., they can
|
53
|
-
|
48
|
+
A good question. Due to MRI's GIL, only one thread can be executing Ruby code at
|
49
|
+
a time. But since so many apps are waiting on IO from DBs, etc., they can
|
50
|
+
utilize threads to use the process more efficiently.
|
54
51
|
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
52
|
+
Generally, you never want processes that are pegged all the time. That can mean
|
53
|
+
there is more work to do than the process can get through. On the other hand, if
|
54
|
+
you have processes that sit around doing nothing, then they're just eating up
|
55
|
+
resources.
|
59
56
|
|
60
|
-
Watch your CPU utilization over time and aim for about 70% on average.
|
61
|
-
you've got capacity still but aren't starving threads.
|
57
|
+
Watch your CPU utilization over time and aim for about 70% on average. 70%
|
58
|
+
utilization means you've got capacity still but aren't starving threads.
|
62
59
|
|
63
60
|
**Measuring utilization**
|
64
61
|
|
65
|
-
Using a timestamp header from an upstream proxy server (
|
66
|
-
|
67
|
-
thread to become available.
|
62
|
+
Using a timestamp header from an upstream proxy server (e.g., `nginx` or
|
63
|
+
`haproxy`) makes it possible to indicate how long requests have been waiting for
|
64
|
+
a Puma thread to become available.
|
68
65
|
|
69
66
|
* Have your upstream proxy set a header with the time it received the request:
|
70
67
|
* nginx: `proxy_set_header X-Request-Start "${msec}";`
|
71
|
-
* haproxy >= 1.9: `http-request set-header X-Request-Start
|
68
|
+
* haproxy >= 1.9: `http-request set-header X-Request-Start
|
69
|
+
t=%[date()]%[date_us()]`
|
72
70
|
* haproxy < 1.9: `http-request set-header X-Request-Start t=%[date()]`
|
73
|
-
* In your Rack middleware, determine the amount of time elapsed since
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
*
|
78
|
-
|
71
|
+
* In your Rack middleware, determine the amount of time elapsed since
|
72
|
+
`X-Request-Start`.
|
73
|
+
* To improve accuracy, you will want to subtract time spent waiting for slow
|
74
|
+
clients:
|
75
|
+
* `env['puma.request_body_wait']` contains the number of milliseconds Puma
|
76
|
+
spent waiting for the client to send the request body.
|
77
|
+
* haproxy: `%Th` (TLS handshake time) and `%Ti` (idle time before request)
|
78
|
+
can can also be added as headers.
|
79
79
|
|
80
80
|
## Should I daemonize?
|
81
81
|
|
82
|
-
|
82
|
+
The Puma 5.0 release removed daemonization. For older versions and alternatives,
|
83
|
+
continue reading.
|
83
84
|
|
84
|
-
I prefer to
|
85
|
-
monitor them as child processes. This gives them fast response to crashes and
|
85
|
+
I prefer not to daemonize my servers and use something like `runit` or `systemd`
|
86
|
+
to monitor them as child processes. This gives them fast response to crashes and
|
86
87
|
makes it easy to figure out what is going on. Additionally, unlike `unicorn`,
|
87
|
-
|
88
|
+
Puma does not require daemonization to do zero-downtime restarts.
|
88
89
|
|
89
|
-
I see people using daemonization because they start puma directly via
|
90
|
-
task and thus want it to live on past the `cap deploy`. To these people I say:
|
91
|
-
You need to be using a process monitor. Nothing is making sure
|
92
|
-
this scenario! You're just waiting for something weird to happen,
|
93
|
-
and to get paged at
|
94
|
-
your OS comes with, be it `sysvinit` or `systemd`. Or branch out
|
95
|
-
|
90
|
+
I see people using daemonization because they start puma directly via Capistrano
|
91
|
+
task and thus want it to live on past the `cap deploy`. To these people, I say:
|
92
|
+
You need to be using a process monitor. Nothing is making sure Puma stays up in
|
93
|
+
this scenario! You're just waiting for something weird to happen, Puma to die,
|
94
|
+
and to get paged at 3 AM. Do yourself a favor, at least the process monitoring
|
95
|
+
your OS comes with, be it `sysvinit` or `systemd`. Or branch out and use `runit`
|
96
|
+
or hell, even `monit`.
|
96
97
|
|
97
98
|
## Restarting
|
98
99
|
|
99
100
|
You probably will want to deploy some new code at some point, and you'd like
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
1. Don't use `preload!`. This dirties the master process and means it will have
|
104
|
-
to shutdown all the workers and re-exec itself to get your new code. It is not compatible with phased-restart and `prune_bundler` as well.
|
105
|
-
|
106
|
-
1. Use `prune_bundler`. This makes it so that the cluster master will detach itself
|
107
|
-
from a Bundler context on start. This allows the cluster workers to load your app
|
108
|
-
and start a brand new Bundler context within the worker only. This means your
|
109
|
-
master remains pristine and can live on between new releases of your code.
|
110
|
-
|
111
|
-
1. Use phased-restart (`SIGUSR1` or `pumactl phased-restart`). This tells the master
|
112
|
-
to kill off one worker at a time and restart them in your new code. This minimizes
|
113
|
-
downtime and staggers the restart nicely. **WARNING** This means that both your
|
114
|
-
old code and your new code will be running concurrently. Most deployment solutions
|
115
|
-
already cause that, but it's worth warning you about it again. Be careful with your
|
116
|
-
migrations, etc!
|
101
|
+
Puma to start running that new code. There are a few options for restarting
|
102
|
+
Puma, described separately in our [restart documentation](restart.md).
|
data/docs/plugins.md
CHANGED
@@ -3,22 +3,22 @@
|
|
3
3
|
Puma 3.0 added support for plugins that can augment configuration and service
|
4
4
|
operations.
|
5
5
|
|
6
|
-
|
6
|
+
There are two canonical plugins to aid in the development of new plugins:
|
7
7
|
|
8
8
|
* [tmp\_restart](https://github.com/puma/puma/blob/master/lib/puma/plugin/tmp_restart.rb):
|
9
9
|
Restarts the server if the file `tmp/restart.txt` is touched
|
10
10
|
* [heroku](https://github.com/puma/puma-heroku/blob/master/lib/puma/plugin/heroku.rb):
|
11
|
-
Packages up the default configuration used by
|
11
|
+
Packages up the default configuration used by Puma on Heroku (being sunset
|
12
|
+
with the release of Puma 5.0)
|
12
13
|
|
13
|
-
Plugins are activated in a
|
14
|
+
Plugins are activated in a Puma configuration file (such as `config/puma.rb'`)
|
14
15
|
by adding `plugin "name"`, such as `plugin "heroku"`.
|
15
16
|
|
16
|
-
Plugins are activated based
|
17
|
-
|
18
|
-
|
19
|
-
puma plugins).
|
17
|
+
Plugins are activated based on path requirements so, activating the `heroku`
|
18
|
+
plugin is much like `require "puma/plugin/heroku"`. This allows gems to provide
|
19
|
+
multiple plugins (as well as unrelated gems to provide Puma plugins).
|
20
20
|
|
21
|
-
The `tmp_restart` plugin
|
21
|
+
The `tmp_restart` plugin comes with Puma, so it is always available.
|
22
22
|
|
23
23
|
To use the `heroku` plugin, add `puma-heroku` to your Gemfile or install it.
|
24
24
|
|
@@ -26,13 +26,13 @@ To use the `heroku` plugin, add `puma-heroku` to your Gemfile or install it.
|
|
26
26
|
|
27
27
|
## Server-wide hooks
|
28
28
|
|
29
|
-
Plugins can use a couple of hooks at server level: `start` and `config`.
|
29
|
+
Plugins can use a couple of hooks at the server level: `start` and `config`.
|
30
30
|
|
31
|
-
`start` runs when the server has started and allows the plugin to
|
32
|
-
functionality to augment
|
31
|
+
`start` runs when the server has started and allows the plugin to initiate other
|
32
|
+
functionality to augment Puma.
|
33
33
|
|
34
|
-
`config` runs when the server is being configured and
|
35
|
-
object that
|
34
|
+
`config` runs when the server is being configured and receives a `Puma::DSL`
|
35
|
+
object that is useful for additional configuration.
|
36
36
|
|
37
|
-
|
38
|
-
|
37
|
+
Public methods in [`Puma::Plugin`](../lib/puma/plugin.rb) are treated as a
|
38
|
+
public API for plugins.
|
data/docs/rails_dev_mode.md
CHANGED
@@ -2,16 +2,15 @@
|
|
2
2
|
|
3
3
|
## "Loopback requests"
|
4
4
|
|
5
|
-
Be cautious of "loopback requests"
|
5
|
+
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 completes. 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.
|
6
6
|
|
7
7
|
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.
|
8
8
|
|
9
9
|
### Solutions
|
10
10
|
|
11
|
-
|
12
11
|
#### 1. Bypass Rails' load interlock with `.permit_concurrent_loads`
|
13
12
|
|
14
|
-
Wrap the first request inside a block that will allow concurrent loads
|
13
|
+
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.
|
15
14
|
|
16
15
|
###### Example
|
17
16
|
|
data/docs/restart.md
CHANGED
@@ -1,8 +1,8 @@
|
|
1
|
-
Puma provides three distinct kinds of restart operations, each for different use cases.
|
1
|
+
Puma provides three distinct kinds of restart operations, each for different use cases. This document describes "hot restarts" and "phased restarts." The third kind of restart operation is called "refork" and is described in the documentation for [`fork_worker`](fork_worker.md).
|
2
2
|
|
3
3
|
## Hot restart
|
4
4
|
|
5
|
-
To perform a "hot" restart, Puma performs an `exec` operation to start the process up again, so no memory is shared between the old process and the new process. As a result, it is safe to issue a restart any place where you would manually stop Puma and start it again. In particular, it is safe to upgrade Puma itself using a hot restart.
|
5
|
+
To perform a "hot" restart, Puma performs an `exec` operation to start the process up again, so no memory is shared between the old process and the new process. As a result, it is safe to issue a restart at any place where you would manually stop Puma and start it again. In particular, it is safe to upgrade Puma itself using a hot restart.
|
6
6
|
|
7
7
|
If the new process is unable to load, it will simply exit. You should therefore run Puma under a process monitor when using it in production.
|
8
8
|
|
@@ -16,14 +16,14 @@ Any of the following will cause a Puma server to perform a hot restart:
|
|
16
16
|
|
17
17
|
### Supported configurations
|
18
18
|
|
19
|
-
* Works in cluster mode and
|
19
|
+
* Works in cluster mode and single mode
|
20
20
|
* Supported on all platforms
|
21
21
|
|
22
22
|
### Client experience
|
23
23
|
|
24
|
-
* All platforms:
|
24
|
+
* All platforms: clients with an in-flight request are served responses before the connection is closed gracefully. Puma gracefully disconnects any idle HTTP persistent connections before restarting.
|
25
25
|
* On MRI or TruffleRuby on Linux and BSD: Clients who connect just before the server restarts may experience increased latency while the server stops and starts again, but their connections will not be closed prematurely.
|
26
|
-
* On Windows and
|
26
|
+
* On Windows and JRuby: Clients who connect just before a restart may experience "connection reset" errors.
|
27
27
|
|
28
28
|
### Additional notes
|
29
29
|
|
@@ -32,7 +32,7 @@ Any of the following will cause a Puma server to perform a hot restart:
|
|
32
32
|
|
33
33
|
## Phased restart
|
34
34
|
|
35
|
-
Phased restarts replace all running workers in a Puma cluster. This is a useful way to
|
35
|
+
Phased restarts replace all running workers in a Puma cluster. This is a useful way to upgrade the application that Puma is serving gracefully. A phased restart works by first killing an old worker, then starting a new worker, waiting until the new worker has successfully started before proceeding to the next worker. This process continues until all workers are replaced. The master process is not restarted.
|
36
36
|
|
37
37
|
### How-to
|
38
38
|
|