puma 5.0.2-java → 5.2.0-java

data/docs/stats.md

@@ -0,0 +1,142 @@
+## accessing stats
+
+Stats can be accessed in two ways:
+
+### control server
+
+`$ pumactl stats` or `GET /stats`
+
+[Read more about `pumactl` and the control server in the README.](https://github.com/puma/puma#controlstatus-server).
+
+### Puma.stats
+
+`Puma.stats` produces a JSON string. `Puma.stats_hash` produces a ruby hash.
+
+#### in single mode
+
+Invoke `Puma.stats` anywhere in runtime, e.g. in a rails initializer:
+
+```ruby
+# config/initializers/puma_stats.rb
+
+Thread.new do
+  loop do
+    sleep 30
+    puts Puma.stats
+  end
+end
+```
+
+#### in cluster mode
+
+Invoke `Puma.stats` from the master process
+
+```ruby
+# config/puma.rb
+
+before_fork do
+  Thread.new do
+    loop do
+      puts Puma.stats
+      sleep 30
+    end
+  end
+end
+```
+
+
+## Explanation of stats
+
+`Puma.stats` returns different information and a different structure depending on if Puma is in single vs cluster mode. There is one top-level attribute that is common to both modes:
+
+* started_at: when puma was started
+
+### single mode and individual workers in cluster mode
+
+When Puma is run in single mode, these stats ar available at the top level. When Puma is run in cluster mode, these stats are available within the `worker_status` array in a hash labeled `last_status`, in an array of hashes, one hash for each worker.
+
+* backlog: requests that are waiting for an available thread to be available. if this is above 0, you need more capacity [always true?]
+* running: how many threads are running
+* pool_capacity: the number of requests that the server is capable of taking right now. For example if the number is 5 then it means there are 5 threads sitting idle ready to take a request. If one request comes in, then the value would be 4 until it finishes processing. If the minimum threads allowed is zero, this number will still have a maximum value of the maximum threads allowed.
+* max_threads: the maximum number of threads puma is configured to spool up per worker 
+* requests_count: the number of requests this worker has served since starting
+
+
+### cluster mode
+
+* phase: which phase of restart the process is in, during [phased restart](https://github.com/puma/puma/blob/master/docs/restart.md)
+* workers: ??
+* booted_workers: how many workers currently running?
+* old_workers: ??
+* worker_status: array of hashes of info for each worker (see below)
+
+### worker status
+
+* started_at: when the worker was started
+* pid: the process id of the worker process
+* index: each worker gets a number. if puma is configured to have 3 workers, then this will be 0, 1, or 2
+* booted: if it's done booting [?]
+* last_checkin: Last time the worker responded to the master process' heartbeat check.
+* last_status: a hash of info about the worker's state handling requests. See the explanation for this in "single mode and individual workers in cluster mode" section above.
+
+
+## Examples
+
+Here are two example stats hashes produced by `Puma.stats`:
+
+### single
+
+```json
+{
+  "started_at": "2021-01-14T07:12:35Z",
+  "backlog": 0,
+  "running": 5,
+  "pool_capacity": 5,
+  "max_threads": 5,
+  "requests_count": 3
+}
+```
+
+### cluster
+
+```json
+{
+  "started_at": "2021-01-14T07:09:17Z",
+  "workers": 2,
+  "phase": 0,
+  "booted_workers": 2,
+  "old_workers": 0,
+  "worker_status": [
+    {
+      "started_at": "2021-01-14T07:09:24Z",
+      "pid": 64136,
+      "index": 0,
+      "phase": 0,
+      "booted": true,
+      "last_checkin": "2021-01-14T07:11:09Z",
+      "last_status": {
+        "backlog": 0,
+        "running": 5,
+        "pool_capacity": 5,
+        "max_threads": 5,
+        "requests_count": 2
+      }
+    },
+    {
+      "started_at": "2021-01-14T07:09:24Z",
+      "pid": 64137,
+      "index": 1,
+      "phase": 0,
+      "booted": true,
+      "last_checkin": "2021-01-14T07:11:09Z",
+      "last_status": {
+        "backlog": 0,
+        "running": 5,
+        "pool_capacity": 5,
+        "max_threads": 5,
+        "requests_count": 1
+      }
+    }
+  ]
+}
+```

data/docs/systemd.md

@@ -24,8 +24,15 @@ After=network.target
 # Requires=puma.socket
 
 [Service]
-# Foreground process (do not use --daemon in ExecStart or config.rb)
-Type=simple
+# Puma supports systemd's `Type=notify` and watchdog service
+# monitoring, if the [sd_notify](https://github.com/agis/ruby-sdnotify) gem is installed,
+# as of Puma 5.1 or later.
+# On earlier versions of Puma or JRuby, change this to `Type=simple` and remove
+# the `WatchdogSec` line.
+Type=notify
+
+# If your Puma process locks up, systemd's watchdog will restart it within seconds.
+WatchdogSec=10
 
 # Preferably configure a non-privileged user
 # User=
@@ -76,7 +83,7 @@ pass the `--keep-file-descriptors` flag. `bundle exec` can be avoided by using a
 `puma` executable generated by `bundle binstubs puma`. This is tracked in
 [#1499].
 
-**Note:** Socket activation doesn't currently work on jruby. This is
+**Note:** Socket activation doesn't currently work on JRuby. This is
 tracked in [#1367].
 
 To use socket activation, configure one or more `ListenStream` sockets
@@ -122,6 +129,21 @@ Puma will detect the release path socket as different than the one provided by
 systemd and attempt to bind it again, resulting in the exception
  `There is already a server bound to:`.
 
+### Binding
+
+By default you need to configure puma to have binds matching with all
+ListenStream statements. Any mismatched systemd ListenStreams will be closed by
+puma.
+
+To automatically bind to all activated sockets, the option
+`--bind-to-activated-sockets` can be used. This matches the config DSL
+`bind_to_activated_sockets` statement. This will cause puma to create a bind
+automatically for any activated socket. When systemd socket activation is not
+enabled, this option does nothing.
+
+This also accepts an optional argument `only` (DSL: `'only'`) to discard any
+binds that's not socket activated.
+
 ## Usage
 
 Without socket activation, use `systemctl` as root (e.g. via `sudo`) as

data/ext/puma_http11/ext_help.h

@@ -2,7 +2,7 @@
 #define ext_help_h
 
 #define RAISE_NOT_NULL(T) if(T == NULL) rb_raise(rb_eArgError, "%s", "NULL found for " # T " when shouldn't be.");
-#define DATA_GET(from,type,name) Data_Get_Struct(from,type,name); RAISE_NOT_NULL(name);
+#define DATA_GET(from,type,data_type,name) TypedData_Get_Struct(from,type,data_type,name); RAISE_NOT_NULL(name);
 #define REQUIRE_TYPE(V, T) if(TYPE(V) != T) rb_raise(rb_eTypeError, "%s", "Wrong argument type for " # V " required " # T);
 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
 

data/ext/puma_http11/extconf.rb

@@ -17,12 +17,25 @@ unless ENV["DISABLE_SSL"]
     have_header "openssl/bio.h"
 
     # below is  yes for 1.0.2 & later
-    have_func  "DTLS_method"                  , "openssl/ssl.h"
+    have_func  "DTLS_method"                           , "openssl/ssl.h"
 
-    # below are yes for 1.1.0 & later, may need to check func rather than macro
-    # with versions after 1.1.1
-    have_func  "TLS_server_method"            , "openssl/ssl.h"
-    have_macro "SSL_CTX_set_min_proto_version", "openssl/ssl.h"
+    # below are yes for 1.1.0 & later
+    have_func  "TLS_server_method"                     , "openssl/ssl.h"
+    have_func  "SSL_CTX_set_min_proto_version(NULL, 0)", "openssl/ssl.h"
+
+    have_func  "X509_STORE_up_ref"
+    have_func("SSL_CTX_set_ecdh_auto(NULL, 0)", "openssl/ssl.h")
+  end
+end
+
+if ENV["MAKE_WARNINGS_INTO_ERRORS"]
+  # Make all warnings into errors
+  # Except `implicit-fallthrough` since most failures comes from ragel state machine generated code
+  if respond_to? :append_cflags
+    append_cflags config_string 'WERRORFLAG'
+    append_cflags '-Wno-implicit-fallthrough'
+  else
+    $CFLAGS += ' ' << (config_string 'WERRORFLAG') << ' -Wno-implicit-fallthrough'
   end
 end
 

data/ext/puma_http11/http11_parser.c

@@ -33,20 +33,18 @@ static void snake_upcase_char(char *c)
 /** Machine **/
 
 
-#line 79 "ext/puma_http11/http11_parser.rl"
+#line 81 "ext/puma_http11/http11_parser.rl"
 
 
 /** Data **/
 
-#line 40 "ext/puma_http11/http11_parser.c"
+#line 42 "ext/puma_http11/http11_parser.c"
 static const int puma_parser_start = 1;
 static const int puma_parser_first_final = 46;
 static const int puma_parser_error = 0;
 
-static const int puma_parser_en_main = 1;
 
-
-#line 83 "ext/puma_http11/http11_parser.rl"
+#line 85 "ext/puma_http11/http11_parser.rl"
 
 int puma_parser_init(puma_parser *parser)  {
   int cs = 0;
@@ -56,7 +54,7 @@ int puma_parser_init(puma_parser *parser)  {
 	cs = puma_parser_start;
 	}
 
-#line 87 "ext/puma_http11/http11_parser.rl"
+#line 89 "ext/puma_http11/http11_parser.rl"
   parser->cs = cs;
   parser->body_start = 0;
   parser->content_len = 0;
@@ -109,7 +107,7 @@ st0:
 cs = 0;
 	goto _out;
 tr0:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st2;
 st2:
@@ -132,7 +130,7 @@ case 2:
 		goto st27;
 	goto st0;
 tr2:
-#line 48 "ext/puma_http11/http11_parser.rl"
+#line 50 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_method(parser, PTR_TO(mark), LEN(mark, p));
   }
@@ -158,7 +156,7 @@ case 3:
 		goto tr5;
 	goto st0;
 tr4:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st4;
 st4:
@@ -172,53 +170,53 @@ case 4:
 	}
 	goto st0;
 tr8:
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st5;
 tr31:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
-#line 54 "ext/puma_http11/http11_parser.rl"
+#line 56 "ext/puma_http11/http11_parser.rl"
 	{
     parser->fragment(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st5;
 tr33:
-#line 54 "ext/puma_http11/http11_parser.rl"
+#line 56 "ext/puma_http11/http11_parser.rl"
 	{
     parser->fragment(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st5;
 tr37:
-#line 67 "ext/puma_http11/http11_parser.rl"
+#line 69 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_path(parser, PTR_TO(mark), LEN(mark,p));
   }
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st5;
 tr41:
-#line 58 "ext/puma_http11/http11_parser.rl"
+#line 60 "ext/puma_http11/http11_parser.rl"
 	{ MARK(query_start, p); }
-#line 59 "ext/puma_http11/http11_parser.rl"
+#line 61 "ext/puma_http11/http11_parser.rl"
 	{
     parser->query_string(parser, PTR_TO(query_start), LEN(query_start, p));
   }
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st5;
 tr44:
-#line 59 "ext/puma_http11/http11_parser.rl"
+#line 61 "ext/puma_http11/http11_parser.rl"
 	{
     parser->query_string(parser, PTR_TO(query_start), LEN(query_start, p));
   }
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
@@ -232,7 +230,7 @@ case 5:
 		goto tr10;
 	goto st0;
 tr10:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st6;
 st6:
@@ -297,21 +295,21 @@ case 13:
 		goto st13;
 	goto st0;
 tr18:
-#line 63 "ext/puma_http11/http11_parser.rl"
+#line 65 "ext/puma_http11/http11_parser.rl"
 	{
     parser->http_version(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st14;
 tr26:
-#line 44 "ext/puma_http11/http11_parser.rl"
+#line 46 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
-#line 45 "ext/puma_http11/http11_parser.rl"
+#line 47 "ext/puma_http11/http11_parser.rl"
 	{
     parser->http_field(parser, PTR_TO(field_start), parser->field_len, PTR_TO(mark), LEN(mark, p));
   }
 	goto st14;
 tr29:
-#line 45 "ext/puma_http11/http11_parser.rl"
+#line 47 "ext/puma_http11/http11_parser.rl"
 	{
     parser->http_field(parser, PTR_TO(field_start), parser->field_len, PTR_TO(mark), LEN(mark, p));
   }
@@ -360,7 +358,7 @@ case 16:
 		goto tr22;
 	goto st0;
 tr22:
-#line 71 "ext/puma_http11/http11_parser.rl"
+#line 73 "ext/puma_http11/http11_parser.rl"
 	{
     parser->body_start = p - buffer + 1;
     parser->header_done(parser, p + 1, pe - p - 1);
@@ -374,13 +372,13 @@ case 46:
 #line 373 "ext/puma_http11/http11_parser.c"
 	goto st0;
 tr21:
-#line 38 "ext/puma_http11/http11_parser.rl"
+#line 40 "ext/puma_http11/http11_parser.rl"
 	{ MARK(field_start, p); }
-#line 39 "ext/puma_http11/http11_parser.rl"
+#line 41 "ext/puma_http11/http11_parser.rl"
 	{ snake_upcase_char((char *)p); }
 	goto st17;
 tr23:
-#line 39 "ext/puma_http11/http11_parser.rl"
+#line 41 "ext/puma_http11/http11_parser.rl"
 	{ snake_upcase_char((char *)p); }
 	goto st17;
 st17:
@@ -413,13 +411,13 @@ case 17:
 		goto tr23;
 	goto st0;
 tr24:
-#line 40 "ext/puma_http11/http11_parser.rl"
+#line 42 "ext/puma_http11/http11_parser.rl"
 	{
     parser->field_len = LEN(field_start, p);
   }
 	goto st18;
 tr27:
-#line 44 "ext/puma_http11/http11_parser.rl"
+#line 46 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st18;
 st18:
@@ -433,7 +431,7 @@ case 18:
 	}
 	goto tr25;
 tr25:
-#line 44 "ext/puma_http11/http11_parser.rl"
+#line 46 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st19;
 st19:
@@ -445,39 +443,39 @@ case 19:
 		goto tr29;
 	goto st19;
 tr9:
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st20;
 tr38:
-#line 67 "ext/puma_http11/http11_parser.rl"
+#line 69 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_path(parser, PTR_TO(mark), LEN(mark,p));
   }
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st20;
 tr42:
-#line 58 "ext/puma_http11/http11_parser.rl"
+#line 60 "ext/puma_http11/http11_parser.rl"
 	{ MARK(query_start, p); }
-#line 59 "ext/puma_http11/http11_parser.rl"
+#line 61 "ext/puma_http11/http11_parser.rl"
 	{
     parser->query_string(parser, PTR_TO(query_start), LEN(query_start, p));
   }
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
 	goto st20;
 tr45:
-#line 59 "ext/puma_http11/http11_parser.rl"
+#line 61 "ext/puma_http11/http11_parser.rl"
 	{
     parser->query_string(parser, PTR_TO(query_start), LEN(query_start, p));
   }
-#line 51 "ext/puma_http11/http11_parser.rl"
+#line 53 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_uri(parser, PTR_TO(mark), LEN(mark, p));
   }
@@ -500,7 +498,7 @@ case 20:
 		goto st0;
 	goto tr30;
 tr30:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st21;
 st21:
@@ -521,7 +519,7 @@ case 21:
 		goto st0;
 	goto st21;
 tr5:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st22;
 st22:
@@ -546,7 +544,7 @@ case 22:
 		goto st22;
 	goto st0;
 tr7:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st23;
 st23:
@@ -566,7 +564,7 @@ case 23:
 		goto st0;
 	goto st23;
 tr6:
-#line 35 "ext/puma_http11/http11_parser.rl"
+#line 37 "ext/puma_http11/http11_parser.rl"
 	{ MARK(mark, p); }
 	goto st24;
 st24:
@@ -587,7 +585,7 @@ case 24:
 		goto st0;
 	goto st24;
 tr39:
-#line 67 "ext/puma_http11/http11_parser.rl"
+#line 69 "ext/puma_http11/http11_parser.rl"
 	{
     parser->request_path(parser, PTR_TO(mark), LEN(mark,p));
   }
@@ -609,7 +607,7 @@ case 25:
 		goto st0;
 	goto tr40;
 tr40:
-#line 58 "ext/puma_http11/http11_parser.rl"
+#line 60 "ext/puma_http11/http11_parser.rl"
 	{ MARK(query_start, p); }
 	goto st26;
 st26:
@@ -1010,7 +1008,7 @@ case 45:
 	_out: {}
 	}
 
-#line 115 "ext/puma_http11/http11_parser.rl"
+#line 117 "ext/puma_http11/http11_parser.rl"
 
   if (!puma_parser_has_error(parser))
     parser->cs = cs;