puma 4.3.12 → 6.3.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.

Files changed (96) hide show
  1. checksums.yaml +4 -4
  2. data/History.md +1729 -521
  3. data/LICENSE +23 -20
  4. data/README.md +169 -45
  5. data/bin/puma-wild +3 -9
  6. data/docs/architecture.md +63 -26
  7. data/docs/compile_options.md +55 -0
  8. data/docs/deployment.md +60 -69
  9. data/docs/fork_worker.md +31 -0
  10. data/docs/images/puma-connection-flow-no-reactor.png +0 -0
  11. data/docs/images/puma-connection-flow.png +0 -0
  12. data/docs/images/puma-general-arch.png +0 -0
  13. data/docs/jungle/README.md +9 -0
  14. data/{tools → docs}/jungle/rc.d/README.md +1 -1
  15. data/{tools → docs}/jungle/rc.d/puma +2 -2
  16. data/{tools → docs}/jungle/rc.d/puma.conf +0 -0
  17. data/docs/kubernetes.md +66 -0
  18. data/docs/nginx.md +2 -2
  19. data/docs/plugins.md +15 -15
  20. data/docs/rails_dev_mode.md +28 -0
  21. data/docs/restart.md +46 -23
  22. data/docs/signals.md +13 -11
  23. data/docs/stats.md +142 -0
  24. data/docs/systemd.md +84 -128
  25. data/docs/testing_benchmarks_local_files.md +150 -0
  26. data/docs/testing_test_rackup_ci_files.md +36 -0
  27. data/ext/puma_http11/PumaHttp11Service.java +2 -4
  28. data/ext/puma_http11/ext_help.h +1 -1
  29. data/ext/puma_http11/extconf.rb +49 -12
  30. data/ext/puma_http11/http11_parser.c +46 -48
  31. data/ext/puma_http11/http11_parser.h +2 -2
  32. data/ext/puma_http11/http11_parser.java.rl +3 -3
  33. data/ext/puma_http11/http11_parser.rl +3 -3
  34. data/ext/puma_http11/http11_parser_common.rl +2 -2
  35. data/ext/puma_http11/mini_ssl.c +278 -93
  36. data/ext/puma_http11/no_ssl/PumaHttp11Service.java +15 -0
  37. data/ext/puma_http11/org/jruby/puma/Http11.java +6 -6
  38. data/ext/puma_http11/org/jruby/puma/Http11Parser.java +4 -6
  39. data/ext/puma_http11/org/jruby/puma/MiniSSL.java +241 -96
  40. data/ext/puma_http11/puma_http11.c +46 -57
  41. data/lib/puma/app/status.rb +53 -39
  42. data/lib/puma/binder.rb +237 -121
  43. data/lib/puma/cli.rb +34 -34
  44. data/lib/puma/client.rb +172 -98
  45. data/lib/puma/cluster/worker.rb +180 -0
  46. data/lib/puma/cluster/worker_handle.rb +97 -0
  47. data/lib/puma/cluster.rb +226 -231
  48. data/lib/puma/commonlogger.rb +21 -14
  49. data/lib/puma/configuration.rb +114 -87
  50. data/lib/puma/const.rb +139 -95
  51. data/lib/puma/control_cli.rb +99 -79
  52. data/lib/puma/detect.rb +33 -2
  53. data/lib/puma/dsl.rb +516 -110
  54. data/lib/puma/error_logger.rb +113 -0
  55. data/lib/puma/events.rb +16 -115
  56. data/lib/puma/io_buffer.rb +44 -2
  57. data/lib/puma/jruby_restart.rb +2 -59
  58. data/lib/puma/json_serialization.rb +96 -0
  59. data/lib/puma/launcher/bundle_pruner.rb +104 -0
  60. data/lib/puma/launcher.rb +164 -155
  61. data/lib/puma/log_writer.rb +147 -0
  62. data/lib/puma/minissl/context_builder.rb +36 -19
  63. data/lib/puma/minissl.rb +230 -55
  64. data/lib/puma/null_io.rb +18 -1
  65. data/lib/puma/plugin/systemd.rb +90 -0
  66. data/lib/puma/plugin/tmp_restart.rb +1 -1
  67. data/lib/puma/plugin.rb +3 -12
  68. data/lib/puma/rack/builder.rb +7 -11
  69. data/lib/puma/rack/urlmap.rb +0 -0
  70. data/lib/puma/rack_default.rb +19 -4
  71. data/lib/puma/reactor.rb +93 -368
  72. data/lib/puma/request.rb +671 -0
  73. data/lib/puma/runner.rb +92 -75
  74. data/lib/puma/sd_notify.rb +149 -0
  75. data/lib/puma/server.rb +321 -794
  76. data/lib/puma/single.rb +20 -74
  77. data/lib/puma/state_file.rb +45 -8
  78. data/lib/puma/thread_pool.rb +140 -68
  79. data/lib/puma/util.rb +21 -4
  80. data/lib/puma.rb +54 -7
  81. data/lib/rack/handler/puma.rb +113 -87
  82. data/tools/{docker/Dockerfile → Dockerfile} +1 -1
  83. data/tools/trickletest.rb +0 -0
  84. metadata +33 -24
  85. data/docs/tcp_mode.md +0 -96
  86. data/ext/puma_http11/io_buffer.c +0 -155
  87. data/ext/puma_http11/org/jruby/puma/IOBuffer.java +0 -72
  88. data/lib/puma/accept_nonblock.rb +0 -29
  89. data/lib/puma/tcp_logger.rb +0 -41
  90. data/tools/jungle/README.md +0 -19
  91. data/tools/jungle/init.d/README.md +0 -61
  92. data/tools/jungle/init.d/puma +0 -421
  93. data/tools/jungle/init.d/run-puma +0 -18
  94. data/tools/jungle/upstart/README.md +0 -61
  95. data/tools/jungle/upstart/puma-manager.conf +0 -31
  96. data/tools/jungle/upstart/puma.conf +0 -69
data/docs/stats.md ADDED
@@ -0,0 +1,142 @@
1
+ ## Accessing stats
2
+
3
+ Stats can be accessed in two ways:
4
+
5
+ ### control server
6
+
7
+ `$ pumactl stats` or `GET /stats`
8
+
9
+ [Read more about `pumactl` and the control server in the README.](https://github.com/puma/puma#controlstatus-server).
10
+
11
+ ### Puma.stats
12
+
13
+ `Puma.stats` produces a JSON string. `Puma.stats_hash` produces a ruby hash.
14
+
15
+ #### in single mode
16
+
17
+ Invoke `Puma.stats` anywhere in runtime, e.g. in a rails initializer:
18
+
19
+ ```ruby
20
+ # config/initializers/puma_stats.rb
21
+
22
+ Thread.new do
23
+ loop do
24
+ sleep 30
25
+ puts Puma.stats
26
+ end
27
+ end
28
+ ```
29
+
30
+ #### in cluster mode
31
+
32
+ Invoke `Puma.stats` from the master process
33
+
34
+ ```ruby
35
+ # config/puma.rb
36
+
37
+ before_fork do
38
+ Thread.new do
39
+ loop do
40
+ puts Puma.stats
41
+ sleep 30
42
+ end
43
+ end
44
+ end
45
+ ```
46
+
47
+
48
+ ## Explanation of stats
49
+
50
+ `Puma.stats` returns different information and a different structure depending on if Puma is in single vs. cluster mode. There is one top-level attribute that is common to both modes:
51
+
52
+ * started_at: when Puma was started
53
+
54
+ ### single mode and individual workers in cluster mode
55
+
56
+ When Puma runs in single mode, these stats are available at the top level. When Puma runs in cluster mode, these stats are available within the `worker_status` array in a hash labeled `last_status`, in an array of hashes where one hash represents each worker.
57
+
58
+ * backlog: requests that are waiting for an available thread to be available. if this is above 0, you need more capacity [always true?]
59
+ * running: how many threads are running
60
+ * pool_capacity: the number of requests that the server is capable of taking right now. For example, if the number is 5, then it means there are 5 threads sitting idle ready to take a request. If one request comes in, then the value would be 4 until it finishes processing. If the minimum threads allowed is zero, this number will still have a maximum value of the maximum threads allowed.
61
+ * max_threads: the maximum number of threads Puma is configured to spool per worker
62
+ * requests_count: the number of requests this worker has served since starting
63
+
64
+
65
+ ### cluster mode
66
+
67
+ * phase: which phase of restart the process is in, during [phased restart](https://github.com/puma/puma/blob/master/docs/restart.md)
68
+ * workers: ??
69
+ * booted_workers: how many workers currently running?
70
+ * old_workers: ??
71
+ * worker_status: array of hashes of info for each worker (see below)
72
+
73
+ ### worker status
74
+
75
+ * started_at: when the worker started
76
+ * pid: the process id of the worker process
77
+ * index: each worker gets a number. if Puma is configured to have 3 workers, then this will be 0, 1, or 2
78
+ * booted: if it's done booting [?]
79
+ * last_checkin: Last time the worker responded to the master process' heartbeat check.
80
+ * last_status: a hash of info about the worker's state handling requests. See the explanation for this in "single mode and individual workers in cluster mode" section above.
81
+
82
+
83
+ ## Examples
84
+
85
+ Here are two example stats hashes produced by `Puma.stats`:
86
+
87
+ ### single
88
+
89
+ ```json
90
+ {
91
+ "started_at": "2021-01-14T07:12:35Z",
92
+ "backlog": 0,
93
+ "running": 5,
94
+ "pool_capacity": 5,
95
+ "max_threads": 5,
96
+ "requests_count": 3
97
+ }
98
+ ```
99
+
100
+ ### cluster
101
+
102
+ ```json
103
+ {
104
+ "started_at": "2021-01-14T07:09:17Z",
105
+ "workers": 2,
106
+ "phase": 0,
107
+ "booted_workers": 2,
108
+ "old_workers": 0,
109
+ "worker_status": [
110
+ {
111
+ "started_at": "2021-01-14T07:09:24Z",
112
+ "pid": 64136,
113
+ "index": 0,
114
+ "phase": 0,
115
+ "booted": true,
116
+ "last_checkin": "2021-01-14T07:11:09Z",
117
+ "last_status": {
118
+ "backlog": 0,
119
+ "running": 5,
120
+ "pool_capacity": 5,
121
+ "max_threads": 5,
122
+ "requests_count": 2
123
+ }
124
+ },
125
+ {
126
+ "started_at": "2021-01-14T07:09:24Z",
127
+ "pid": 64137,
128
+ "index": 1,
129
+ "phase": 0,
130
+ "booted": true,
131
+ "last_checkin": "2021-01-14T07:11:09Z",
132
+ "last_status": {
133
+ "backlog": 0,
134
+ "running": 5,
135
+ "pool_capacity": 5,
136
+ "max_threads": 5,
137
+ "requests_count": 1
138
+ }
139
+ }
140
+ ]
141
+ }
142
+ ```
data/docs/systemd.md CHANGED
@@ -1,21 +1,18 @@
1
1
  # systemd
2
2
 
3
- [systemd](https://www.freedesktop.org/wiki/Software/systemd/) is a
4
- commonly available init system (PID 1) on many Linux distributions. It
5
- offers process monitoring (including automatic restarts) and other
6
- useful features for running Puma in production.
3
+ [systemd](https://www.freedesktop.org/wiki/Software/systemd/) is a commonly
4
+ available init system (PID 1) on many Linux distributions. It offers process
5
+ monitoring (including automatic restarts) and other useful features for running
6
+ Puma in production.
7
7
 
8
8
  ## Service Configuration
9
9
 
10
- Below is a sample puma.service configuration file for systemd, which
11
- can be copied or symlinked to /etc/systemd/system/puma.service, or if
12
- desired, using an application or instance specific name.
10
+ Below is a sample puma.service configuration file for systemd, which can be
11
+ copied or symlinked to `/etc/systemd/system/puma.service`, or if desired, using
12
+ an application or instance-specific name.
13
13
 
14
- Note that this uses the systemd preferred "simple" type where the
15
- start command remains running in the foreground (does not fork and
16
- exit). See also, the
17
- [Alternative Forking Configuration](#alternative-forking-configuration)
18
- below.
14
+ Note that this uses the systemd preferred "simple" type where the start command
15
+ remains running in the foreground (does not fork and exit).
19
16
 
20
17
  ~~~~ ini
21
18
  [Unit]
@@ -26,14 +23,20 @@ After=network.target
26
23
  # Requires=puma.socket
27
24
 
28
25
  [Service]
29
- # Foreground process (do not use --daemon in ExecStart or config.rb)
30
- Type=simple
26
+ # Puma supports systemd's `Type=notify` and watchdog service
27
+ # monitoring, as of Puma 5.1 or later.
28
+ # On earlier versions of Puma or JRuby, change this to `Type=simple` and remove
29
+ # the `WatchdogSec` line.
30
+ Type=notify
31
+
32
+ # If your Puma process locks up, systemd's watchdog will restart it within seconds.
33
+ WatchdogSec=10
31
34
 
32
35
  # Preferably configure a non-privileged user
33
36
  # User=
34
37
 
35
- # The path to the your application code root directory.
36
- # Also replace the "<YOUR_APP_PATH>" place holders below with this path.
38
+ # The path to your application code root directory.
39
+ # Also replace the "<YOUR_APP_PATH>" placeholders below with this path.
37
40
  # Example /home/username/myapp
38
41
  WorkingDirectory=<YOUR_APP_PATH>
39
42
 
@@ -59,33 +62,31 @@ Restart=always
59
62
  WantedBy=multi-user.target
60
63
  ~~~~
61
64
 
62
- See [systemd.exec](https://www.freedesktop.org/software/systemd/man/systemd.exec.html)
65
+ See
66
+ [systemd.exec](https://www.freedesktop.org/software/systemd/man/systemd.exec.html)
63
67
  for additional details.
64
68
 
65
69
  ## Socket Activation
66
70
 
67
- systemd and puma also support socket activation, where systemd opens
68
- the listening socket(s) in advance and provides them to the puma
69
- master process on startup. Among other advantages, this keeps
70
- listening sockets open across puma restarts and achieves graceful
71
- restarts, including when upgraded puma, and is compatible with both
72
- clustered mode and application preload.
73
-
74
- **Note:** Any wrapper scripts which `exec`, or other indirections in
75
- `ExecStart`, may result in activated socket file descriptors being closed
76
- before they reach the puma master process. For example, if using `bundle exec`,
77
- pass the `--keep-file-descriptors` flag. `bundle exec` can be avoided by using a
78
- `puma` executable generated by `bundle binstubs puma`. This is tracked in
79
- [#1499].
80
-
81
- **Note:** Socket activation doesn't currently work on jruby. This is
82
- tracked in [#1367].
83
-
84
- To use socket activation, configure one or more `ListenStream` sockets
85
- in a companion `*.socket` unit file. Also uncomment the associated
86
- `Requires` directive for the socket unit in the service file (see
87
- above.) Here is a sample puma.socket, matching the ports used in the
88
- above puma.service:
71
+ systemd and Puma also support socket activation, where systemd opens the
72
+ listening socket(s) in advance and provides them to the Puma master process on
73
+ startup. Among other advantages, this keeps listening sockets open across puma
74
+ restarts and achieves graceful restarts, including when upgraded Puma, and is
75
+ compatible with both clustered mode and application preload.
76
+
77
+ **Note:** Any wrapper scripts which `exec`, or other indirections in `ExecStart`
78
+ may result in activated socket file descriptors being closed before reaching the
79
+ puma master process. For example, if using `bundle exec`, pass the
80
+ `--keep-file-descriptors` flag. `bundle exec` can be avoided by using a `puma`
81
+ executable generated by `bundle binstubs puma`. This is tracked in [#1499].
82
+
83
+ **Note:** Socket activation doesn't currently work on JRuby. This is tracked in
84
+ [#1367].
85
+
86
+ Configure one or more `ListenStream` sockets in a companion `*.socket` unit file
87
+ to use socket activation. Also, uncomment the associated `Requires` directive
88
+ for the socket unit in the service file (see above.) Here is a sample
89
+ puma.socket, matching the ports used in the above puma.service:
89
90
 
90
91
  ~~~~ ini
91
92
  [Unit]
@@ -108,26 +109,42 @@ Backlog=1024
108
109
  WantedBy=sockets.target
109
110
  ~~~~
110
111
 
111
- See [systemd.socket](https://www.freedesktop.org/software/systemd/man/systemd.socket.html)
112
+ See
113
+ [systemd.socket](https://www.freedesktop.org/software/systemd/man/systemd.socket.html)
112
114
  for additional configuration details.
113
115
 
114
- Note that the above configurations will work with Puma in either
115
- single process or cluster mode.
116
+ Note that the above configurations will work with Puma in either single process
117
+ or cluster mode.
116
118
 
117
119
  ### Sockets and symlinks
118
120
 
119
- When using releases folders, you should set the socket path using the
120
- shared folder path (ex. `/srv/projet/shared/tmp/puma.sock`), not the
121
- release folder path (`/srv/projet/releases/1234/tmp/puma.sock`).
121
+ When using releases folders, you should set the socket path using the shared
122
+ folder path (ex. `/srv/projet/shared/tmp/puma.sock`), not the release folder
123
+ path (`/srv/projet/releases/1234/tmp/puma.sock`).
122
124
 
123
125
  Puma will detect the release path socket as different than the one provided by
124
- systemd and attempt to bind it again, resulting in the exception
125
- `There is already a server bound to:`.
126
+ systemd and attempt to bind it again, resulting in the exception `There is
127
+ already a server bound to:`.
128
+
129
+ ### Binding
130
+
131
+ By default, you need to configure Puma to have binds matching with all
132
+ ListenStream statements. Any mismatched systemd ListenStreams will be closed by
133
+ Puma.
134
+
135
+ To automatically bind to all activated sockets, the option
136
+ `--bind-to-activated-sockets` can be used. This matches the config DSL
137
+ `bind_to_activated_sockets` statement. This will cause Puma to create a bind
138
+ automatically for any activated socket. When systemd socket activation is not
139
+ enabled, this option does nothing.
140
+
141
+ This also accepts an optional argument `only` (DSL: `'only'`) to discard any
142
+ binds that's not socket activated.
126
143
 
127
144
  ## Usage
128
145
 
129
- Without socket activation, use `systemctl` as root (e.g. via `sudo`) as
130
- with other system services:
146
+ Without socket activation, use `systemctl` as root (i.e., via `sudo`) as with
147
+ other system services:
131
148
 
132
149
  ~~~~ sh
133
150
  # After installing or making changes to puma.service
@@ -136,35 +153,35 @@ systemctl daemon-reload
136
153
  # Enable so it starts on boot
137
154
  systemctl enable puma.service
138
155
 
139
- # Initial start up.
156
+ # Initial startup.
140
157
  systemctl start puma.service
141
158
 
142
159
  # Check status
143
160
  systemctl status puma.service
144
161
 
145
- # A normal restart. Warning: listeners sockets will be closed
162
+ # A normal restart. Warning: listener's sockets will be closed
146
163
  # while a new puma process initializes.
147
164
  systemctl restart puma.service
148
165
  ~~~~
149
166
 
150
- With socket activation, several but not all of these commands should
151
- be run for both socket and service:
167
+ With socket activation, several but not all of these commands should be run for
168
+ both socket and service:
152
169
 
153
170
  ~~~~ sh
154
171
  # After installing or making changes to either puma.socket or
155
172
  # puma.service.
156
173
  systemctl daemon-reload
157
174
 
158
- # Enable both socket and service so they start on boot. Alternatively
159
- # you could leave puma.service disabled and systemd will start it on
160
- # first use (with startup lag on first request)
175
+ # Enable both socket and service, so they start on boot. Alternatively
176
+ # you could leave puma.service disabled, and systemd will start it on
177
+ # the first use (with startup lag on the first request)
161
178
  systemctl enable puma.socket puma.service
162
179
 
163
- # Initial start up. The Requires directive (see above) ensures the
180
+ # Initial startup. The Requires directive (see above) ensures the
164
181
  # socket is started before the service.
165
182
  systemctl start puma.socket puma.service
166
183
 
167
- # Check status of both socket and service.
184
+ # Check the status of both socket and service.
168
185
  systemctl status puma.socket puma.service
169
186
 
170
187
  # A "hot" restart, with systemd keeping puma.socket listening and
@@ -177,8 +194,8 @@ systemctl restart puma.service
177
194
  systemctl restart puma.socket puma.service
178
195
  ~~~~
179
196
 
180
- Here is sample output from `systemctl status` with both service and
181
- socket running:
197
+ Here is sample output from `systemctl status` with both service and socket
198
+ running:
182
199
 
183
200
  ~~~~
184
201
  ● puma.socket - Puma HTTP Server Accept Sockets
@@ -209,76 +226,14 @@ Apr 07 08:40:19 hx puma[28320]: * Activated ssl://0.0.0.0:9234?key=key.pem&cert=
209
226
  Apr 07 08:40:19 hx puma[28320]: Use Ctrl-C to stop
210
227
  ~~~~
211
228
 
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
229
  ### capistrano3-puma
273
230
 
274
- By default,
275
- [capistrano3-puma](https://github.com/seuros/capistrano-puma) uses
276
- `pumactl` for deployment restarts, outside of systemd. To learn the
277
- exact commands that this tool would use for `ExecStart` and
278
- `ExecStop`, use the following `cap` commands in dry-run mode, and
279
- update from the above forking service configuration accordingly. Note
280
- also that the configured `User` should likely be the same as the
281
- capistrano3-puma `:puma_user` option.
231
+ By default, [capistrano3-puma](https://github.com/seuros/capistrano-puma) uses
232
+ `pumactl` for deployment restarts outside of systemd. To learn the exact
233
+ commands that this tool would use for `ExecStart` and `ExecStop`, use the
234
+ following `cap` commands in dry-run mode, and update from the above forking
235
+ service configuration accordingly. Note also that the configured `User` should
236
+ likely be the same as the capistrano3-puma `:puma_user` option.
282
237
 
283
238
  ~~~~ sh
284
239
  stage=production # or different stage, as needed
@@ -288,3 +243,4 @@ cap $stage puma:stop --dry-run
288
243
 
289
244
  [Restart]: https://www.freedesktop.org/software/systemd/man/systemd.service.html#Restart=
290
245
  [#1367]: https://github.com/puma/puma/issues/1367
246
+ [#1499]: https://github.com/puma/puma/issues/1499
@@ -0,0 +1,150 @@
1
+ # Testing - benchmark/local files
2
+
3
+ These files generate data that shows request-per-second (RPS), etc. Typically, files are in
4
+ pairs, a shell script and a Ruby script. The shell script starts the server, then runs the
5
+ Ruby file, which starts client request stream(s), then collects and logs metrics.
6
+
7
+ ## response_time_wrk.sh
8
+
9
+ This uses [wrk] for generating data. One or more wrk runs are performed. Summarizes RPS and
10
+ wrk latency times. The default for the `-b` argument runs 28 different client request streams,
11
+ and takes a bit over 5 minutes. See 'Request Stream Configuration' below for `-b` argument
12
+ description.
13
+
14
+ <details>
15
+ <summary>Summary output for<br/><code>benchmarks/local/response_time_wrk.sh -w2 -t5:5 -s tcp6</code>:</summary>
16
+
17
+ ```
18
+ Type req/sec 50% 75% 90% 99% 100% Resp Size
19
+ ───────────────────────────────────────────────────────────────── 1kB
20
+ array 13710 0.74 2.52 5.23 7.76 37.45 1024
21
+ chunk 13502 0.76 2.55 5.28 7.84 11.23 1042
22
+ string 13794 0.74 2.51 5.20 7.75 14.07 1024
23
+ io 9615 1.16 3.45 7.13 10.57 15.75 1024
24
+ ───────────────────────────────────────────────────────────────── 10kB
25
+ array 13458 0.76 2.57 5.31 7.93 13.94 10239
26
+ chunk 13066 0.78 2.64 5.46 8.18 38.48 10320
27
+ string 13500 0.76 2.55 5.29 7.88 11.42 10240
28
+ io 9293 1.18 3.59 7.39 10.94 16.99 10240
29
+ ───────────────────────────────────────────────────────────────── 100kB
30
+ array 11315 0.96 3.06 6.33 9.49 17.69 102424
31
+ chunk 9916 1.10 3.48 7.20 10.73 15.14 103075
32
+ string 10948 1.00 3.17 6.57 9.83 17.88 102378
33
+ io 8901 1.21 3.72 7.48 11.27 59.98 102407
34
+ ───────────────────────────────────────────────────────────────── 256kB
35
+ array 9217 1.15 3.82 7.88 11.74 17.12 262212
36
+ chunk 7339 1.45 4.76 9.81 14.63 22.70 264007
37
+ string 8574 1.19 3.81 7.73 11.21 15.80 262147
38
+ io 8911 1.19 3.80 7.55 15.25 60.01 262183
39
+ ───────────────────────────────────────────────────────────────── 512kB
40
+ array 6951 1.49 5.03 10.28 15.90 25.08 524378
41
+ chunk 5234 2.03 6.56 13.57 20.46 32.15 527862
42
+ string 6438 1.55 5.04 10.12 16.28 72.87 524275
43
+ io 8533 1.15 4.62 8.79 48.15 70.51 524327
44
+ ───────────────────────────────────────────────────────────────── 1024kB
45
+ array 4122 1.80 15.59 41.87 67.79 121.00 1048565
46
+ chunk 3158 2.82 15.22 31.00 71.39 99.90 1055654
47
+ string 4710 2.24 6.66 13.65 20.38 70.44 1048575
48
+ io 8355 1.23 3.95 7.94 14.08 68.54 1048498
49
+ ───────────────────────────────────────────────────────────────── 2048kB
50
+ array 2454 4.12 14.02 27.70 43.48 88.89 2097415
51
+ chunk 1743 6.26 17.65 36.98 55.78 92.10 2111358
52
+ string 2479 4.38 12.52 25.65 38.44 95.62 2097502
53
+ io 8264 1.25 3.83 7.76 11.73 65.69 2097090
54
+
55
+ Body ────────── req/sec ────────── ─────── req 50% times ───────
56
+ KB array chunk string io array chunk string io
57
+ 1 13710 13502 13794 9615 0.745 0.757 0.741 1.160
58
+ 10 13458 13066 13500 9293 0.760 0.784 0.759 1.180
59
+ 100 11315 9916 10948 8901 0.960 1.100 1.000 1.210
60
+ 256 9217 7339 8574 8911 1.150 1.450 1.190 1.190
61
+ 512 6951 5234 6438 8533 1.490 2.030 1.550 1.150
62
+ 1024 4122 3158 4710 8355 1.800 2.820 2.240 1.230
63
+ 2048 2454 1743 2479 8264 4.120 6.260 4.380 1.250
64
+ ─────────────────────────────────────────────────────────────────────
65
+ wrk -t8 -c16 -d10s
66
+ benchmarks/local/response_time_wrk.sh -w2 -t5:5 -s tcp6 -Y
67
+ Server cluster mode -w2 -t5:5, bind: tcp6
68
+ Puma repo branch 00-response-refactor
69
+ ruby 3.2.0dev (2022-06-14T01:21:55Z master 048f14221c) +YJIT [x86_64-linux]
70
+
71
+ [2136] - Gracefully shutting down workers...
72
+ [2136] === puma shutdown: 2022-06-13 21:16:13 -0500 ===
73
+ [2136] - Goodbye!
74
+
75
+ 5:15 Total Time
76
+ ```
77
+ </details><br/>
78
+
79
+ ## bench_base.sh, bench_base.rb
80
+
81
+ These two files setup parameters for the Puma server, which is normally started in a shell
82
+ script. It then starts a Ruby file (a subclass of BenchBase), passing arguments to it. The
83
+ Ruby file is normally used to generate a client request stream(s).
84
+
85
+ ### Puma Configuration
86
+
87
+ The following arguments are used for the Puma server:
88
+
89
+ * **`-C`** - configuration file
90
+ * **`-d`** - app delay
91
+ * **`-r`** - rackup file, often defaults to test/rackup/ci_select.ru
92
+ * **`-s`** - bind socket type, default is tcp/tcp4, also tcp6, ssl/ssl4, ssl6, unix, or aunix
93
+ (unix & abstract unix are not available with wrk).
94
+ * **`-t`** - threads, expressed as '5:5', same as Puma --thread
95
+ * **`-w`** - workers, same as Puma --worker
96
+ * **`-Y`** - enable Ruby YJIT
97
+
98
+ ### Request Stream Configuration
99
+
100
+ The following arguments are used for request streams:
101
+
102
+ * **`-b`** - response body configuration. Body type options are a array, c chunked, s string,
103
+ and i for File/IO. None or any combination can be specified, they should start the option.
104
+ Then, any combination of comma separated integers can be used for the response body size
105
+ in kB. The string 'ac50,100' would create four runs, 50kb array, 50kB chunked, 100kB array,
106
+ and 100kB chunked. See 'Testing - test/rackup/ci-*.ru files' for more info.
107
+ * **`-c`** - connections per client request stream thread, defaults to 2 for wrk.
108
+ * **`-D`** - duration of client request stream in seconds.
109
+ * **`-T`** - number of threads in the client request stream. For wrk, this defaults to
110
+ 80% of Puma workers * max_threads.
111
+
112
+ ### Notes - Configuration
113
+
114
+ The above lists script arguments.
115
+
116
+ `bench_base.sh` contains most server defaults. Many can be set via ENV variables.
117
+
118
+ `bench_base.rb` contains the client request stream defaults. The default value for
119
+ `-b` is `acsi1,10,100,256,512,1024,2048`, which is a 4 x 7 matrix, and hence, runs
120
+ 28 jobs. Also, the i body type (File/IO) generates files, they are placed in the
121
+ `"#{Dir.tmpdir}/.puma_response_body_io"` directory, which is created.
122
+
123
+ ### Notes - wrk
124
+
125
+ The shell scripts use `-T` for wrk's thread count, since `-t` is used for Puma
126
+ server threads. Regarding the `-c` argument, wrk has an interesting behavior.
127
+ The total number of connections is set by `(connections/threads).to_i`. The scripts
128
+ here use `-c` as connections per thread. Hence, using `-T4 -c2` will yield a total
129
+ of eight wrk connections, two per thread. The equivalent wrk arguments would be `-t4 -c8`.
130
+
131
+ Puma can only process so many requests, and requests will queue in the backlog
132
+ until Puma can respond to them. With wrk, if the number of total connections is
133
+ too high, one will see the upper latency times increase, pushing into the lower
134
+ latency times as the connections are increased. The default values for wrk's
135
+ threads and connections were chosen to minimize requests' time in the backlog.
136
+
137
+ An example with four wrk runs using `-b s10`. Notice that `req/sec` varies by
138
+ less than 1%, but the `75%` times increase by an order of magnitude:
139
+ ```
140
+ req/sec 50% 75% 90% 99% 100% Resp Size wrk cmd line
141
+ ─────────────────────────────────────────────────────────────────────────────
142
+ 13597 0.755 2.550 5.260 7.800 13.310 12040 wrk -t8 -c16 -d10
143
+ 13549 0.793 4.430 8.140 11.220 16.600 12002 wrk -t10 -c20 -d10
144
+ 13570 1.040 25.790 40.010 49.070 58.300 11982 wrk -t8 -c64 -d10
145
+ 13684 1.050 25.820 40.080 49.160 66.190 12033 wrk -t16 -c64 -d10
146
+ ```
147
+ Finally, wrk's output may cause rounding errors, so the response body size calculation is
148
+ imprecise.
149
+
150
+ [wrk]: <https://github.com/ioquatix/wrk>
@@ -0,0 +1,36 @@
1
+ # Testing - test/rackup/ci-*.ru files
2
+
3
+ ## Overview
4
+
5
+ Puma should efficiently handle a variety of response bodies, varying both by size
6
+ and by the type of object used for the body.
7
+
8
+ Five rackup files are located in 'test/rackup' that can be used. All have their
9
+ request body size (in kB) set via `Body-Conf` header or with `ENV['CI_BODY_CONF']`.
10
+ Additionally, the ci_select.ru file can have it's body type set via a starting
11
+ character.
12
+
13
+ * **ci_array.ru** - body is an `Array` of 1kB strings. `Content-Length` is not set.
14
+ * **ci_chunked.ru** - body is an `Enumerator` of 1kB strings. `Content-Length` is not set.
15
+ * **ci_io.ru** - body is a File/IO object. `Content-Length` is set.
16
+ * **ci_string.ru** - body is a single string. `Content-Length` is set.
17
+ * **ci_select.ru** - can be any of the above.
18
+
19
+ All responses have 25 headers, total length approx 1kB. ci_array.ru and ci_chunked.ru
20
+ contain 1kB items.
21
+
22
+ All can be delayed by a float value (seconds) specified by the `Dly` header
23
+
24
+ Note that rhe `Body-Conf` header takes precedence, and `ENV['CI_BODY_CONF']` is
25
+ only read on load.
26
+
27
+ ## ci_select.ru
28
+
29
+ The ci_select.ru file allows a starting character to specify the body type in the
30
+ `Body-Conf` header or with `ENV['CI_BODY_CONF']`.
31
+ * **a** - array of strings
32
+ * **c** - chunked (enum)
33
+ * **s** - single string
34
+ * **i** - File/IO
35
+
36
+ A value of `a100` would return a body as an array of 100 1kB strings.
@@ -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
  }
@@ -2,7 +2,7 @@
2
2
  #define ext_help_h
3
3
 
4
4
  #define RAISE_NOT_NULL(T) if(T == NULL) rb_raise(rb_eArgError, "%s", "NULL found for " # T " when shouldn't be.");
5
- #define DATA_GET(from,type,name) Data_Get_Struct(from,type,name); RAISE_NOT_NULL(name);
5
+ #define DATA_GET(from,type,data_type,name) TypedData_Get_Struct(from,type,data_type,name); RAISE_NOT_NULL(name);
6
6
  #define REQUIRE_TYPE(V, T) if(TYPE(V) != T) rb_raise(rb_eTypeError, "%s", "Wrong argument type for " # V " required " # T);
7
7
  #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
8
8