jun-puma 1.0.1-java → 1.0.3-java

data/docs/kubernetes.md

@@ -1,78 +0,0 @@
-# Kubernetes
-
-## Running Puma in Kubernetes
-
-In general running Puma in Kubernetes works as-is, no special configuration is needed beyond what you would write anyway to get a new Kubernetes Deployment going. There is one known interaction between the way Kubernetes handles pod termination and how Puma handles `SIGINT`, where some request might be sent to Puma after it has already entered graceful shutdown mode and is no longer accepting requests. This can lead to dropped requests during rolling deploys. A workaround for this is listed at the end of this article.
-
-## Basic setup
-
-Assuming you already have a running cluster and docker image repository, you can run a simple Puma app with the following example Dockerfile and Deployment specification. These are meant as examples only and are deliberately very minimal to the point of skipping many options that are recommended for running in production, like healthchecks and envvar configuration with ConfigMaps. In general you should check the [Kubernetes documentation](https://kubernetes.io/docs/home/) and [Docker documentation](https://docs.docker.com/) for a more comprehensive overview of the available options.
-
-A basic Dockerfile example: 
-```
-FROM ruby:2.5.1-alpine # can be updated to newer ruby versions
-RUN apk update && apk add build-base # and any other packages you need 
-
-# Only rebuild gem bundle if Gemfile changes
-COPY Gemfile Gemfile.lock ./
-RUN bundle install
-
-# Copy over the rest of the files
-COPY . .
-
-# Open up port and start the service
-EXPOSE 9292
-CMD bundle exec rackup -o 0.0.0.0
-```
-
-A sample `deployment.yaml`:
-```
----
-apiVersion: apps/v1
-kind: Deployment
-metadata:
-  name: my-awesome-puma-app
-spec:
-  selector:
-    matchLabels:
-      app: my-awesome-puma-app
-  template:
-    metadata:
-      labels:
-        app: my-awesome-puma-app
-        service: my-awesome-puma-app
-    spec:
-      containers:
-      - name: my-awesome-puma-app
-        image: <your image here>
-        ports:
-        - containerPort: 9292
-``` 
-
-## Graceful shutdown and pod termination
-
-For some high-throughput systems, it is possible that some HTTP requests will return responses with response codes in the 5XX range during a rolling deploy to a new version. This is caused by [the way that Kubernetes terminates a pod during rolling deploys](https://cloud.google.com/blog/products/gcp/kubernetes-best-practices-terminating-with-grace):
-
-1. The replication controller determines a pod should be shut down.
-2. The Pod is set to the “Terminating” State and removed from the endpoints list of all Services, so that it receives no more requests.
-3. The pods pre-stop hook get called. The default for this is to send `SIGTERM` to the process inside the pod.
-4. The pod has up to `terminationGracePeriodSeconds` (default: 30 seconds) to gracefully shut down. Puma will do this (after it receives SIGTERM) by closing down the socket that accepts new requests and finishing any requests already running before exiting the Puma process.
-5. If the pod is still running after `terminationGracePeriodSeconds` has elapsed, the pod receives `SIGKILL` to make sure the process inside it stops. After that, the container exits and all other Kubernetes objects associated with it are cleaned up.
-
-There is a subtle race condition between step 2 and 3: The replication controller does not synchronously remove the pod from the Services AND THEN call the pre-stop hook of the pod, but rather it asynchronously sends "remove this pod from your endpoints" requests to the Services and then immediately proceeds to invoke the pods' pre-stop hook. If the Service controller (typically something like nginx or haproxy) receives this request handles this request "too" late (due to internal lag or network latency between the replication and Service controllers) then it is possible that the Service controller will send one or more requests to a Puma process which has already shut down its listening socket. These requests will then fail with 5XX error codes.
-
-The way Kubernetes works this way, rather than handling step 2 synchronously, is due to the CAP theorem: in a distributed system there is no way to guarantee that any message will arrive promptly. In particular, waiting for all Service controllers to report back might get stuck for an indefinite time if one of them has already been terminated or if there has been a net split. A way to work around this is to add a sleep to the pre-stop hook of the same time as the `terminationGracePeriodSeconds` time. This will allow the Puma process to keep serving new requests during the entire grace period, although it will no longer receive new requests after all Service controllers have propagated the removal of the pod from their endpoint lists. Then, after `terminationGracePeriodSeconds`, the pod receives `SIGKILL` and closes down. If your process can't handle SIGKILL properly, for example because it needs to release locks in different services, you can also sleep for a shorter period (and/or increase `terminationGracePeriodSeconds`) as long as the time slept is longer than the time that your Service controllers take to propagate the pod removal. The downside of this workaround is that all pods will take at minimum the amount of time slept to shut down and this will increase the time required for your rolling deploy.
-
-More discussions and links to relevant articles can be found in https://github.com/puma/puma/issues/2343.
-
-## Workers Per Pod, and Other Config Issues
-
-With containerization, you will have to make a decision about how "big" to make each pod. Should you run 2 pods with 50 workers each? 25 pods, each with 4 workers? 100 pods, with each Puma running in single mode? Each scenario represents the same total amount of capacity (100 Puma processes that can respond to requests), but there are tradeoffs to make.
-
-* Worker counts should be somewhere between 4 and 32 in most cases. You want more than 4 in order to minimize time spent in request queueing for a free Puma worker, but probably less than ~32 because otherwise autoscaling is working in too large of an increment or they probably won't fit very well into your nodes. In any queueing system, queue time is proportional to 1/n, where n is the number of things pulling from the queue. Each pod will have its own request queue (i.e., the socket backlog). If you have 4 pods with 1 worker each (4 request queues), wait times are, proportionally, about 4 times higher than if you had 1 pod with 4 workers (1 request queue).
-* Unless you have a very I/O-heavy application (50%+ time spent waiting on IO), use the default thread count (5 for MRI). Using higher numbers of threads with low I/O wait (<50%) will lead to additional request queueing time (latency!) and additional memory usage.
-* More processes per pod reduces memory usage per process, because of copy-on-write memory and because the cost of the single master process is "amortized" over more child processes.
-* Don't run less than 4 processes per pod if you can. Low numbers of processes per pod will lead to high request queueing, which means you will have to run more pods.
-* If multithreaded, allocate 1 CPU per worker. If single threaded, allocate 0.75 cpus per worker. Most web applications spend about 25% of their time in I/O - but when you're running multi-threaded, your Puma process will have higher CPU usage and should be able to fully saturate a CPU core.
-* Most Puma processes will use about ~512MB-1GB per worker, and about 1GB for the master process. However, you probably shouldn't bother with setting memory limits lower than around 2GB per process, because most places you are deploying will have 2GB of RAM per CPU. A sensible memory limit for a Puma configuration of 4 child workers might be something like 8 GB (1 GB for the master, 7GB for the 4 children).
-

data/docs/nginx.md

@@ -1,80 +0,0 @@
-# Nginx configuration example file
-
-This is a very common setup using an upstream. It was adapted from some Capistrano recipe I found on the Internet a while ago.
-
-```nginx
-upstream myapp {
-  server unix:///myapp/tmp/puma.sock;
-}
-
-server {
-  listen 80;
-  server_name myapp.com;
-
-  # ~2 seconds is often enough for most folks to parse HTML/CSS and
-  # retrieve needed images/icons/frames, connections are cheap in
-  # nginx so increasing this is generally safe...
-  keepalive_timeout 5;
-
-  # path for static files
-  root /myapp/public;
-  access_log /myapp/log/nginx.access.log;
-  error_log /myapp/log/nginx.error.log info;
-
-  # this rewrites all the requests to the maintenance.html
-  # page if it exists in the doc root. This is for capistrano's
-  # disable web task
-  if (-f $document_root/maintenance.html) {
-    rewrite  ^(.*)$  /maintenance.html last;
-    break;
-  }
-
-  location / {
-    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-    proxy_set_header Host $host;
-
-    # If the file exists as a static file serve it directly without
-    # running all the other rewrite tests on it
-    if (-f $request_filename) {
-      break;
-    }
-
-    # check for index.html for directory index
-    # if it's there on the filesystem then rewrite
-    # the url to add /index.html to the end of it
-    # and then break to send it to the next config rules.
-    if (-f $request_filename/index.html) {
-      rewrite (.*) $1/index.html break;
-    }
-
-    # this is the meat of the rack page caching config
-    # it adds .html to the end of the url and then checks
-    # the filesystem for that file. If it exists, then we
-    # rewrite the url to have explicit .html on the end
-    # and then send it on its way to the next config rule.
-    # if there is no file on the fs then it sets all the
-    # necessary headers and proxies to our upstream pumas
-    if (-f $request_filename.html) {
-      rewrite (.*) $1.html break;
-    }
-
-    if (!-f $request_filename) {
-      proxy_pass http://myapp;
-      break;
-    }
-  }
-
-  # Now this supposedly should work as it gets the filenames with querystrings that Rails provides.
-  # BUT there's a chance it could break the ajax calls.
-  location ~* \.(ico|css|gif|jpe?g|png|js)(\?[0-9]+)?$ {
-     expires max;
-     break;
-  }
-
-  # Error pages
-  # error_page 500 502 503 504 /500.html;
-  location = /500.html {
-    root /myapp/current/public;
-  }
-}
-```

data/docs/plugins.md

@@ -1,38 +0,0 @@
-## Plugins
-
-Puma 3.0 added support for plugins that can augment configuration and service
-operations.
-
-There are two canonical plugins to aid in the development of new plugins:
-
-* [tmp\_restart](https://github.com/puma/puma/blob/master/lib/puma/plugin/tmp_restart.rb):
-  Restarts the server if the file `tmp/restart.txt` is touched
-* [heroku](https://github.com/puma/puma-heroku/blob/master/lib/puma/plugin/heroku.rb):
-  Packages up the default configuration used by Puma on Heroku (being sunset
-  with the release of Puma 5.0)
-
-Plugins are activated in a Puma configuration file (such as `config/puma.rb'`)
-by adding `plugin "name"`, such as `plugin "heroku"`.
-
-Plugins are activated based on path requirements so, activating the `heroku`
-plugin is much like `require "puma/plugin/heroku"`. This allows gems to provide
-multiple plugins (as well as unrelated gems to provide Puma plugins).
-
-The `tmp_restart` plugin comes with Puma, so it is always available.
-
-To use the `heroku` plugin, add `puma-heroku` to your Gemfile or install it.
-
-### API
-
-## Server-wide hooks
-
-Plugins can use a couple of hooks at the server level: `start` and `config`.
-
-`start` runs when the server has started and allows the plugin to initiate other
-functionality to augment Puma.
-
-`config` runs when the server is being configured and receives a `Puma::DSL`
-object that is useful for additional configuration.
-
-Public methods in [`Puma::Plugin`](../lib/puma/plugin.rb) are treated as a
-public API for plugins.

data/docs/rails_dev_mode.md

@@ -1,28 +0,0 @@
-# Running Puma in Rails Development Mode
-
-## "Loopback requests" 
-
-Be cautious of "loopback requests," where a Rails application executes a request to a server that, in turn, results in another request back to the same Rails application before the first request completes. Having a loopback request will trigger [Rails' load interlock](https://guides.rubyonrails.org/threading_and_code_execution.html#load-interlock) mechanism. The load interlock mechanism prevents a thread from using Rails autoloading mechanism to load constants while the application code is still running inside another thread.
-
-This issue only occurs in the development environment as Rails' load interlock is not used in production environments. Although we're not sure, we believe this issue may not occur with the new `zeitwerk` code loader.
-
-### Solutions
-
-#### 1. Bypass Rails' load interlock with `.permit_concurrent_loads`
-
-Wrap the first request inside a block that will allow concurrent loads: [`ActiveSupport::Dependencies.interlock.permit_concurrent_loads`](https://guides.rubyonrails.org/threading_and_code_execution.html#permit-concurrent-loads). Anything wrapped inside the `.permit_concurrent_loads` block will bypass the load interlock mechanism, allowing new threads to access the Rails environment and boot properly. 
-
-###### Example 
-
-```ruby
-response = ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
-  # Your HTTP request code here. For example:
-  Faraday.post url, data: 'foo'
-end
-
-do_something_with response
-```
-
-####  2. Use multiple processes on Puma
-
-Alternatively, you may also enable multiple (single-threaded) workers on Puma. By doing so, you are sidestepping the problem by creating multiple processes rather than new threads. However, this workaround is not ideal because debugging tools such as [byebug](https://github.com/deivid-rodriguez/byebug/issues/487) and [pry](https://github.com/pry/pry/issues/2153), work poorly with any multi-process web server. 

data/docs/restart.md

@@ -1,64 +0,0 @@
-Puma provides three distinct kinds of restart operations, each for different use cases. This document describes "hot restarts" and "phased restarts." The third kind of restart operation is called "refork" and is described in the documentation for [`fork_worker`](fork_worker.md).
-
-## Hot restart
-
-To perform a "hot" restart, Puma performs an `exec` operation to start the process up again, so no memory is shared between the old process and the new process. As a result, it is safe to issue a restart at any place where you would manually stop Puma and start it again. In particular, it is safe to upgrade Puma itself using a hot restart.
-
-If the new process is unable to load, it will simply exit. You should therefore run Puma under a process monitor when using it in production.
-
-### How-to
-
-Any of the following will cause a Puma server to perform a hot restart: 
-
-* Send the `puma` process the `SIGUSR2` signal
-* Issue a `GET` request to the Puma status/control server with the path `/restart`
-* Issue `pumactl restart` (this uses the control server method if available, otherwise sends the `SIGUSR2` signal to the process)
-
-### Supported configurations
-
-* Works in cluster mode and single mode
-* Supported on all platforms
-
-### Client experience
-
-* All platforms: clients with an in-flight request are served responses before the connection is closed gracefully. Puma gracefully disconnects any idle HTTP persistent connections before restarting.
-* On MRI or TruffleRuby on Linux and BSD: Clients who connect just before the server restarts may experience increased latency while the server stops and starts again, but their connections will not be closed prematurely.
-* On Windows and JRuby: Clients who connect just before a restart may experience "connection reset" errors.
-
-### Additional notes
-
-* Only one version of the application is running at a time.
-* `on_restart` is invoked just before the server shuts down. This can be used to clean up resources (like long-lived database connections) gracefully. Since Ruby 2.0, it is not typically necessary to explicitly close file descriptors on restart. This is because any file descriptor opened by Ruby will have the `FD_CLOEXEC` flag set, meaning that file descriptors are closed on `exec`. `on_restart` is useful, though, if your application needs to perform any more graceful protocol-specific shutdown procedures before closing connections.
-
-## Phased restart
-
-Phased restarts replace all running workers in a Puma cluster. This is a useful way to upgrade the application that Puma is serving gracefully. A phased restart works by first killing an old worker, then starting a new worker, waiting until the new worker has successfully started before proceeding to the next worker. This process continues until all workers are replaced. The master process is not restarted.
-
-### How-to
-
-Any of the following will cause a Puma server to perform a phased restart: 
-
-* Send the `puma` process the `SIGUSR1` signal
-* Issue a `GET` request to the Puma status/control server with the path `/phased-restart`
-* Issue `pumactl phased-restart` (this uses the control server method if available, otherwise sends the `SIGUSR1` signal to the process)
-
-### Supported configurations
-
-* Works in cluster mode only
-* To support upgrading the application that Puma is serving, ensure `prune_bundler` is enabled and that `preload_app!` is disabled
-* Supported on all platforms where cluster mode is supported
-
-### Client experience
-
-* In-flight requests are always served responses before the connection is closed gracefully
-* Idle persistent connections are gracefully disconnected
-* New connections are not lost, and clients will not experience any increase in latency (as long as the number of configured workers is greater than one)
-
-### Additional notes
-
-* When a phased restart begins, the Puma master process changes its current working directory to the directory specified by the `directory` option. If `directory` is set to symlink, this is automatically re-evaluated, so this mechanism can be used to upgrade the application.
-* On a single server, it's possible that two versions of the application are running concurrently during a phased restart.
-* `on_restart` is not invoked
-* Phased restarts can be slow for Puma clusters with many workers. Hot restarts often complete more quickly, but at the cost of increased latency during the restart.
-* Phased restarts cannot be used to upgrade any gems loaded by the Puma master process, including `puma` itself, anything in `extra_runtime_dependencies`, or dependencies thereof. Upgrading other gems is safe.
-* If you remove the gems from old releases as part of your deployment strategy, there are additional considerations. Do not put any gems into `extra_runtime_dependencies` that have native extensions or have dependencies that have native extensions (one common example is `puma_worker_killer` and its dependency on `ffi`). Workers will fail on boot during a phased restart. The underlying issue is recorded in [an issue on the rubygems project](https://github.com/rubygems/rubygems/issues/4004). Hot restarts are your only option here if you need these dependencies.

data/docs/signals.md

@@ -1,98 +0,0 @@
-The [unix signal](https://en.wikipedia.org/wiki/Unix_signal) is a method of sending messages between [processes](https://en.wikipedia.org/wiki/Process_(computing)). When a signal is sent, the operating system interrupts the target process's normal flow of execution. There are standard signals that are used to stop a process, but there are also custom signals that can be used for other purposes. This document is an attempt to list all supported signals that Puma will respond to. In general, signals need only be sent to the master process of a cluster.
-
-## Sending Signals
-
-If you are new to signals, it can be helpful to see how they are used. When a process starts in a *nix-like operating system, it will have a [PID - or process identifier](https://en.wikipedia.org/wiki/Process_identifier) that can be used to send signals to the process. For demonstration, we will create an infinitely running process by tailing a file:
-
-```sh
-$ echo "foo" >> my.log
-$ irb
-> pid = Process.spawn 'tail -f my.log'
-```
-
-From here, we can see that the tail process is running by using the `ps` command:
-
-```sh
-$ ps aux | grep tail
-schneems        87152   0.0  0.0  2432772    492 s032  S+   12:46PM   0:00.00 tail -f my.log
-```
-
-You can send a signal in Ruby using the [Process module](https://www.ruby-doc.org/core-2.1.1/Process.html#kill-method):
-
-```
-$ irb
-> puts pid
-=> 87152
-Process.detach(pid) # https://ruby-doc.org/core-2.1.1/Process.html#method-c-detach
-Process.kill("TERM", pid)
-```
-
-Now you will see via `ps` that there is no more `tail` process. Sometimes when referring to signals, the `SIG` prefix will be used. For example, `SIGTERM` is equivalent to sending `TERM` via `Process.kill`.
-
-## Puma Signals
-
-Puma cluster responds to these signals:
-
-- `TTIN` increment the worker count by 1
-- `TTOU` decrement the worker count by 1
-- `TERM` send `TERM` to worker. The worker will attempt to finish then exit.
-- `USR2` restart workers. This also reloads the Puma configuration file, if there is one.
-- `USR1` restart workers in phases, a rolling restart. This will not reload the configuration file.
-- `HUP ` reopen log files defined in stdout_redirect configuration parameter. If there is no stdout_redirect option provided, it will behave like `INT`
-- `INT ` equivalent of sending Ctrl-C to cluster. Puma will attempt to finish then exit.
-- `CHLD`
-- `URG ` refork workers in phases from worker 0 if `fork_workers` option is enabled.
-- `INFO` print backtraces of all puma threads
-
-## Callbacks order in case of different signals
-
-### Start application
-
-```
-puma configuration file reloaded, if there is one
-* Pruning Bundler environment
-puma configuration file reloaded, if there is one
-
-before_fork
-on_worker_fork
-after_worker_fork
-
-Gemfile in context
-
-on_worker_boot
-
-Code of the app is loaded and running
-```
-
-### Send USR2
-
-```
-on_worker_shutdown
-on_restart
-
-puma configuration file reloaded, if there is one
-
-before_fork
-on_worker_fork
-after_worker_fork
-
-Gemfile in context
-
-on_worker_boot
-
-Code of the app is loaded and running
-```
-
-### Send USR1
-
-```
-on_worker_shutdown
-on_worker_fork
-after_worker_fork
-
-Gemfile in context
-
-on_worker_boot
-
-Code of the app is loaded and running
-```

data/docs/stats.md

@@ -1,142 +0,0 @@
-## 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 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.
-
-* 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 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 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
-      }
-    }
-  ]
-}
-```