unicorn-worker-killer 0.4.1 → 0.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: 420acce9af285728e9a01073187ff9a30d04c59f
+  data.tar.gz: 3c64abf746d3b61cb62bffd8b9d504ec43ba62fb
+!binary "U0hBNTEy":
+  metadata.gz: 5e3eb914600705eb38a473e6f87cab3433647be992248bffe1c4c4e6472cc03f689e34473dd087e72a359102d0d9979ab8773d347283722179f40ae8f0146f45
+  data.tar.gz: d094e7db25d113ff730551ac538b4ccee4dd0bea1ae65629ab36fee762bdddbf40ea8a0ef31e03430dabd4383d98fbac08273eba970b8dfc9fca69a669625427

data/README.md

@@ -1,6 +1,6 @@
 # unicorn-worker-killer
 
-[Unicorn](http://unicorn.bogomips.org/) is widely used HTTP-server for Rack applications. One thing we thought Unicorn misssed, is killing the Unicorn workers based on the number of requests and consumed memories.
+[Unicorn](http://unicorn.bogomips.org/) is widely used HTTP-server for Rack applications. One thing we thought Unicorn missed, is killing the Unicorn workers based on the number of requests and consumed memories.
 
 `unicorn-worker-killer` gem provides automatic restart of Unicorn workers based on 1) max number of requests, and 2) process memory size (RSS), without affecting any requests. This will greatly improves site's stability by avoiding unexpected memory exhaustion at the application nodes.
 
@@ -12,7 +12,7 @@ No external process like `god` is required. Just install one gem: `unicorn-worke
 
 # Usage
 
-Add these lines to your `config.ru`.
+Add these lines to your `config.ru`. (These lines should be added above the `require ::File.expand_path('../config/environment',  __FILE__)` line.
 
     # Unicorn self-process killer
     require 'unicorn/worker_killer'
@@ -25,13 +25,15 @@ Add these lines to your `config.ru`.
 
 This gem provides two modules.
 
-### Unicorn::WorkerKiller::MaxRequests(max_requests_min=3072, max_requests_max=4096)
+### Unicorn::WorkerKiller::MaxRequests(max_requests_min=3072, max_requests_max=4096, verbose=false)
 
 This module automatically restarts the Unicorn workers, based on the number of requests which worker processed.
 
 `max_requests_min` and `max_requests_max` specify the min and max of maximum requests per worker. The actual limit is decided by rand() between `max_requests_min` and `max_requests_max` per worker, to prevent all workers to be dead at the same time. Once the number exceeds the limit, that worker is automatically restarted.
 
-### Unicorn::WorkerKiller::Oom(memory_limit_min=(1024**3), memory_limit_max=(2*(1024**3)), check_cycle = 16)
+If `verbose` is set to true, then after every request, your log will show the requests left before restart.  This logging is done at the `info` level.
+
+### Unicorn::WorkerKiller::Oom(memory_limit_min=(1024**3), memory_limit_max=(2*(1024**3)), check_cycle = 16, verbose = false)
 
 This module automatically restarts the Unicorn workers, based on its memory size.
 
@@ -39,5 +41,9 @@ This module automatically restarts the Unicorn workers, based on its memory size
 
 The memory size check is done in every `check_cycle` requests.
 
-# TODO
-- Get RSS (Resident Set Size) without forking the child process at Mac OS and Windows
+If `verbose` is set to true, then every memory size check will be shown in your logs.   This logging is done at the `info` level.
+
+# Special Thanks
+
+- [@hotchpotch](http://github.com/hotchpotch/) for the [original idea](https://gist.github.com/hotchpotch/1258681)
+

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.4.2

data/lib/unicorn/worker_killer.rb

@@ -31,13 +31,14 @@ module Unicorn::WorkerKiller
     # affect the request.
     #
     # @see https://github.com/defunkt/unicorn/blob/master/lib/unicorn/oob_gc.rb#L40
-    def self.new(app, memory_limit_min = (1024**3), memory_limit_max = (2*(1024**3)), check_cycle = 16)
+    def self.new(app, memory_limit_min = (1024**3), memory_limit_max = (2*(1024**3)), check_cycle = 16, verbose = false)
       ObjectSpace.each_object(Unicorn::HttpServer) do |s|
         s.extend(self)
         s.instance_variable_set(:@_worker_memory_limit_min, memory_limit_min)
         s.instance_variable_set(:@_worker_memory_limit_max, memory_limit_max)
         s.instance_variable_set(:@_worker_check_cycle, check_cycle)
         s.instance_variable_set(:@_worker_check_count, 0)
+        s.instance_variable_set(:@_verbose, verbose)
       end
       app # pretend to be Rack middleware since it was in the past
     end
@@ -48,7 +49,6 @@ module Unicorn::WorkerKiller
 
     def process_client(client)
       super(client) # Unicorn::HttpServer#process_client
-
       return if @_worker_memory_limit_min == 0 && @_worker_memory_limit_max == 0
 
       @_worker_process_start ||= Time.now
@@ -57,6 +57,7 @@ module Unicorn::WorkerKiller
 
       if @_worker_check_count % @_worker_check_cycle == 0
         rss = _worker_rss()
+        logger.info "#{self}: worker (pid: #{Process.pid}) using #{rss} bytes." if @_verbose
         if rss > @_worker_memory_limit
           logger.warn "#{self}: worker (pid: #{Process.pid}) exceeds memory limit (#{rss} bytes > #{@_worker_memory_limit} bytes)"
           Unicorn::WorkerKiller.kill_self(logger, @_worker_process_start)
@@ -104,11 +105,12 @@ module Unicorn::WorkerKiller
     # affect the request.
     #
     # @see https://github.com/defunkt/unicorn/blob/master/lib/unicorn/oob_gc.rb#L40
-    def self.new(app, max_requests_min = 3072, max_requests_max = 4096)
+    def self.new(app, max_requests_min = 3072, max_requests_max = 4096, verbose = false)
       ObjectSpace.each_object(Unicorn::HttpServer) do |s|
         s.extend(self)
         s.instance_variable_set(:@_worker_max_requests_min, max_requests_min)
         s.instance_variable_set(:@_worker_max_requests_max, max_requests_max)
+        s.instance_variable_set(:@_verbose, verbose)
       end
 
       app # pretend to be Rack middleware since it was in the past
@@ -125,6 +127,7 @@ module Unicorn::WorkerKiller
       @_worker_process_start ||= Time.now
       @_worker_cur_requests ||= @_worker_max_requests_min + randomize(@_worker_max_requests_max - @_worker_max_requests_min + 1)
       @_worker_max_requests ||= @_worker_cur_requests
+      logger.info "#{self}: worker (pid: #{Process.pid}) has #{@_worker_cur_requests} left before being killed" if @_verbose
 
       if (@_worker_cur_requests -= 1) <= 0
         logger.warn "#{self}: worker (pid: #{Process.pid}) exceeds max number of requests (limit: #{@_worker_max_requests})"

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unicorn-worker-killer
 version: !ruby/object:Gem::Version
-  version: 0.4.1
-  prerelease: 
+  version: 0.4.2
 platform: ruby
 authors:
 - Kazuki Ohta
@@ -11,12 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-15 00:00:00.000000000 Z
+date: 2013-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicorn
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -24,7 +22,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -32,7 +29,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -40,7 +36,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -66,26 +61,25 @@ files:
 - unicorn-worker-killer.gemspec
 homepage: https://github.com/kzk/unicorn-worker-killer
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Kill unicorn workers by memory and request counts
 test_files: []