puma_worker_killer 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce372755dae3f6e9abb64192488e0709ecf7af12
-  data.tar.gz: 8c51e18768753c3716487379f217a431f4ae6f1e
+  metadata.gz: 52f6ead7a78bc887408c2a249b3aed913fe90129
+  data.tar.gz: 752ef55b46747f29aa84b92d84d0d72496fe315a
 SHA512:
-  metadata.gz: 535cc32a6414aae221b2842a85bc5205d7043cc37699a3b1d488af5922b89688aebacce10276e025a9af9c0190f98c19f3ed55521ffc49c14fafcd532ac9b12e
-  data.tar.gz: 0c025d47e64ddfe8589ee3145178cb9205adcc1248d2b494631e15b1fd5186178662c716cec2f8a2a126ae86addc757fc598b8e6c415a8cb0bfa795d14a6f4b0
+  metadata.gz: 2c12b64d3108e5c4921dba09eb832edbfc008edfeade7cae4ca77429aea1da1dfcbe7fe49f37ac3ac2b5048ebf947e555cc45b352ca6e0303acf8fa9ed38705c
+  data.tar.gz: 99ef751d60702d8ffd5d5eb83d8cb6fc22e5d4174d5fc3cba199bcec5b48dd46c3c80c7eb0682ab7708e484add4957d819656bb3d7742ceac30d59c3e92e14ea

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
-*.gem
+*.gem
+puma.log

data/README.md

@@ -58,7 +58,12 @@ You may want to tune the worker killer to run more or less often. You can adjust
 PumaWorkerKiller.frequency = 20 # seconds
 ```
 
+
 ## License
 
 MIT
 
+
+## Feedback
+
+Open up an issue or ping me on twitter [@schneems](http://twitter.com/schneems).

data/lib/puma_worker_killer.rb

@@ -21,6 +21,7 @@ module PumaWorkerKiller
   end
 end
 
+require 'puma_worker_killer/puma_memory'
 require 'puma_worker_killer/reaper'
 require 'puma_worker_killer/auto_reap'
 require 'puma_worker_killer/version'

data/lib/puma_worker_killer/puma_memory.rb

@@ -0,0 +1,77 @@
+module PumaWorkerKiller
+  class PumaMemory
+    def initialize(master = nil)
+      @master  = master || get_master
+    end
+
+    def master
+      @master
+    end
+
+    def size
+      workers.size
+    end
+
+    def term_largest_worker
+      largest_worker.term
+    #   Process.wait(largest_worker.pid)
+    # rescue Errno::ECHILD
+    end
+
+    def running?
+      @master && workers.any?
+    end
+
+    def smallest_worker
+      smallest, _ = workers.to_a.first
+      smallest
+    end
+
+    def smallest_worker_memory
+      _, smallest_mem = workers.to_a.first
+      smallest_mem
+    end
+
+    def largest_worker
+      largest_worker, _ = workers.to_a.last
+      largest_worker
+    end
+
+    def largest_worker_memory
+      _, largest_memory_used = workers.to_a.last
+      largest_memory_used
+    end
+
+    # Will refresh @workers
+    def get_total(workers = set_workers)
+      master_memory = GetProcessMem.new(Process.pid).mb
+      worker_memory = workers.map {|_, mem| mem }.inject(&:+) || 0
+      worker_memory + master_memory
+    end
+    alias :get_total_memory :get_total
+
+    def workers
+      @workers || set_workers
+    end
+
+    private
+
+    def get_master
+      ObjectSpace.each_object(Puma::Cluster).map { |obj| obj }.first if defined?(Puma::Cluster)
+    end
+
+    # Returns sorted hash, keys are worker objects, values are memory used per worker
+    # sorted by memory ascending (smallest first, largest last)
+    def set_workers
+      workers = {}
+      @master.instance_variable_get("@workers").each do |worker|
+        workers[worker] = GetProcessMem.new(worker.pid).mb
+      end
+      if workers.any?
+        @workers = Hash[ workers.sort_by {|_, mem| mem } ]
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/puma_worker_killer/reaper.rb

@@ -1,46 +1,22 @@
 module PumaWorkerKiller
   class Reaper
-    def initialize(max_ram, master = self.get_master)
+    def initialize(max_ram, master = nil)
+      @cluster = PumaWorkerKiller::PumaMemory.new(master)
       @max_ram = max_ram
-      @master  = master
     end
 
-    def get_master
-      ObjectSpace.each_object(Puma::Cluster).map { |obj| obj }.first
-    end
-
-    def get_memory(pid)
-      GetProcessMem.new(pid).mb
-    end
-
-    def get_workers
-      workers = {}
-      @master.instance_variable_get("@workers").each { |worker| workers[worker] = get_memory(worker.pid) }
-      workers
-    end
-
-    def get_total_memory(workers = self.get_workers)
-      master_memory = get_memory(Process.pid)
-      worker_memory = workers.map {|_, mem| mem }.inject(&:+) || 0
-      worker_memory + master_memory
-    end
-
-    def wait(pid)
-      Process.wait(pid)
-    rescue Errno::ECHILD
+    # used for tes
+    def get_total_memory
+      @cluster.get_total_memory
     end
 
     def reap
-      return false unless @master
-      workers      = get_workers
-      total_memory = get_total_memory(workers)
-      if workers.any? && total_memory > @max_ram
-        biggest_worker, memory_used = workers.sort_by {|_, mem| mem }.last
-        biggest_worker.term
-        @master.log "PumaWorkerKiller: Out of memory. #{workers.count} workers consuming total: #{total_memory} mb out of max: #{@max_ram} mb. Sending TERM to #{biggest_worker.inspect} consuming #{memory_used} mb."
-        wait(biggest_worker.pid)
+      return false unless @cluster.running?
+      if (total = get_total_memory) > @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 #{@cluster.largest_worker.inspect} consuming #{@cluster.largest_worker_memory} mb."
+        @cluster.term_largest_worker
       else
-        @master.log "PumaWorkerKiller: Consuming #{total_memory} mb with master and #{workers.count} workers"
+        @cluster.master.log "PumaWorkerKiller: Consuming #{total} mb with master and #{@cluster.workers.count} workers"
       end
     end
   end

data/lib/puma_worker_killer/version.rb

@@ -1,3 +1,3 @@
 module PumaWorkerKiller
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/puma_worker_killer.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = PumaWorkerKiller::VERSION
   gem.authors       = ["Richard Schneeman"]
   gem.email         = ["richard.schneeman+rubygems@gmail.com"]
-  gem.description   = %q{ }
-  gem.summary       = %q{ }
+  gem.description   = %q{ Kills pumas, the code kind }
+  gem.summary       = %q{ If you have a memory leak in your web code puma_worker_killer can keep it in check. }
   gem.homepage      = "https://github.com/schneems/puma_worker_killer"
   gem.license       = "MIT"
 

data/test/fixtures/app.ru

@@ -0,0 +1,25 @@
+require 'rack'
+require 'rack/server'
+
+require 'puma_worker_killer'
+
+PumaWorkerKiller.config do |config|
+  config.ram       = Integer(ENV['PUMA_RAM'])       if ENV['PUMA_RAM']
+  config.frequency = Integer(ENV['PUMA_FREQUENCY']) if ENV['PUMA_FREQUENCY']
+end
+PumaWorkerKiller.start
+
+
+class HelloWorld
+  def response
+    [200, {}, ['Hello World']]
+  end
+end
+
+class HelloWorldApp
+  def self.call(env)
+    HelloWorld.new.response
+  end
+end
+
+run HelloWorldApp

data/test/puma_worker_killer_test.rb

@@ -2,6 +2,18 @@ require 'test_helper'
 
 class PumaWorkerKillerTest < Test::Unit::TestCase
 
+  def test_starts
+    app_path = fixture_path.join("app.ru")
+    port     = 0 # http://stackoverflow.com/questions/200484/how-do-you-find-a-free-tcp-server-port-using-ruby
+    puma_log = Pathname.new "puma.log"
+    `rm #{puma_log}; touch #{puma_log}`
+    pid  = Process.spawn("PUMA_FREQUENCY=1 bundle exec puma #{app_path} -t 1:1 -w 5 --preload --debug -p #{port} > #{puma_log}")
+    sleep 5
+    assert_match "PumaWorkerKiller:", puma_log.read
+  ensure
+    Process.kill('TERM', pid) if pid
+  end
+
   def test_worker_reaped
     ram      = 1 #mb
     cluster = FakeCluster.new
@@ -25,18 +37,20 @@ class PumaWorkerKillerTest < Test::Unit::TestCase
   end
 
   def test_kills_memory_leak
-    ram     = 75 #mb
+    ram     = rand(75..100) #mb
     cluster = FakeCluster.new
     reaper  = PumaWorkerKiller::Reaper.new(ram, cluster)
     while reaper.get_total_memory < (ram * 0.80)
       cluster.add_worker
+      sleep 0.01
     end
 
     reaper.reap
     assert_equal 0, cluster.workers.select {|w| w.is_term? }.count
 
-    while reaper.get_total_memory < ram
+    until reaper.get_total_memory > ram
       cluster.add_worker
+      sleep 0.01
     end
 
     reaper.reap

data/test/test_helper.rb

@@ -3,6 +3,9 @@ Bundler.require
 require 'puma_worker_killer'
 require 'test/unit'
 
+def fixture_path
+  Pathname.new(File.expand_path("../fixtures", __FILE__))
+end
 
 # Mock object stand in for Puma::Cluster
 class FakeCluster
@@ -10,6 +13,9 @@ class FakeCluster
     @workers = []
   end
 
+  def wakeup!
+  end
+
   class Worker
     attr_accessor :pid
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma_worker_killer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-14 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
-description: " "
+description: " Kills pumas, the code kind "
 email:
 - richard.schneeman+rubygems@gmail.com
 executables: []
@@ -66,9 +66,11 @@ files:
 - Rakefile
 - lib/puma_worker_killer.rb
 - lib/puma_worker_killer/auto_reap.rb
+- lib/puma_worker_killer/puma_memory.rb
 - lib/puma_worker_killer/reaper.rb
 - lib/puma_worker_killer/version.rb
 - puma_worker_killer.gemspec
+- test/fixtures/app.ru
 - test/puma_worker_killer_test.rb
 - test/test_helper.rb
 homepage: https://github.com/schneems/puma_worker_killer
@@ -91,11 +93,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: ''
+summary: If you have a memory leak in your web code puma_worker_killer can keep it
+  in check.
 test_files:
+- test/fixtures/app.ru
 - test/puma_worker_killer_test.rb
 - test/test_helper.rb
-has_rdoc: