puma_worker_killer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 83921642be90494f9eb9988caff6f2397d2ff761
-  data.tar.gz: 0427e91feb9357ab8637739fac169edab633c8a1
+SHA256:
+  metadata.gz: e591941aca312d730ef3105775b2d452d8ee331c6731a02ee0914613c3fb3929
+  data.tar.gz: 7ac7144c3768f6d0d3ace259e1ff5369d2d45a9f466bba46d89f999550f870b0
 SHA512:
-  metadata.gz: f87c5688cb637837c82182cad0eb912a5bcdfde7aab9fc8bd892154d51cb5c78019ea85a9edcaceba2cbb103e8062e68d8c9e500b29073d32bf7b22fafad56cc
-  data.tar.gz: e05e97981e2adf0e319b0ba92ff19f77e84a4f6c47906b7114fda2cdc18dce44e3476dd033f1995e076a073f25986fa74e342ea658f54b8dd7ba4a822af97998
+  metadata.gz: 437a491f123bc729f862fac31f77a1ad51db03b5833930025bc401cd216ee60c0756c92cee153d10962df50b3cf3c68316252d438ccad23859d013bc0a1d6d3f
+  data.tar.gz: 9c70eddaa070856429951f3dd6bcc46db08afb32425cd97c92e65ecfcae4265fcb887dc00b4816717aa8f43c3c31916aaf5a7dbbac82c531e3414a5626372fca

data/.travis.yml

@@ -2,9 +2,11 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
-  - 2.2.4
-  - 2.3.0
+  - 2.1.10
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
   - ruby-head
   - rbx
 before_install:

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.1
+
+- Allow PWK to be used with Puma 4 (#72)
+
 ## 0.1.0
 
 - Emit extra data via `pre_term` callback before puma worker killer terminates a worker #49.

data/README.md

@@ -1,6 +1,7 @@
 # Puma Worker Killer
 
 [![Build Status](https://travis-ci.org/schneems/puma_worker_killer.png?branch=master)](https://travis-ci.org/schneems/puma_worker_killer)
+[![Help Contribute to Open Source](https://www.codetriage.com/schneems/puma_worker_killer/badges/users.svg)](https://www.codetriage.com/schneems/puma_worker_killer)
 
 
 ## What
@@ -66,7 +67,7 @@ before_fork do
 end
 ```
 
-That's it. Now on a regular basis the size of all Puma and all of it's forked processes will be evaluated and if they're over the RAM threshold will be killed. Don't worry Puma will notice a process is missing a spawn a fresh copy with a much smaller RAM footprint ASAP.
+That's it. Now on a regular basis the size of all Puma and all of it's forked processes will be evaluated and if they're over the RAM threshold will be killed. Don't worry Puma will notice a process is missing and spawn a fresh copy with a much smaller RAM footprint ASAP.
 
 ## Troubleshooting
 
@@ -102,7 +103,7 @@ PumaWorkerKiller.config do |config|
   config.ram           = 1024 # mb
   config.frequency     = 5    # seconds
   config.percent_usage = 0.98
-  config.rolling_restart_frequency = 12 * 3600 # 12 hours in seconds
+  config.rolling_restart_frequency = 12 * 3600 # 12 hours in seconds, or 12.hours if using Rails
   config.reaper_status_logs = true # setting this to false will not log lines like:
   # PumaWorkerKiller: Consuming 54.34765625 mb with master and 2 workers.
 
@@ -129,6 +130,12 @@ PumaWorkerKiller: Rolling Restart. 5 workers consuming total: 650mb mb. Sending
 
 However you may want to collect more data, such as sending an event to an error collection service like rollbar or airbrake. The `pre_term` lambda gets called before any worker is killed by PWK for any reason.
 
+### on_calculation
+
+`config.on_calculation` will be called every time Puma Worker Killer calculates memory usage (`config.frequency`). This may be useful for monitoring your total puma application memory usage, which can be contrasted with other application monitoring solutions.
+
+This callback lambda is given a single value for the amount of memory used.
+
 ## Attention
 
 If you start puma as a daemon, to add puma worker killer config into puma config file, rather than into initializers:
@@ -140,7 +147,7 @@ before_fork do
     config.ram           = 1024 # mb
     config.frequency     = 5    # seconds
     config.percent_usage = 0.98
-    config.rolling_restart_frequency = 12 * 3600 # 12 hours in seconds
+    config.rolling_restart_frequency = 12 * 3600 # 12 hours in seconds, or 12.hours if using Rails
   end
   PumaWorkerKiller.start
 end
@@ -167,10 +174,10 @@ PumaWorkerKiller.frequency = 20 # seconds
 You may want to periodically restart all of your workers rather than simply killing your largest. To do that set:
 
 ```ruby
-PumaWorkerKiller.rolling_restart_frequency = 12 * 3600 # 12 hours in seconds
+PumaWorkerKiller.rolling_restart_frequency = 12 * 3600 # 12 hours in seconds, or 12.hours if using Rails
 ```
 
-By default PumaWorkerKiller will perform a rolling restart of all your worker processes every 12 hours. To disable, set to `false`.
+By default PumaWorkerKiller will perform a rolling restart of all your worker processes every 6 hours. To disable, set to `false`.
 
 You may want to hide the following log lines: `PumaWorkerKiller: Consuming 54.34765625 mb with master and 2 workers.`. To do that set:
 

data/lib/puma_worker_killer.rb

@@ -3,20 +3,21 @@ require 'get_process_mem'
 module PumaWorkerKiller
   extend self
 
-  attr_accessor :ram, :frequency, :percent_usage, :rolling_restart_frequency, :reaper_status_logs, :pre_term
+  attr_accessor :ram, :frequency, :percent_usage, :rolling_restart_frequency, :reaper_status_logs, :pre_term, :on_calculation
   self.ram           = 512  # mb
   self.frequency     = 10   # seconds
   self.percent_usage = 0.99 # percent of RAM to use
   self.rolling_restart_frequency = 6 * 3600 # 6 hours in seconds
   self.reaper_status_logs = true
-  self.pre_term = lambda { |_| } # nop
+  self.pre_term = nil
+  self.on_calculation = nil
 
   def config
     yield self
   end
 
-  def reaper(ram = self.ram, percent = self.percent_usage, reaper_status_logs = self.reaper_status_logs, pre_term = self.pre_term)
-    Reaper.new(ram * percent_usage, nil, reaper_status_logs, pre_term)
+  def reaper(ram = self.ram, percent = self.percent_usage, reaper_status_logs = self.reaper_status_logs, pre_term = self.pre_term, on_calculation = self.on_calculation)
+    Reaper.new(ram * percent_usage, nil, reaper_status_logs, pre_term, on_calculation)
   end
 
   def start(frequency = self.frequency, reaper = self.reaper)

data/lib/puma_worker_killer/reaper.rb

@@ -1,10 +1,11 @@
 module PumaWorkerKiller
   class Reaper
-    def initialize(max_ram, master = nil, reaper_status_logs = true, pre_term)
+    def initialize(max_ram, master = nil, reaper_status_logs = true, pre_term = nil, on_calculation = nil)
       @cluster = PumaWorkerKiller::PumaMemory.new(master)
       @max_ram = max_ram
       @reaper_status_logs = reaper_status_logs
       @pre_term = pre_term
+      @on_calculation = on_calculation
     end
 
     # used for tes
@@ -14,7 +15,10 @@ module PumaWorkerKiller
 
     def reap
       return false if @cluster.workers_stopped?
-      if (total = get_total_memory) > @max_ram
+      total = get_total_memory
+      @on_calculation.call(total) unless @on_calculation.nil?
+
+      if total > @max_ram
         @cluster.master.log "PumaWorkerKiller: Out of memory. #{@cluster.workers.count} workers consuming total: #{total} mb out of max: #{@max_ram} mb. Sending TERM to pid #{@cluster.largest_worker.pid} consuming #{@cluster.largest_worker_memory} mb."
 
         # Fetch the largest_worker so that both `@pre_term` and `term_worker` are called with the same worker
@@ -25,7 +29,7 @@ module PumaWorkerKiller
         #   A new request comes in, Worker B takes it, and consumes 101 mb memory
         #   term_largest_worker (previously here) gets called and terms Worker B (thus not passing the about-to-be-terminated worker to `@pre_term`)
         largest_worker = @cluster.largest_worker
-        @pre_term.call(largest_worker)
+        @pre_term.call(largest_worker) unless @pre_term.nil?
         @cluster.term_worker(largest_worker)
 
       elsif @reaper_status_logs

data/lib/puma_worker_killer/version.rb

@@ -1,3 +1,3 @@
 module PumaWorkerKiller
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/puma_worker_killer.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "puma",              ">= 2.7", "< 4"
+  gem.add_dependency "puma",              ">= 2.7", "< 5"
   gem.add_dependency "get_process_mem",   "~>  0.2"
   gem.add_development_dependency "rack", "~> 1.6"
   gem.add_development_dependency "wait_for_it", "~> 0.1"

data/test/fixtures/on_calculation.ru

@@ -0,0 +1,8 @@
+load File.expand_path("../fixture_helper.rb", __FILE__)
+
+PumaWorkerKiller.config do |config|
+  config.on_calculation = lambda { |usage| puts("Current memory footprint: #{usage} mb") }
+end
+PumaWorkerKiller.start
+
+run HelloWorldApp

data/test/puma_worker_killer_test.rb

@@ -45,6 +45,18 @@ class PumaWorkerKillerTest < Test::Unit::TestCase
     end
   end
 
+  def test_on_calculation
+    file     = fixture_path.join("on_calculation.ru")
+    port     = 0
+    command  = "bundle exec puma #{ file } -t 1:1 -w 2 --preload --debug -p #{ port }"
+    options  = { wait_for: "booted", timeout: 5, env: { "PUMA_FREQUENCY" => 1, 'PUMA_RAM' => 1} }
+
+    WaitForIt.new(command, options) do |spawn|
+      assert_contains(spawn, "Out of memory")
+      assert_contains(spawn, "Current memory footprint:") # defined in on_calculate.ru
+    end
+  end
+
   def assert_contains(spawn, string)
     assert spawn.wait(string), "Expected logs to contain '#{string}' but it did not, contents: #{ spawn.log.read }"
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma_worker_killer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-12 00:00:00.000000000 Z
+date: 2019-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma
@@ -19,7 +19,7 @@ dependencies:
         version: '2.7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '2.7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: get_process_mem
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +124,7 @@ files:
 - test/fixtures/config/puma_worker_killer_start.rb
 - test/fixtures/default.ru
 - test/fixtures/fixture_helper.rb
+- test/fixtures/on_calculation.ru
 - test/fixtures/pre_term.ru
 - test/fixtures/rolling_restart.ru
 - test/puma_worker_killer_test.rb
@@ -147,8 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: If you have a memory leak in your web code puma_worker_killer can keep it
@@ -158,6 +158,7 @@ test_files:
 - test/fixtures/config/puma_worker_killer_start.rb
 - test/fixtures/default.ru
 - test/fixtures/fixture_helper.rb
+- test/fixtures/on_calculation.ru
 - test/fixtures/pre_term.ru
 - test/fixtures/rolling_restart.ru
 - test/puma_worker_killer_test.rb