unicorn-worker-killer 0.1.2 → 0.2.0

data/ChangeLog

@@ -1,4 +1,12 @@
-Release 0.1 - 2012/11/17
+Release 0.2.0 - 2012/11/22
+
+  * Change namespace to Unicorn::WorkerKiller from UnicornWorkerKiller
+
+Release 0.1.2 - 2012/11/17
+
+  * Change unicorn version dependency to '~> 4'
+
+Release 0.1.1 - 2012/11/17
 
   * Fix homepage
 

data/README.md

@@ -1,23 +1,43 @@
 # unicorn-worker-killer
 
-Killing Unicorn worker based on 1) Max number of requests and 2) Process memory size (RSS), without affecting the request.
+[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-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.
 
 # Install
 
+No external process like `god` is required. Just install one gem: `unicorn-worker-killer`.
+
     gem 'unicorn-worker-killer'
 
 # Usage
 
-Add these lines to your `config.ru`. It's highly recommended to randomize these numbers, to avoid killing all workers at once.
+Add these lines to your `config.ru`.
 
     # Unicorn self-process killer
     require 'unicorn/worker_killer'
     
     # Max requests per worker
-    use UnicornWorkerKiller::MaxRequests, 10240 + Random.rand(10240)
+    use Unicorn::WorkerKiller::MaxRequests, 10240 + Random.rand(10240)
     
     # Max memory size (RSS) per worker
-    use UnicornWorkerKiller::Oom, (96 + Random.rand(32)) * 1024**2
+    use Unicorn::WorkerKiller::Oom, (96 + Random.rand(32)) * 1024**2
+
+This gem provides two modules.
+
+### Unicorn::WorkerKiller::MaxRequests(max_requests = 1024)
+
+This module automatically restarts the Unicorn workers, based on the number of requests which worker processed.
+
+`max_requests` specifies the maximum number of requests which this worker should process. Once the number exceeds `max_requests`, that worker is automatically restarted. It's highly recommended to randomize this number to avoid restarting all workers at once.
+
+### Unicorn::WorkerKiller::Oom(memory_size = (1024**3), check_cycle = 16)
+
+This module automatically restarts the Unicorn workers, based on its memory size.
+
+`memory_size` specifies the maximum memory which this worker can have. Once the memory size exceeds `memory_size`, that worker is automatically restarted. It's highly recommended to randomize this number to avoid restarting all workers at once.
+
+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

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/unicorn/worker_killer.rb

@@ -1,4 +1,4 @@
-module UnicornWorkerKiller
+module Unicorn::WorkerKiller
   # Self-destruction by sending the signals to myself. The process sometimes
   # doesn't terminate by SIGTERM, so this tries to send SIGQUIT and SIGKILL
   # if it doesn't finish immediately.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unicorn-worker-killer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-18 00:00:00.000000000 Z
+date: 2012-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicorn