puma 4.3.8 → 5.0.0.beta1
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 +58 -21
- data/LICENSE +23 -20
- data/README.md +17 -11
- data/docs/deployment.md +3 -1
- data/docs/fork_worker.md +31 -0
- data/docs/jungle/README.md +13 -0
- data/{tools → docs}/jungle/rc.d/README.md +0 -0
- data/{tools → docs}/jungle/rc.d/puma +0 -0
- data/{tools → docs}/jungle/rc.d/puma.conf +0 -0
- data/{tools → docs}/jungle/upstart/README.md +0 -0
- data/{tools → docs}/jungle/upstart/puma-manager.conf +0 -0
- data/{tools → docs}/jungle/upstart/puma.conf +0 -0
- data/docs/signals.md +1 -0
- data/docs/systemd.md +1 -63
- data/ext/puma_http11/PumaHttp11Service.java +2 -4
- data/ext/puma_http11/extconf.rb +3 -2
- data/ext/puma_http11/http11_parser.c +1 -3
- data/ext/puma_http11/http11_parser.rl +1 -3
- data/ext/puma_http11/org/jruby/puma/Http11.java +3 -3
- data/ext/puma_http11/puma_http11.c +2 -38
- data/lib/puma.rb +4 -0
- data/lib/puma/app/status.rb +16 -5
- data/lib/puma/binder.rb +62 -60
- data/lib/puma/cli.rb +7 -15
- data/lib/puma/client.rb +35 -32
- data/lib/puma/cluster.rb +179 -74
- data/lib/puma/configuration.rb +30 -42
- data/lib/puma/const.rb +2 -3
- data/lib/puma/control_cli.rb +27 -17
- data/lib/puma/detect.rb +8 -0
- data/lib/puma/dsl.rb +70 -34
- data/lib/puma/io_buffer.rb +9 -2
- data/lib/puma/jruby_restart.rb +0 -58
- data/lib/puma/launcher.rb +41 -29
- data/lib/puma/minissl.rb +13 -8
- data/lib/puma/null_io.rb +1 -1
- data/lib/puma/plugin.rb +1 -10
- data/lib/puma/rack/builder.rb +0 -4
- data/lib/puma/reactor.rb +6 -1
- data/lib/puma/runner.rb +5 -34
- data/lib/puma/server.rb +70 -190
- data/lib/puma/single.rb +7 -64
- data/lib/puma/state_file.rb +5 -2
- data/lib/puma/thread_pool.rb +85 -47
- data/lib/rack/handler/puma.rb +1 -3
- data/tools/{docker/Dockerfile → Dockerfile} +0 -0
- metadata +20 -24
- data/docs/tcp_mode.md +0 -96
- data/ext/puma_http11/io_buffer.c +0 -155
- data/ext/puma_http11/org/jruby/puma/IOBuffer.java +0 -72
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d624c4973e123e4b085bd0080a85d76c996f26743dde5d8e55ca4f3971e6d77a
|
4
|
+
data.tar.gz: 8f3ebe99584b845456708a73ae5305b012058c09af0a5e75bead0322c1c8501c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1dbaeeb104fa56b185b1b647fc865a3b25eb621dba523dba15d056bef66137279fbb57545330ab3f486e610a88ed487f3ccf2e6f0b9c75de12522dc9db9b0029
|
7
|
+
data.tar.gz: 1b2f86bb5275f3764b891da8c3bc3643e1544d7209385aae8d87b5aa572945ceb627ef70df23060bc27abc9714b16377b8fa371b3ac3a10738e76cbd69f88841
|
data/History.md
CHANGED
@@ -1,31 +1,68 @@
|
|
1
|
-
##
|
1
|
+
## 5.0.0
|
2
2
|
|
3
|
-
*
|
4
|
-
*
|
5
|
-
|
6
|
-
|
3
|
+
* Features
|
4
|
+
* EXPERIMENTAL: Add `fork_worker` option and `refork` command for reduced memory usage by forking from a worker process instead of the master process. (#2099)
|
5
|
+
* EXPERIMENTAL: Added `wait_for_less_busy_worker` config. This may reduce latency on MRI through inserting a small delay before re-listening on the socket if worker is busy (#2079).
|
6
|
+
* EXPERIMENTAL: Added `nakayoshi_fork` option. Reduce memory usage in preloaded cluster-mode apps by GCing before fork and compacting, where available. (#2093, #2256)
|
7
|
+
* Added pumactl `thread-backtraces` command to print thread backtraces (#2054)
|
8
|
+
* Added incrementing `requests_count` to `Puma.stats`. (#2106)
|
9
|
+
* Increased maximum URI path length from 2048 to 8196 bytes (#2167)
|
10
|
+
* `lowlevel_error_handler` is now called during a forced threadpool shutdown, and if a callable with 3 arguments is set, we now also pass the status code (#2203)
|
11
|
+
* Faster phased restart and worker timeout (#2220)
|
12
|
+
* Added `state_permission` to config DSL to set state file permissions (#2238)
|
13
|
+
* Added `Puma.stats_hash`, which returns a stats in Hash instead of a JSON string (#2086, #2253)
|
14
|
+
|
15
|
+
* Deprecations, Removals and Breaking API Changes
|
16
|
+
* `--control` has been removed. Use `--control-url` (#1487)
|
17
|
+
* `worker_directory` has been removed. Use `directory`.
|
18
|
+
* min_threads now set by environment variables PUMA_MIN_THREADS and MIN_THREADS. (#2143)
|
19
|
+
* max_threads now set by environment variables PUMA_MAX_THREADS and MAX_THREADS. (#2143)
|
20
|
+
* max_threads default to 5 in MRI or 16 for all other interpreters. (#2143)
|
21
|
+
* preload by default if workers > 1 (#2143)
|
22
|
+
* Puma::Plugin.workers_supported? has been removed. Use Puma.forkable? instead. (#2143)
|
23
|
+
* `tcp_mode` has been removed without replacement. (#2169)
|
24
|
+
* Daemonization has been removed without replacement. (#2170)
|
25
|
+
* Changed #connected_port to #connected_ports (#2076)
|
26
|
+
* Configuration: `environment` is read from `RAILS_ENV`, if `RACK_ENV` can't be found (#2022)
|
7
27
|
|
8
28
|
* Bugfixes
|
9
|
-
*
|
29
|
+
* Do not set user_config to quiet by default to allow for file config (#2074)
|
30
|
+
* Always close SSL connection in Puma::ControlCLI (#2211)
|
31
|
+
* Windows update extconf.rb for use with ssp and varied Ruby/MSYS2 combinations (#2069)
|
32
|
+
* Ensure control server Unix socket is closed on shutdown (#2112)
|
33
|
+
* Preserve `BUNDLE_GEMFILE` env var when using `prune_bundler` (#1893)
|
34
|
+
* Send 408 request timeout even when queue requests is disabled (#2119)
|
35
|
+
* Rescue IO::WaitReadable instead of EAGAIN for blocking read (#2121)
|
36
|
+
* Ensure `BUNDLE_GEMFILE` is unspecified in workers if unspecified in master when using `prune_bundler` (#2154)
|
37
|
+
* Rescue and log exceptions in hooks defined by users (on_worker_boot, after_worker_fork etc) (#1551)
|
38
|
+
* Read directly from the socket in #read_and_drop to avoid raising further SSL errors (#2198)
|
39
|
+
* Set `Connection: closed` header when queue requests is disabled (#2216)
|
40
|
+
* Pass queued requests to thread pool on server shutdown (#2122)
|
41
|
+
* Fixed a few minor concurrency bugs in ThreadPool that may have affected non-GVL Rubies (#2220)
|
42
|
+
* Fix `out_of_band` hook never executed if the number of worker threads is > 1 (#2177)
|
43
|
+
* Fix ThreadPool#shutdown timeout accuracy (#2221)
|
44
|
+
* Fix `UserFileDefaultOptions#fetch` to properly use `default` (#2233)
|
45
|
+
* Improvements to `out_of_band` hook (#2234)
|
46
|
+
* Prefer the rackup file specified by the CLI (#2225)
|
47
|
+
|
48
|
+
* Refactor
|
49
|
+
* Remove unused loader argument from Plugin initializer (#2095)
|
50
|
+
* Simplify `Configuration.random_token` and remove insecure fallback (#2102)
|
51
|
+
* Simplify `Runner#start_control` URL parsing (#2111)
|
52
|
+
* Removed the IOBuffer extension and replaced with Ruby (#1980)
|
53
|
+
* Update `Rack::Handler::Puma.run` to use `**options` (#2189)
|
54
|
+
* ThreadPool concurrency refactoring (#2220)
|
55
|
+
* JSON parse cluster worker stats instead of regex (#2124)
|
56
|
+
* Support parallel tests in verbose progress reporting (#2223)
|
10
57
|
|
11
|
-
## 4.3.
|
58
|
+
## 4.3.3 and 3.12.4 / 2020-02-28
|
12
59
|
|
13
60
|
* Bugfixes
|
14
|
-
*
|
15
|
-
|
16
|
-
*
|
17
|
-
|
18
|
-
## 4.3.4/4.3.5 and 3.12.5/3.12.6 / 2020-05-22
|
19
|
-
|
20
|
-
Each patchlevel release contains a separate security fix. We recommend simply upgrading to 4.3.5/3.12.6.
|
21
|
-
|
22
|
-
## 4.3.3 and 3.12.4 / 2020-02-28
|
23
|
-
* Bugfixes
|
24
|
-
* Fix: Fixes a problem where we weren't splitting headers correctly on newlines (#2132)
|
25
|
-
* Security
|
26
|
-
* Fix: Prevent HTTP Response splitting via CR in early hints.
|
61
|
+
* Fix: Fixes a problem where we weren't splitting headers correctly on newlines (#2132)
|
62
|
+
* Security
|
63
|
+
* Fix: Prevent HTTP Response splitting via CR in early hints. CVE-2020-5249.
|
27
64
|
|
28
|
-
## 4.3.2 and 3.12.3 / 2020-02-27
|
65
|
+
## 4.3.2 and 3.12.3 / 2020-02-27 (YANKED)
|
29
66
|
|
30
67
|
* Security
|
31
68
|
* Fix: Prevent HTTP Response splitting via CR/LF in header values. CVE-2020-5247.
|
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
@@ -4,12 +4,11 @@
|
|
4
4
|
|
5
5
|
# Puma: A Ruby Web Server Built For Concurrency
|
6
6
|
|
7
|
-
[![
|
8
|
-
[![Actions Build Status](https://github.com/puma/puma/workflows/Puma/badge.svg)](https://github.com/puma/puma/actions)
|
9
|
-
[![Travis Build Status](https://travis-ci.org/puma/puma.svg?branch=master)](https://travis-ci.org/puma/puma)
|
7
|
+
[![Actions Build Status](https://github.com/puma/puma/workflows/CI/badge.svg?branch=master)](https://github.com/puma/puma/actions)
|
10
8
|
|
11
9
|
[![Code Climate](https://codeclimate.com/github/puma/puma.svg)](https://codeclimate.com/github/puma/puma)
|
12
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](http://img.shields.io/badge/stackoverflow-Puma-blue.svg)]( http://stackoverflow.com/questions/tagged/puma )
|
13
12
|
|
14
13
|
Puma is a **simple, fast, multi-threaded, and highly concurrent HTTP 1.1 server for Ruby/Rack applications**.
|
15
14
|
|
@@ -28,7 +27,8 @@ $ gem install puma
|
|
28
27
|
$ puma
|
29
28
|
```
|
30
29
|
|
31
|
-
Without arguments, puma will look for a rackup (.ru) file in
|
30
|
+
Without arguments, puma will look for a rackup (.ru) file in
|
31
|
+
working directory called `config.ru`.
|
32
32
|
|
33
33
|
## Frameworks
|
34
34
|
|
@@ -68,7 +68,7 @@ configure { set :server, :puma }
|
|
68
68
|
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).
|
69
69
|
|
70
70
|
You can also find several configuration examples as part of the
|
71
|
-
[test](test/config) suite.
|
71
|
+
[test](https://github.com/puma/puma/tree/master/test/config) suite.
|
72
72
|
|
73
73
|
### Thread Pool
|
74
74
|
|
@@ -78,7 +78,7 @@ Puma uses a thread pool. You can set the minimum and maximum number of threads t
|
|
78
78
|
$ puma -t 8:32
|
79
79
|
```
|
80
80
|
|
81
|
-
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 cause contention for the Global VM Lock, when using MRI).
|
81
|
+
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).
|
82
82
|
|
83
83
|
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.
|
84
84
|
|
@@ -220,7 +220,7 @@ You can also provide a configuration file with the `-C` (or `--config`) flag:
|
|
220
220
|
$ puma -C /path/to/config
|
221
221
|
```
|
222
222
|
|
223
|
-
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
|
223
|
+
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`.
|
224
224
|
|
225
225
|
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:
|
226
226
|
|
@@ -251,7 +251,7 @@ Some platforms do not support all Puma features.
|
|
251
251
|
|
252
252
|
## Known Bugs
|
253
253
|
|
254
|
-
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:
|
254
|
+
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:
|
255
255
|
|
256
256
|
```ruby
|
257
257
|
if %w(2.2.7 2.2.8 2.2.9 2.2.10 2.3.4 2.4.1).include? RUBY_VERSION
|
@@ -270,16 +270,22 @@ It is common to use process monitors with Puma. Modern process monitors like sys
|
|
270
270
|
provide continuous monitoring and restarts for increased
|
271
271
|
reliability in production environments:
|
272
272
|
|
273
|
-
* [
|
273
|
+
* [docs/jungle](https://github.com/puma/puma/tree/master/docs/jungle) for rc.d and upstart
|
274
274
|
* [docs/systemd](https://github.com/puma/puma/blob/master/docs/systemd.md)
|
275
275
|
|
276
|
-
## Community
|
276
|
+
## Community Extensions
|
277
277
|
|
278
|
-
|
278
|
+
### Plugins
|
279
|
+
|
280
|
+
* [puma-heroku](https://github.com/puma/puma-heroku) — default Puma configuration for running on Heroku
|
279
281
|
* [puma-metrics](https://github.com/harmjanblok/puma-metrics) — export Puma metrics to Prometheus
|
280
282
|
* [puma-plugin-statsd](https://github.com/yob/puma-plugin-statsd) — send Puma metrics to statsd
|
281
283
|
* [puma-plugin-systemd](https://github.com/sj26/puma-plugin-systemd) — deeper integration with systemd for notify, status and watchdog
|
282
284
|
|
285
|
+
### Monitoring
|
286
|
+
|
287
|
+
* [puma-status](https://github.com/ylecuyer/puma-status) — Monitor CPU/Mem/Load of running puma instances from the CLI
|
288
|
+
|
283
289
|
## Contributing
|
284
290
|
|
285
291
|
Find details for contributing in the [contribution guide].
|
data/docs/deployment.md
CHANGED
@@ -74,7 +74,9 @@ thread to become available.
|
|
74
74
|
* haproxy: `%Th` (TLS handshake time) and `%Ti` (idle time before request) can
|
75
75
|
can also be added as headers.
|
76
76
|
|
77
|
-
##
|
77
|
+
## Should I daemonize?
|
78
|
+
|
79
|
+
Daemonization was removed in Puma 5.0. For alternatives, continue reading.
|
78
80
|
|
79
81
|
I prefer to not daemonize my servers and use something like `runit` or `upstart` to
|
80
82
|
monitor them as child processes. This gives them fast response to crashes and
|
data/docs/fork_worker.md
ADDED
@@ -0,0 +1,31 @@
|
|
1
|
+
# Fork-Worker Cluster Mode [Experimental]
|
2
|
+
|
3
|
+
Puma 5 introduces an experimental new cluster-mode configuration option, `fork_worker` (`--fork-worker` from the CLI). This mode causes Puma to fork additional workers from worker 0, instead of directly from the master process:
|
4
|
+
|
5
|
+
```
|
6
|
+
10000 \_ puma 4.3.3 (tcp://0.0.0.0:9292) [puma]
|
7
|
+
10001 \_ puma: cluster worker 0: 10000 [puma]
|
8
|
+
10002 \_ puma: cluster worker 1: 10000 [puma]
|
9
|
+
10003 \_ puma: cluster worker 2: 10000 [puma]
|
10
|
+
10004 \_ puma: cluster worker 3: 10000 [puma]
|
11
|
+
```
|
12
|
+
|
13
|
+
Similar to the `preload_app!` option, the `fork_worker` option allows your application to be initialized only once for copy-on-write memory savings, and it has two additional advantages:
|
14
|
+
|
15
|
+
1. **Compatible with phased restart.** Because the master process itself doesn't preload the application, this mode works with phased restart (`SIGUSR1` or `pumactl phased-restart`). When worker 0 reloads as part of a phased restart, it initializes a new copy of your application first, then the other workers reload by forking from this new worker already containing the new preloaded application.
|
16
|
+
|
17
|
+
This allows a phased restart to complete as quickly as a hot restart (`SIGUSR2` or `pumactl restart`), while still minimizing downtime by staggering the restart across cluster workers.
|
18
|
+
|
19
|
+
2. **'Refork' for additional copy-on-write improvements in running applications.** Fork-worker mode introduces a new `refork` command that re-loads all nonzero workers by re-forking them from worker 0.
|
20
|
+
|
21
|
+
This command can potentially improve memory utilization in large or complex applications that don't fully pre-initialize on startup, because the re-forked workers can share copy-on-write memory with a worker that has been running for a while and serving requests.
|
22
|
+
|
23
|
+
You can trigger a refork by sending the cluster the `SIGURG` signal or running the `pumactl refork` command at any time. A refork will also automatically trigger once, after a certain number of requests have been processed by worker 0 (default 1000). To configure the number of requests before the auto-refork, pass a positive integer argument to `fork_worker` (e.g., `fork_worker 1000`), or `0` to disable.
|
24
|
+
|
25
|
+
### Limitations
|
26
|
+
|
27
|
+
- This mode is still very experimental so there may be bugs or edge-cases, particularly around expected behavior of existing hooks. Please open a [bug report](https://github.com/puma/puma/issues/new?template=bug_report.md) if you encounter any issues.
|
28
|
+
|
29
|
+
- In order to fork new workers cleanly, worker 0 shuts down its server and stops serving requests so there are no open file descriptors or other kinds of shared global state between processes, and to maximize copy-on-write efficiency across the newly-forked workers. This may temporarily reduce total capacity of the cluster during a phased restart / refork.
|
30
|
+
|
31
|
+
In a cluster with `n` workers, a normal phased restart stops and restarts workers one by one while the application is loaded in each process, so `n-1` workers are available serving requests during the restart. In a phased restart in fork-worker mode, the application is first loaded in worker 0 while `n-1` workers are available, then worker 0 remains stopped while the rest of the workers are reloaded one by one, leaving only `n-2` workers to be available for a brief period of time. Reloading the rest of the workers should be quick because the application is preloaded at that point, but there may be situations where it can take longer (slow clients, long-running application code, slow worker-fork hooks, etc).
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# Puma as a service
|
2
|
+
|
3
|
+
## Upstart
|
4
|
+
|
5
|
+
See `/docs/jungle/upstart` for Ubuntu's upstart scripts.
|
6
|
+
|
7
|
+
## Systemd
|
8
|
+
|
9
|
+
See [/docs/systemd](https://github.com/puma/puma/blob/master/docs/systemd.md).
|
10
|
+
|
11
|
+
## rc.d
|
12
|
+
|
13
|
+
See `/docs/jungle/rc.d` for FreeBSD's rc.d scripts
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
data/docs/signals.md
CHANGED
@@ -41,6 +41,7 @@ Puma cluster responds to these signals:
|
|
41
41
|
- `HUP` reopen log files defined in stdout_redirect configuration parameter. If there is no stdout_redirect option provided it will behave like `INT`
|
42
42
|
- `INT` equivalent of sending Ctrl-C to cluster. Will attempt to finish then exit.
|
43
43
|
- `CHLD`
|
44
|
+
- `URG` refork workers in phases from worker 0, if `fork_workers` option is enabled.
|
44
45
|
|
45
46
|
## Callbacks order in case of different signals
|
46
47
|
|
data/docs/systemd.md
CHANGED
@@ -13,9 +13,7 @@ desired, using an application or instance specific name.
|
|
13
13
|
|
14
14
|
Note that this uses the systemd preferred "simple" type where the
|
15
15
|
start command remains running in the foreground (does not fork and
|
16
|
-
exit).
|
17
|
-
[Alternative Forking Configuration](#alternative-forking-configuration)
|
18
|
-
below.
|
16
|
+
exit).
|
19
17
|
|
20
18
|
~~~~ ini
|
21
19
|
[Unit]
|
@@ -209,66 +207,6 @@ Apr 07 08:40:19 hx puma[28320]: * Activated ssl://0.0.0.0:9234?key=key.pem&cert=
|
|
209
207
|
Apr 07 08:40:19 hx puma[28320]: Use Ctrl-C to stop
|
210
208
|
~~~~
|
211
209
|
|
212
|
-
## Alternative Forking Configuration
|
213
|
-
|
214
|
-
Other systems/tools might expect or need puma to be run as a
|
215
|
-
"traditional" forking server, for example so that the `pumactl`
|
216
|
-
command can be used directly and outside of systemd for
|
217
|
-
stop/start/restart. This use case is incompatible with systemd socket
|
218
|
-
activation, so it should not be configured. Below is an alternative
|
219
|
-
puma.service config sample, using `Type=forking` and the `--daemon`
|
220
|
-
flag in `ExecStart`. Here systemd is playing a role more equivalent to
|
221
|
-
SysV init.d, where it is responsible for starting Puma on boot
|
222
|
-
(multi-user.target) and stopping it on shutdown, but is not performing
|
223
|
-
continuous restarts. Therefore running Puma in cluster mode, where the
|
224
|
-
master can restart workers, is highly recommended. See the systemd
|
225
|
-
[Restart] directive for details.
|
226
|
-
|
227
|
-
~~~~ ini
|
228
|
-
[Unit]
|
229
|
-
Description=Puma HTTP Forking Server
|
230
|
-
After=network.target
|
231
|
-
|
232
|
-
[Service]
|
233
|
-
# Background process configuration (use with --daemon in ExecStart)
|
234
|
-
Type=forking
|
235
|
-
|
236
|
-
# Preferably configure a non-privileged user
|
237
|
-
# User=
|
238
|
-
|
239
|
-
# The path to the puma application root
|
240
|
-
# Also replace the "<WD>" place holders below with this path.
|
241
|
-
WorkingDirectory=
|
242
|
-
|
243
|
-
# The command to start Puma
|
244
|
-
# (replace "<WD>" below)
|
245
|
-
ExecStart=bundle exec puma -C <WD>/shared/puma.rb --daemon
|
246
|
-
|
247
|
-
# The command to stop Puma
|
248
|
-
# (replace "<WD>" below)
|
249
|
-
ExecStop=bundle exec pumactl -S <WD>/shared/tmp/pids/puma.state stop
|
250
|
-
|
251
|
-
# Path to PID file so that systemd knows which is the master process
|
252
|
-
PIDFile=<WD>/shared/tmp/pids/puma.pid
|
253
|
-
|
254
|
-
# Should systemd restart puma?
|
255
|
-
# Use "no" (the default) to ensure no interference when using
|
256
|
-
# stop/start/restart via `pumactl`. The "on-failure" setting might
|
257
|
-
# work better for this purpose, but you must test it.
|
258
|
-
# Use "always" if only `systemctl` is used for start/stop/restart, and
|
259
|
-
# reconsider if you actually need the forking config.
|
260
|
-
Restart=no
|
261
|
-
|
262
|
-
# `puma_ctl restart` wouldn't work without this. It's because `pumactl`
|
263
|
-
# changes PID on restart and systemd stops the service afterwards
|
264
|
-
# because of the PID change. This option prevents stopping after PID
|
265
|
-
# change.
|
266
|
-
RemainAfterExit=yes
|
267
|
-
|
268
|
-
[Install]
|
269
|
-
WantedBy=multi-user.target
|
270
|
-
~~~~
|
271
|
-
|
272
210
|
### capistrano3-puma
|
273
211
|
|
274
212
|
By default,
|
@@ -1,18 +1,16 @@
|
|
1
1
|
package puma;
|
2
2
|
|
3
3
|
import java.io.IOException;
|
4
|
-
|
4
|
+
|
5
5
|
import org.jruby.Ruby;
|
6
6
|
import org.jruby.runtime.load.BasicLibraryService;
|
7
7
|
|
8
8
|
import org.jruby.puma.Http11;
|
9
|
-
import org.jruby.puma.IOBuffer;
|
10
9
|
import org.jruby.puma.MiniSSL;
|
11
10
|
|
12
|
-
public class PumaHttp11Service implements BasicLibraryService {
|
11
|
+
public class PumaHttp11Service implements BasicLibraryService {
|
13
12
|
public boolean basicLoad(final Ruby runtime) throws IOException {
|
14
13
|
Http11.createHttp11(runtime);
|
15
|
-
IOBuffer.createIOBuffer(runtime);
|
16
14
|
MiniSSL.createMiniSSL(runtime);
|
17
15
|
return true;
|
18
16
|
}
|
data/ext/puma_http11/extconf.rb
CHANGED
@@ -1,9 +1,10 @@
|
|
1
1
|
require 'mkmf'
|
2
2
|
|
3
3
|
dir_config("puma_http11")
|
4
|
+
|
4
5
|
if $mingw && RUBY_VERSION >= '2.4'
|
5
|
-
append_cflags
|
6
|
-
append_ldflags '-fstack-protector'
|
6
|
+
append_cflags '-fstack-protector-strong -D_FORTIFY_SOURCE=2'
|
7
|
+
append_ldflags '-fstack-protector-strong -l:libssp.a'
|
7
8
|
have_library 'ssp'
|
8
9
|
end
|
9
10
|
|
@@ -14,14 +14,12 @@
|
|
14
14
|
|
15
15
|
/*
|
16
16
|
* capitalizes all lower-case ASCII characters,
|
17
|
-
* converts dashes to underscores
|
17
|
+
* converts dashes to underscores.
|
18
18
|
*/
|
19
19
|
static void snake_upcase_char(char *c)
|
20
20
|
{
|
21
21
|
if (*c >= 'a' && *c <= 'z')
|
22
22
|
*c &= ~0x20;
|
23
|
-
else if (*c == '_')
|
24
|
-
*c = ',';
|
25
23
|
else if (*c == '-')
|
26
24
|
*c = '_';
|
27
25
|
}
|