puma 3.12.1 → 5.3.2
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 +1414 -448
- data/LICENSE +23 -20
- data/README.md +131 -60
- data/bin/puma-wild +3 -9
- data/docs/architecture.md +24 -19
- data/docs/compile_options.md +19 -0
- data/docs/deployment.md +38 -13
- data/docs/fork_worker.md +33 -0
- data/docs/jungle/README.md +9 -0
- data/{tools → docs}/jungle/rc.d/README.md +1 -1
- data/{tools → docs}/jungle/rc.d/puma +2 -2
- data/{tools → docs}/jungle/rc.d/puma.conf +0 -0
- data/docs/kubernetes.md +66 -0
- data/docs/nginx.md +1 -1
- data/docs/plugins.md +20 -10
- data/docs/rails_dev_mode.md +29 -0
- data/docs/restart.md +47 -22
- data/docs/signals.md +7 -6
- data/docs/stats.md +142 -0
- data/docs/systemd.md +48 -70
- data/ext/puma_http11/PumaHttp11Service.java +2 -2
- data/ext/puma_http11/ext_help.h +1 -1
- data/ext/puma_http11/extconf.rb +27 -0
- data/ext/puma_http11/http11_parser.c +84 -109
- data/ext/puma_http11/http11_parser.h +1 -1
- data/ext/puma_http11/http11_parser.java.rl +22 -38
- data/ext/puma_http11/http11_parser.rl +4 -2
- data/ext/puma_http11/http11_parser_common.rl +3 -3
- data/ext/puma_http11/mini_ssl.c +254 -91
- data/ext/puma_http11/no_ssl/PumaHttp11Service.java +15 -0
- data/ext/puma_http11/org/jruby/puma/Http11.java +108 -116
- data/ext/puma_http11/org/jruby/puma/Http11Parser.java +89 -106
- data/ext/puma_http11/org/jruby/puma/MiniSSL.java +92 -22
- data/ext/puma_http11/puma_http11.c +34 -50
- data/lib/puma.rb +54 -0
- data/lib/puma/app/status.rb +68 -49
- data/lib/puma/binder.rb +191 -139
- data/lib/puma/cli.rb +15 -15
- data/lib/puma/client.rb +257 -228
- data/lib/puma/cluster.rb +221 -212
- data/lib/puma/cluster/worker.rb +183 -0
- data/lib/puma/cluster/worker_handle.rb +90 -0
- data/lib/puma/commonlogger.rb +2 -2
- data/lib/puma/configuration.rb +58 -51
- data/lib/puma/const.rb +39 -19
- data/lib/puma/control_cli.rb +109 -67
- data/lib/puma/detect.rb +24 -3
- data/lib/puma/dsl.rb +519 -121
- data/lib/puma/error_logger.rb +104 -0
- data/lib/puma/events.rb +55 -31
- data/lib/puma/io_buffer.rb +7 -5
- data/lib/puma/jruby_restart.rb +0 -58
- data/lib/puma/json.rb +96 -0
- data/lib/puma/launcher.rb +178 -68
- data/lib/puma/minissl.rb +147 -48
- data/lib/puma/minissl/context_builder.rb +79 -0
- data/lib/puma/null_io.rb +13 -1
- data/lib/puma/plugin.rb +6 -12
- data/lib/puma/plugin/tmp_restart.rb +2 -0
- data/lib/puma/queue_close.rb +26 -0
- data/lib/puma/rack/builder.rb +2 -4
- data/lib/puma/rack/urlmap.rb +2 -0
- data/lib/puma/rack_default.rb +2 -0
- data/lib/puma/reactor.rb +85 -316
- data/lib/puma/request.rb +467 -0
- data/lib/puma/runner.rb +31 -52
- data/lib/puma/server.rb +282 -680
- data/lib/puma/single.rb +11 -67
- data/lib/puma/state_file.rb +8 -3
- data/lib/puma/systemd.rb +46 -0
- data/lib/puma/thread_pool.rb +129 -81
- data/lib/puma/util.rb +13 -6
- data/lib/rack/handler/puma.rb +5 -6
- data/tools/Dockerfile +16 -0
- data/tools/trickletest.rb +0 -1
- metadata +42 -26
- data/ext/puma_http11/io_buffer.c +0 -155
- data/lib/puma/accept_nonblock.rb +0 -23
- data/lib/puma/compat.rb +0 -14
- data/lib/puma/convenient.rb +0 -25
- data/lib/puma/daemon_ext.rb +0 -33
- data/lib/puma/delegation.rb +0 -13
- data/lib/puma/java_io_buffer.rb +0 -47
- data/lib/puma/rack/backports/uri/common_193.rb +0 -33
- data/lib/puma/tcp_logger.rb +0 -41
- data/tools/jungle/README.md +0 -19
- data/tools/jungle/init.d/README.md +0 -61
- data/tools/jungle/init.d/puma +0 -421
- data/tools/jungle/init.d/run-puma +0 -18
- data/tools/jungle/upstart/README.md +0 -61
- data/tools/jungle/upstart/puma-manager.conf +0 -31
- data/tools/jungle/upstart/puma.conf +0 -69
data/LICENSE
CHANGED
@@ -1,26 +1,29 @@
|
|
1
|
-
|
2
|
-
|
1
|
+
BSD 3-Clause License
|
2
|
+
|
3
|
+
Copyright (c) 2019, Evan Phoenix. Some code by Zed Shaw, (c) 2005.
|
3
4
|
All rights reserved.
|
4
5
|
|
5
|
-
Redistribution and use in source and binary forms, with or without
|
6
|
+
Redistribution and use in source and binary forms, with or without
|
6
7
|
modification, are permitted provided that the following conditions are met:
|
7
8
|
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
9
|
+
1. Redistributions of source code must retain the above copyright notice, this
|
10
|
+
list of conditions and the following disclaimer.
|
11
|
+
|
12
|
+
2. Redistributions in binary form must reproduce the above copyright notice,
|
13
|
+
this list of conditions and the following disclaimer in the documentation
|
14
|
+
and/or other materials provided with the distribution.
|
15
|
+
|
16
|
+
3. Neither the name of the copyright holder nor the names of its
|
17
|
+
contributors may be used to endorse or promote products derived from
|
18
|
+
this software without specific prior written permission.
|
16
19
|
|
17
|
-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
18
|
-
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
19
|
-
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
20
|
-
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
21
|
-
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
22
|
-
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
23
|
-
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
24
|
-
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
25
|
-
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
20
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
21
|
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
22
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
23
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
24
|
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
25
|
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
26
|
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
27
|
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
28
|
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
26
29
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
data/README.md
CHANGED
@@ -1,45 +1,56 @@
|
|
1
1
|
<p align="center">
|
2
|
-
<img src="
|
2
|
+
<img src="https://puma.io/images/logos/puma-logo-large.png">
|
3
3
|
</p>
|
4
4
|
|
5
5
|
# Puma: A Ruby Web Server Built For Concurrency
|
6
6
|
|
7
|
-
[![
|
8
|
-
[![
|
9
|
-
[![AppVeyor](https://img.shields.io/appveyor/ci/nateberkopec/puma.svg)](https://ci.appveyor.com/project/nateberkopec/puma)
|
10
|
-
[![Dependency Status](https://gemnasium.com/puma/puma.svg)](https://gemnasium.com/puma/puma)
|
7
|
+
[![Actions MRI](https://github.com/puma/puma/workflows/MRI/badge.svg?branch=master)](https://github.com/puma/puma/actions?query=workflow%3AMRI)
|
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)
|
11
9
|
[![Code Climate](https://codeclimate.com/github/puma/puma.svg)](https://codeclimate.com/github/puma/puma)
|
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
|
+
[![StackOverflow](https://img.shields.io/badge/stackoverflow-Puma-blue.svg)]( https://stackoverflow.com/questions/tagged/puma )
|
12
12
|
|
13
|
-
Puma is a **simple, fast, threaded, and highly concurrent HTTP 1.1 server for Ruby/Rack applications
|
13
|
+
Puma is a **simple, fast, multi-threaded, and highly concurrent HTTP 1.1 server for Ruby/Rack applications**.
|
14
14
|
|
15
15
|
## Built For Speed & Concurrency
|
16
16
|
|
17
|
-
|
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 concurrent 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
|
|
21
|
-
On MRI, there is a Global VM Lock (GVL) that ensures only one thread can run Ruby code at a time. But if you're doing a lot of blocking IO (such as HTTP calls to external APIs like Twitter), Puma still improves MRI's throughput by allowing
|
21
|
+
On MRI, there is a Global VM Lock (GVL) that ensures only one thread can run Ruby code at a time. But if you're doing a lot of blocking IO (such as HTTP calls to external APIs like Twitter), Puma still improves MRI's throughput by allowing IO waiting to be done in parallel.
|
22
22
|
|
23
23
|
## Quick Start
|
24
24
|
|
25
25
|
```
|
26
26
|
$ gem install puma
|
27
|
-
$ puma
|
28
|
-
```
|
27
|
+
$ puma
|
28
|
+
```
|
29
|
+
|
30
|
+
Without arguments, puma will look for a rackup (.ru) file in
|
31
|
+
working directory called `config.ru`.
|
32
|
+
|
33
|
+
## SSL Connection Support
|
34
|
+
|
35
|
+
Puma will install/compile with support for ssl sockets, assuming OpenSSL
|
36
|
+
development files are installed on the system.
|
37
|
+
|
38
|
+
If the system does not have OpenSSL development files installed, Puma will
|
39
|
+
install/compile, but it will not allow ssl connections.
|
29
40
|
|
30
41
|
## Frameworks
|
31
42
|
|
32
43
|
### Rails
|
33
44
|
|
34
|
-
Puma is the default server for Rails,
|
45
|
+
Puma is the default server for Rails, included in the generated Gemfile.
|
35
46
|
|
36
|
-
|
47
|
+
Start your server with the `rails` command:
|
37
48
|
|
38
49
|
```
|
39
|
-
$ rails
|
50
|
+
$ rails server
|
40
51
|
```
|
41
52
|
|
42
|
-
Many configuration options are not available when using `rails
|
53
|
+
Many configuration options and Puma features are not available when using `rails server`. It is recommended that you use Puma's executable instead:
|
43
54
|
|
44
55
|
```
|
45
56
|
$ bundle exec puma
|
@@ -53,16 +64,29 @@ You can run your Sinatra application with Puma from the command line like this:
|
|
53
64
|
$ ruby app.rb -s Puma
|
54
65
|
```
|
55
66
|
|
56
|
-
|
67
|
+
In order to actually configure Puma using a config file, like `puma.rb`, however, you need to use the `puma` executable. To do this, you must add a rackup file to your Sinatra app:
|
57
68
|
|
58
69
|
```ruby
|
59
|
-
|
60
|
-
|
70
|
+
# config.ru
|
71
|
+
require './app'
|
72
|
+
run Sinatra::Application
|
73
|
+
```
|
74
|
+
|
75
|
+
You can then start your application using:
|
76
|
+
|
77
|
+
```
|
78
|
+
$ bundle exec puma
|
61
79
|
```
|
62
80
|
|
63
81
|
## Configuration
|
64
82
|
|
65
|
-
Puma provides numerous options. Consult `puma -h` (or `puma --help`) for a full list of CLI options, or see [dsl.rb](https://github.com/puma/puma/blob/master/lib/puma/dsl.rb).
|
83
|
+
Puma provides numerous options. Consult `puma -h` (or `puma --help`) for a full list of CLI options, or see `Puma::DSL` or [dsl.rb](https://github.com/puma/puma/blob/master/lib/puma/dsl.rb).
|
84
|
+
|
85
|
+
You can also find several configuration examples as part of the
|
86
|
+
[test](https://github.com/puma/puma/tree/master/test/config) suite.
|
87
|
+
|
88
|
+
For debugging purposes, you can set the environment variable `PUMA_LOG_CONFIG` with a value
|
89
|
+
and the loaded configuration will be printed as part of the boot process.
|
66
90
|
|
67
91
|
### Thread Pool
|
68
92
|
|
@@ -72,9 +96,9 @@ Puma uses a thread pool. You can set the minimum and maximum number of threads t
|
|
72
96
|
$ puma -t 8:32
|
73
97
|
```
|
74
98
|
|
75
|
-
Puma will automatically scale the number of threads, from the minimum until it caps out at the maximum, based on how much traffic is present. The current default is `0:16`. Feel free to experiment, but be careful not to set the number of maximum threads to a large number, as you may exhaust resources on the system (or
|
99
|
+
Puma will automatically scale the number of threads, from the minimum until it caps out at the maximum, based on how much traffic is present. The current default is `0:16` and on MRI is `0:5`. Feel free to experiment, but be careful not to set the number of maximum threads to a large number, as you may exhaust resources on the system (or cause contention for the Global VM Lock, when using MRI).
|
76
100
|
|
77
|
-
Be aware that additionally Puma creates threads on its own for internal purposes (e.g. handling slow clients). So even if you specify -t 1:1, expect around 7 threads created in your application.
|
101
|
+
Be aware that additionally Puma creates threads on its own for internal purposes (e.g. handling slow clients). So, even if you specify -t 1:1, expect around 7 threads created in your application.
|
78
102
|
|
79
103
|
### Clustered mode
|
80
104
|
|
@@ -84,9 +108,9 @@ Puma also offers "clustered mode". Clustered mode `fork`s workers from a master
|
|
84
108
|
$ puma -t 8:32 -w 3
|
85
109
|
```
|
86
110
|
|
87
|
-
Note that threads are still used in clustered mode, and the `-t` thread flag setting is per worker, so `-w 2 -t 16:16` will spawn 32 threads in total.
|
111
|
+
Note that threads are still used in clustered mode, and the `-t` thread flag setting is per worker, so `-w 2 -t 16:16` will spawn 32 threads in total, with 16 in each worker process.
|
88
112
|
|
89
|
-
In clustered mode, Puma
|
113
|
+
In clustered mode, Puma can "preload" your application. This loads all the application code *prior* to forking. Preloading reduces total memory usage of your application via an operating system feature called [copy-on-write](https://en.wikipedia.org/wiki/Copy-on-write) (Ruby 2.0+ only). Use the `--preload` flag from the command line:
|
90
114
|
|
91
115
|
```
|
92
116
|
$ puma -w 3 --preload
|
@@ -111,40 +135,42 @@ end
|
|
111
135
|
|
112
136
|
This code can be used to setup the process before booting the application, allowing
|
113
137
|
you to do some Puma-specific things that you don't want to embed in your application.
|
114
|
-
For instance, you could fire a log notification that a worker booted or send something to statsd.
|
115
|
-
This can be called multiple times.
|
138
|
+
For instance, you could fire a log notification that a worker booted or send something to statsd. This can be called multiple times.
|
116
139
|
|
117
|
-
|
140
|
+
`before_fork` specifies a block to be run before workers are forked:
|
118
141
|
|
119
142
|
```ruby
|
120
143
|
# config/puma.rb
|
121
|
-
|
122
|
-
|
123
|
-
ActiveRecord::Base.establish_connection
|
124
|
-
end
|
144
|
+
before_fork do
|
145
|
+
# configuration here
|
125
146
|
end
|
126
147
|
```
|
127
148
|
|
128
|
-
|
149
|
+
Preloading can’t be used with phased restart, since phased restart kills and restarts workers one-by-one, and `preload_app!` copies the code of master into the workers.
|
150
|
+
|
151
|
+
### Error handling
|
152
|
+
|
153
|
+
If puma encounters an error outside of the context of your application, it will respond with a 500 and a simple
|
154
|
+
textual error message (see `Puma::Server#lowlevel_error` or [server.rb](https://github.com/puma/puma/blob/master/lib/puma/server.rb)).
|
155
|
+
You can specify custom behavior for this scenario. For example, you can report the error to your third-party
|
156
|
+
error-tracking service (in this example, [rollbar](https://rollbar.com)):
|
129
157
|
|
130
158
|
```ruby
|
131
|
-
|
132
|
-
|
133
|
-
|
159
|
+
lowlevel_error_handler do |e|
|
160
|
+
Rollbar.critical(e)
|
161
|
+
[500, {}, ["An error has occurred, and engineers have been informed. Please reload the page. If you continue to have problems, contact support@example.com\n"]]
|
134
162
|
end
|
135
163
|
```
|
136
164
|
|
137
|
-
Preloading can’t be used with phased restart, since phased restart kills and restarts workers one-by-one, and preload_app copies the code of master into the workers.
|
138
|
-
|
139
165
|
### Binding TCP / Sockets
|
140
166
|
|
141
|
-
|
167
|
+
Bind Puma to a socket with the `-b` (or `--bind`) flag:
|
142
168
|
|
143
169
|
```
|
144
170
|
$ puma -b tcp://127.0.0.1:9292
|
145
171
|
```
|
146
172
|
|
147
|
-
|
173
|
+
To use a UNIX Socket instead of TCP:
|
148
174
|
|
149
175
|
```
|
150
176
|
$ puma -b unix:///var/run/puma.sock
|
@@ -157,30 +183,61 @@ $ puma -b 'unix:///var/run/puma.sock?umask=0111'
|
|
157
183
|
```
|
158
184
|
|
159
185
|
Need a bit of security? Use SSL sockets:
|
186
|
+
|
160
187
|
```
|
161
188
|
$ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert'
|
162
189
|
```
|
190
|
+
|
163
191
|
#### Controlling SSL Cipher Suites
|
164
|
-
|
165
|
-
|
192
|
+
|
193
|
+
To use or avoid specific SSL cipher suites, use `ssl_cipher_filter` or `ssl_cipher_list` options.
|
194
|
+
|
195
|
+
##### Ruby:
|
196
|
+
|
166
197
|
```
|
167
198
|
$ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert&ssl_cipher_filter=!aNULL:AES+SHA'
|
168
199
|
```
|
169
|
-
|
200
|
+
|
201
|
+
##### JRuby:
|
202
|
+
|
170
203
|
```
|
171
204
|
$ puma -b 'ssl://127.0.0.1:9292?keystore=path_to_keystore&keystore-pass=keystore_password&ssl_cipher_list=TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_CBC_SHA'
|
172
205
|
```
|
173
|
-
|
206
|
+
|
207
|
+
See https://www.openssl.org/docs/man1.1.1/man1/ciphers.html for cipher filter format and full list of cipher suites.
|
208
|
+
|
209
|
+
Disable TLS v1 with the `no_tlsv1` option:
|
210
|
+
|
211
|
+
```
|
212
|
+
$ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert&no_tlsv1=true'
|
213
|
+
```
|
214
|
+
|
215
|
+
#### Controlling OpenSSL Verification Flags
|
216
|
+
|
217
|
+
To enable verification flags offered by OpenSSL, use `verification_flags` (not available for JRuby):
|
218
|
+
|
219
|
+
```
|
220
|
+
$ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert&verification_flags=PARTIAL_CHAIN'
|
221
|
+
```
|
222
|
+
|
223
|
+
You can also set multiple verification flags (by separating them with coma):
|
224
|
+
|
225
|
+
```
|
226
|
+
$ puma -b 'ssl://127.0.0.1:9292?key=path_to_key&cert=path_to_cert&verification_flags=PARTIAL_CHAIN,CRL_CHECK'
|
227
|
+
```
|
228
|
+
|
229
|
+
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`
|
230
|
+
(see https://www.openssl.org/docs/manmaster/man3/X509_VERIFY_PARAM_set_hostflags.html#VERIFICATION-FLAGS).
|
174
231
|
|
175
232
|
### Control/Status Server
|
176
233
|
|
177
|
-
Puma has a built-in status
|
234
|
+
Puma has a built-in status and control app that can be used to query and control Puma.
|
178
235
|
|
179
236
|
```
|
180
237
|
$ puma --control-url tcp://127.0.0.1:9293 --control-token foo
|
181
238
|
```
|
182
239
|
|
183
|
-
Puma will start the control server on localhost port 9293. All requests to the control server will need to include `token=foo` as a query parameter. This allows for simple authentication. Check out [status.rb](https://github.com/puma/puma/blob/master/lib/puma/app/status.rb) to see what the app has available.
|
240
|
+
Puma will start the control server on localhost port 9293. All requests to the control server will need to include control token (in this case, `token=foo`) as a query parameter. This allows for simple authentication. Check out `Puma::App::Status` or [status.rb](https://github.com/puma/puma/blob/master/lib/puma/app/status.rb) to see what the status app has available.
|
184
241
|
|
185
242
|
You can also interact with the control server via `pumactl`. This command will restart Puma:
|
186
243
|
|
@@ -192,13 +249,13 @@ To see a list of `pumactl` options, use `pumactl --help`.
|
|
192
249
|
|
193
250
|
### Configuration File
|
194
251
|
|
195
|
-
You can also provide a configuration file
|
252
|
+
You can also provide a configuration file with the `-C` (or `--config`) flag:
|
196
253
|
|
197
254
|
```
|
198
255
|
$ puma -C /path/to/config
|
199
256
|
```
|
200
257
|
|
201
|
-
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` environment
|
258
|
+
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`.
|
202
259
|
|
203
260
|
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:
|
204
261
|
|
@@ -206,28 +263,31 @@ If you want to prevent Puma from looking for a configuration file in those locat
|
|
206
263
|
$ puma -C "-"
|
207
264
|
```
|
208
265
|
|
209
|
-
|
266
|
+
The other side-effects of setting the environment are whether to show stack traces (in `development` or `test`), and setting RACK_ENV may potentially affect middleware looking for this value to change their behavior. The default puma RACK_ENV value is `development`. You can see all config default values in `Puma::Configuration#puma_default_options` or [configuration.rb](https://github.com/puma/puma/blob/61c6213fbab/lib/puma/configuration.rb#L182-L204).
|
267
|
+
|
268
|
+
Check out `Puma::DSL` or [dsl.rb](https://github.com/puma/puma/blob/master/lib/puma/dsl.rb) to see all available options.
|
210
269
|
|
211
270
|
## Restart
|
212
271
|
|
213
272
|
Puma includes the ability to restart itself. When available (MRI, Rubinius, JRuby), Puma performs a "hot restart". This is the same functionality available in *Unicorn* and *NGINX* which keep the server sockets open between restarts. This makes sure that no pending requests are dropped while the restart is taking place.
|
214
273
|
|
215
|
-
For more, see the [
|
274
|
+
For more, see the [Restart documentation](docs/restart.md).
|
216
275
|
|
217
276
|
## Signals
|
218
277
|
|
219
|
-
Puma responds to several signals. A detailed guide to using UNIX signals with Puma can be found in the [
|
278
|
+
Puma responds to several signals. A detailed guide to using UNIX signals with Puma can be found in the [Signals documentation](docs/signals.md).
|
220
279
|
|
221
280
|
## Platform Constraints
|
222
281
|
|
223
282
|
Some platforms do not support all Puma features.
|
224
283
|
|
225
284
|
* **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).
|
226
|
-
* **Windows**:
|
285
|
+
* **Windows**: Cluster mode is not supported due to a lack of fork(2).
|
286
|
+
* **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.
|
227
287
|
|
228
288
|
## Known Bugs
|
229
289
|
|
230
|
-
For MRI versions 2.2.7, 2.2.8, 2.2.9, 2.2.10 2.3.4 and 2.4.1, you may see ```stream closed in another thread (IOError)```. It may be caused by a [Ruby bug](https://bugs.ruby-lang.org/issues/13632). It can be fixed with the gem https://rubygems.org/gems/stopgap_13632:
|
290
|
+
For MRI versions 2.2.7, 2.2.8, 2.2.9, 2.2.10, 2.3.4 and 2.4.1, you may see ```stream closed in another thread (IOError)```. It may be caused by a [Ruby bug](https://bugs.ruby-lang.org/issues/13632). It can be fixed with the gem https://rubygems.org/gems/stopgap_13632:
|
231
291
|
|
232
292
|
```ruby
|
233
293
|
if %w(2.2.7 2.2.8 2.2.9 2.2.10 2.3.4 2.4.1).include? RUBY_VERSION
|
@@ -242,21 +302,32 @@ end
|
|
242
302
|
|
243
303
|
Puma has support for Capistrano with an [external gem](https://github.com/seuros/capistrano-puma).
|
244
304
|
|
245
|
-
It is common to use process monitors with Puma. Modern process monitors like systemd or
|
305
|
+
It is common to use process monitors with Puma. Modern process monitors like systemd or rc.d
|
246
306
|
provide continuous monitoring and restarts for increased
|
247
307
|
reliability in production environments:
|
248
308
|
|
249
|
-
* [
|
250
|
-
* [
|
309
|
+
* [rc.d](docs/jungle/rc.d/README.md)
|
310
|
+
* [systemd](docs/systemd.md)
|
251
311
|
|
252
|
-
|
312
|
+
Community guides:
|
253
313
|
|
254
|
-
|
314
|
+
* [Deploying Puma on OpenBSD using relayd and httpd](https://gist.github.com/anon987654321/4532cf8d6c59c1f43ec8973faa031103)
|
255
315
|
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
316
|
+
## Community Extensions
|
317
|
+
|
318
|
+
### Plugins
|
319
|
+
|
320
|
+
* [puma-metrics](https://github.com/harmjanblok/puma-metrics) — export Puma metrics to Prometheus
|
321
|
+
* [puma-plugin-statsd](https://github.com/yob/puma-plugin-statsd) — send Puma metrics to statsd
|
322
|
+
* [puma-plugin-systemd](https://github.com/sj26/puma-plugin-systemd) — deeper integration with systemd for notify, status and watchdog
|
323
|
+
|
324
|
+
### Monitoring
|
325
|
+
|
326
|
+
* [puma-status](https://github.com/ylecuyer/puma-status) — Monitor CPU/Mem/Load of running puma instances from the CLI
|
327
|
+
|
328
|
+
## Contributing
|
329
|
+
|
330
|
+
Find details for contributing in the [contribution guide](CONTRIBUTING.md).
|
260
331
|
|
261
332
|
## License
|
262
333
|
|
data/bin/puma-wild
CHANGED
@@ -5,24 +5,18 @@
|
|
5
5
|
|
6
6
|
require 'rubygems'
|
7
7
|
|
8
|
-
|
8
|
+
cli_arg = ARGV.shift
|
9
9
|
|
10
10
|
inc = ""
|
11
11
|
|
12
|
-
if
|
12
|
+
if cli_arg == "-I"
|
13
13
|
inc = ARGV.shift
|
14
14
|
$LOAD_PATH.concat inc.split(":")
|
15
|
-
gems = ARGV.shift
|
16
|
-
end
|
17
|
-
|
18
|
-
gems.split(",").each do |s|
|
19
|
-
name, ver = s.split(":",2)
|
20
|
-
gem name, ver
|
21
15
|
end
|
22
16
|
|
23
17
|
module Puma; end
|
24
18
|
|
25
|
-
Puma.const_set("WILD_ARGS", ["-I", inc
|
19
|
+
Puma.const_set("WILD_ARGS", ["-I", inc])
|
26
20
|
|
27
21
|
require 'puma/cli'
|
28
22
|
|
data/docs/architecture.md
CHANGED
@@ -2,35 +2,40 @@
|
|
2
2
|
|
3
3
|
## Overview
|
4
4
|
|
5
|
-
![
|
5
|
+
![https://bit.ly/2iJuFky](images/puma-general-arch.png)
|
6
6
|
|
7
|
-
Puma is a threaded
|
7
|
+
Puma is a threaded Ruby HTTP application server, processing requests across a TCP or UNIX socket.
|
8
8
|
|
9
|
-
Workers accept connections from the socket and a thread in the worker's thread pool processes the client's request.
|
10
9
|
|
11
|
-
|
10
|
+
Puma processes (there can be one or many) accept connections from the socket via a thread (in the [`Reactor`](../lib/puma/reactor.rb) class). The connection, once fully buffered and read, moves in to the `todo` list, where it will be picked up by a free/waiting thread in the threadpool (the [`ThreadPool`](../lib/puma/thread_pool.rb) class).
|
12
11
|
|
13
|
-
|
12
|
+
Puma works in two main modes: cluster and single. In single mode, only one Puma process is booted. In cluster mode, a `master` process is booted, which prepares (and may boot) the application, and then uses the `fork()` system call to create 1 or more `child` processes. These `child` processes all listen to the same socket. The `master` process does not listen to the socket or process requests - its purpose is mostly to manage and listen for UNIX signals and possibly kill or boot `child` processes.
|
14
13
|
|
15
|
-
|
14
|
+
We sometimes call `child` processes (or Puma processes in `single` mode) _workers_, and we sometimes call the threads created by Puma's [`ThreadPool`](../lib/puma/thread_pool.rb) _worker threads_.
|
15
|
+
|
16
|
+
## How Requests Work
|
17
|
+
|
18
|
+
![https://bit.ly/2zwzhEK](images/puma-connection-flow.png)
|
16
19
|
|
17
20
|
* Upon startup, Puma listens on a TCP or UNIX socket.
|
18
|
-
* The backlog of this socket is configured (with a default of 1024)
|
19
|
-
* This socket backlog is distinct from the
|
20
|
-
* By default, a single, separate thread is used to
|
21
|
-
* When at least one worker thread is available for work,
|
22
|
-
*
|
23
|
-
|
24
|
-
*
|
25
|
-
|
26
|
-
* The thread
|
27
|
-
*
|
21
|
+
* The backlog of this socket is configured (with a default of 1024). This determines the size of the queue for unaccepted connections. Generally, this setting is unimportant and will never be hit in production use. If the backlog is full, the connection will be refused by the operating system.
|
22
|
+
* This socket backlog is distinct from the `backlog` of work as reported by `Puma.stats` or the control server. The backlog as reported by Puma is the number of connections in the process' `todo` set waiting for a thread from the [`ThreadPool`](../lib/puma/thread_pool.rb).
|
23
|
+
* By default, a single, separate thread (created by the [`Reactor`](../lib/puma/reactor.rb) class) is used to read and buffer requests from the socket.
|
24
|
+
* When at least one worker thread is available for work, the reactor thread listens to the socket and accepts a request, if one is waiting.
|
25
|
+
* The reactor thread waits for the entire HTTP request to be received.
|
26
|
+
* The time spent waiting for the HTTP request body to be received is exposed to the Rack app as `env['puma.request_body_wait']` (milliseconds).
|
27
|
+
* Once fully buffered and received, the connection is pushed into the "todo" set.
|
28
|
+
* Worker threads pop work off the "todo" set for processing.
|
29
|
+
* The worker thread processes the request via `call`ing the configured Rack application. The Rack application generates the HTTP response.
|
30
|
+
* The worker thread writes the response to the connection. Note that while Puma buffers requests via a separate thread, it does not use a separate thread for responses.
|
31
|
+
* Once done, the thread become available to process another connection in the "todo" set.
|
28
32
|
|
29
|
-
###
|
33
|
+
### `queue_requests`
|
30
34
|
|
31
|
-
![
|
35
|
+
![https://bit.ly/2zxCJ1Z](images/puma-connection-flow-no-reactor.png)
|
32
36
|
|
33
|
-
The `queue_requests` option is `true` by default, enabling the separate thread used to buffer requests as described above.
|
37
|
+
The `queue_requests` option is `true` by default, enabling the separate reactor thread used to buffer requests as described above.
|
34
38
|
|
35
39
|
If set to `false`, this buffer will not be used for connections while waiting for the request to arrive.
|
40
|
+
|
36
41
|
In this mode, when a connection is accepted, it is added to the "todo" queue immediately, and a worker will synchronously do any waiting necessary to read the HTTP request from the socket.
|