puma_worker_killer 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52f6ead7a78bc887408c2a249b3aed913fe90129
-  data.tar.gz: 752ef55b46747f29aa84b92d84d0d72496fe315a
+  metadata.gz: 48de7bd76c24b540567047c78701abd668b5a8d1
+  data.tar.gz: 66ecc21b98a516a97e533325008a4ccbb8cf7b14
 SHA512:
-  metadata.gz: 2c12b64d3108e5c4921dba09eb832edbfc008edfeade7cae4ca77429aea1da1dfcbe7fe49f37ac3ac2b5048ebf947e555cc45b352ca6e0303acf8fa9ed38705c
-  data.tar.gz: 99ef751d60702d8ffd5d5eb83d8cb6fc22e5d4174d5fc3cba199bcec5b48dd46c3c80c7eb0682ab7708e484add4957d819656bb3d7742ceac30d59c3e92e14ea
+  metadata.gz: dbcf620657fe6b2f04c0904da89bba0f739f3ce30dcbc50cabc668e8664e97a6d4bfa756da1f9fa6f571c25cc79d1dd31f408ea3e78bd70cfca81a72d3411df7
+  data.tar.gz: a464e3a896491affbbc724a6ba32919b6027353fe03de1397eb226b9b777fb768a58cd191ee9a7334cad3f8854fa5b21c9a05a6fa7bbbea684210aa31e03e391

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.0.4
+
+- Add ability to do rolling restart
+
+## 0.0.3
+
+- Fix memory metrics in on linux

data/README.md

@@ -5,7 +5,11 @@
 
 ## What
 
-If you have a memory leak in your code, finding and plugging it can be a herculean effort. Instead what if you just killed your processes when they got to be too large? The Puma Worker Killer does just that. Similar to [Unicorn Worker Killer](https://github.com/kzk/unicorn-worker-killer) but for the Puma web server. Note that Puma can uses threads or processes to add concurrency, the Puma Worker Killer only helps if you are using clustered mode (concurrency via process).
+If you have a memory leak in your code, finding and plugging it can be a herculean effort. Instead what if you just killed your processes when they got to be too large? The Puma Worker Killer does just that. Similar to [Unicorn Worker Killer](https://github.com/kzk/unicorn-worker-killer) but for the Puma web server.
+
+Puma worker killer can only function if you have enabled cluster mode or hybrid mode (threads + worker cluster). If you are only using threads (and not workers) then puma worker killer cannot help keep your memory in control.
+
+BTW restarting your processes to controll memory is like putting a bandaid on a gunshot wound, try figuring out the reason you're seeing so much memory bloat [derailed benchmarks](https://github.com/schneems/derailed_benchmarks) can help.
 
 
 ## Install
@@ -18,11 +22,17 @@ gem 'puma_worker_killer'
 
 Then run `$ bundle install`
 
+<!--
 ## Use
 
+> If you like `puma_worker_killer` consider using [puma_auto_tune instead](https://github.com/schneems/puma_auto_tune). It handles memory leaks and tunes your workers too!
+
+-->
+
 Somewhere in your main process run this code:
 
 ```ruby
+# config/initializers/puma_worker_killer.rb
 PumaWorkerKiller.start
 ```
 
@@ -37,7 +47,9 @@ 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
 end
+PumaWorkerKiller.start
 ```
 
 It is important that you tell your code how much RAM is available on your system. The default is 512 mb (the same size as a Heroku 1x dyno). You can change this value like this:
@@ -58,6 +70,29 @@ You may want to tune the worker killer to run more or less often. You can adjust
 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
+```
+
+By default PumaWorkerKiller will perform a rolling restart of all your worker processes every 12 hours. To disable, set to `false`.
+
+## Only turn on Rolling Restarts
+
+If you're running on a platform like [Heroku where it is difficult to measure RAM from inside of a container accurately](https://github.com/schneems/get_process_mem/issues/7), you may want to disable the "worker killer" functionality and only use the rolling restart. You can do that by running:
+
+```ruby
+PumaWorkerKiller.enable_rolling_restart
+```
+
+or you can pass in the restart frequency
+
+```ruby
+PumaWorkerKiller.enable_rolling_restart(12 * 3600) # 12 hours in seconds
+```
+
+Make sure if you do this to not accidentally call `PumaWorkerKiller.start` as well.
 
 ## License
 
@@ -66,4 +101,4 @@ MIT
 
 ## Feedback
 
-Open up an issue or ping me on twitter [@schneems](http://twitter.com/schneems).
+Open up an issue or ping me on twitter [@schneems](http://twitter.com/schneems).

data/lib/puma_worker_killer.rb

@@ -3,10 +3,11 @@ require 'get_process_mem'
 module PumaWorkerKiller
   extend self
 
-  attr_accessor :ram, :frequency, :percent_usage
+  attr_accessor :ram, :frequency, :percent_usage, :rolling_restart_frequency
   self.ram           = 512  # mb
   self.frequency     = 10   # seconds
   self.percent_usage = 0.99 # percent of RAM to use
+  self.rolling_restart_frequency = 6 * 3600
 
   def config
     yield self
@@ -18,10 +19,17 @@ module PumaWorkerKiller
 
   def start(frequency = self.frequency, reaper = self.reaper)
     AutoReap.new(frequency, reaper).start
+    enable_rolling_restart(rolling_restart_frequency) if rolling_restart_frequency
+  end
+
+  def enable_rolling_restart(frequency = self.rolling_restart_frequency)
+    frequency = frequency + rand(0..10.0) # so all workers don't restart at the exact same time across multiple machines
+    AutoReap.new(frequency, RollingRestart.new).start
   end
 end
 
 require 'puma_worker_killer/puma_memory'
 require 'puma_worker_killer/reaper'
+require 'puma_worker_killer/rolling_restart'
 require 'puma_worker_killer/auto_reap'
-require 'puma_worker_killer/version'
+require 'puma_worker_killer/version'

data/lib/puma_worker_killer/auto_reap.rb

@@ -18,4 +18,4 @@ module PumaWorkerKiller
     end
 
   end
-end
+end

data/lib/puma_worker_killer/rolling_restart.rb

@@ -0,0 +1,21 @@
+module PumaWorkerKiller
+  class RollingRestart
+    def initialize(master = nil)
+      @cluster = PumaWorkerKiller::PumaMemory.new(master)
+    end
+
+    # used for tes
+    def get_total_memory
+      @cluster.get_total_memory
+    end
+
+    def reap(wait_between_worker_kill = 60) # seconds
+      return false unless @cluster.running?
+      @cluster.workers.each do |worker, ram|
+        @cluster.master.log "PumaWorkerKiller: Rolling Restart. #{@cluster.workers.count} workers consuming total: #{ get_total_memory } mb out of max: #{@max_ram} mb. Sending TERM to #{worker.inspect}"
+        worker.term
+        sleep wait_between_worker_kill
+      end
+    end
+  end
+end

data/lib/puma_worker_killer/version.rb

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

data/puma_worker_killer.gemspec

@@ -18,7 +18,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "puma",              "~> 2"
-  gem.add_dependency "get_process_mem",   "~> 0"
+  gem.add_dependency "puma",              "~>  2.7"
+  gem.add_dependency "get_process_mem",   "~>  0.2"
   gem.add_development_dependency "rake",  "~> 10.1"
+  gem.add_development_dependency "test-unit",  ">= 0"
+
 end

data/test/fixtures/app.ru

@@ -10,6 +10,8 @@ end
 PumaWorkerKiller.start
 
 
+puts "Frequency: #{PumaWorkerKiller.frequency}" if ENV['PUMA_FREQUENCY']
+
 class HelloWorld
   def response
     [200, {}, ['Hello World']]

data/test/puma_worker_killer_test.rb

@@ -5,12 +5,12 @@ 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}")
+    puma_log = Pathname.new "#{ SecureRandom.hex }-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
+    puma_log.delete
     Process.kill('TERM', pid) if pid
   end
 
@@ -59,4 +59,19 @@ class PumaWorkerKillerTest < Test::Unit::TestCase
     cluster.workers.map(&:term)
   end
 
+
+  def test_rolling_restart
+    ram     = rand(75..100) #mb
+    cluster = FakeCluster.new
+    cluster.add_worker
+
+    worker = cluster.workers.first
+    reaper = PumaWorkerKiller::RollingRestart.new(cluster)
+    reaper.reap(1)
+
+    assert_equal 1, cluster.workers.select {|w| w.is_term? }.count
+  ensure
+    cluster.workers.map(&:term)
+  end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma_worker_killer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-28 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: get_process_mem
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: " Kills pumas, the code kind "
 email:
 - richard.schneeman+rubygems@gmail.com
@@ -61,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -68,6 +83,7 @@ files:
 - lib/puma_worker_killer/auto_reap.rb
 - lib/puma_worker_killer/puma_memory.rb
 - lib/puma_worker_killer/reaper.rb
+- lib/puma_worker_killer/rolling_restart.rb
 - lib/puma_worker_killer/version.rb
 - puma_worker_killer.gemspec
 - test/fixtures/app.ru
@@ -93,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: If you have a memory leak in your web code puma_worker_killer can keep it