worker_killer 0.0.9.19836 → 0.1.0.19839

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6afd0ad3285687093b9b10b00153eb82e127939acff50aeb0e34c29380058120
-  data.tar.gz: e8ce002079c3caf5681ec11db247bbdd3a4dab124cd06929c28a821a4ae6235d
+  metadata.gz: 87ac13b4bd486015cd2e99a580fa311878b094b2dd621351c7b8997c476a50ff
+  data.tar.gz: 5635186d2b8cf8d7b25d72c639733ca603afea7406f3d0bb7e172ff7d52d941d
 SHA512:
-  metadata.gz: 482658ddc4984d4571a2b1cf8469e23fed14aab4d6a8fa3131d7d21c07d840b2b89ba121d441163141f6e6ed9a068b3a726ee242e10b9f05da4ce38404ee9e08
-  data.tar.gz: 248995d17c2e791a22d7e5af51849f0b421bdfef360c0c961bd346096d6959499a3b92b53b42495c8961291680e79239c45de3fef2f0d19e3618e6e8f98ac92c
+  metadata.gz: 6e72c3f683cc72d7e18937ec6cc2ae66281149418dad1dc26f1649a6a62f92009d15f643c292cb79a445b867d2305fae5198a8721a1a2b92350346f7f6d070bd
+  data.tar.gz: 85c8cd4872a38b99d2aed420ba52c69f14746e86d2ff12d61103c79b96c40fc35fb46770ac79f15f3b6d672d4857f2c15d44388efc052b0017bb494d3ea644e7

data/README.md

@@ -1,43 +1,52 @@
-# unicorn-worker-killer
+# worker-killer
 
-[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.
+Kill any workers by memory and request counts or take custom reaction. Inspired by [unicorn-worker-killer](https://github.com/kzk/unicorn-worker-killer).
 
-`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.
+`worker-killer` gem provides automatic restart of Web-server based on 1) max number of requests, and 2) process memory size (RSS). This will greatly improves site's stability by avoiding unexpected memory exhaustion at the application nodes.
+
+Features:
+
+* generic middleware implementation
+* custom reactin hook
+
+Planned:
+
+* DelayedJob support
 
 # Install
 
-No external process like `god` is required. Just install one gem: `unicorn-worker-killer`.
+No external process like `god` is required. Just install one gem: `worker-killer`.
 
-    gem 'unicorn-worker-killer'
+    gem 'worker-killer'
 
 # Usage
 
-Add these lines to your `config.ru`. (These lines should be added above the `require ::File.expand_path('../config/environment',  __FILE__)` line.
+Add these lines to your `config.ru` or `application.rb`. (These lines should be added above the `require ::File.expand_path('../config/environment',  __FILE__)` line.
 
-    # Unicorn self-process killer
-    require 'unicorn/worker_killer'
+    # self-process killer
+    require 'worker_killer/middleware'
     
     # Max requests per worker
-    use Unicorn::WorkerKiller::MaxRequests, 3072, 4096
+    config.middleware.insert_before(Rack::Sendfile, WorkerKiller::Middleware::RequestsLimiter, min: 4096, max: 5120)
     
     # Max memory size (RSS) per worker
-    use Unicorn::WorkerKiller::Oom, (192*(1024**2)), (256*(1024**2))
+    config.middleware.insert_before(Rack::Sendfile, WorkerKiller::Middleware::OOMLimiter, min: 300 * (1024**2), max: 400 * (1024**2))
 
-This gem provides two modules.
+This gem provides two modules: WorkerKiller::CountLimiter and WorkerKiller::MemoryLimiter and some Rack integration.
 
-### `Unicorn::WorkerKiller::MaxRequests(max_requests_min=3072, max_requests_max=4096, verbose=false)`
+### `WorkerKiller::Middleware::RequestsLimiter`
 
-This module automatically restarts the Unicorn workers, based on the number of requests which worker processed.
+This module automatically restarts the kill 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.
+`min` and `max` specify the min and max of maximum requests per worker. The actual limit is decided by rand() between `min` and `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.
 
 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)`
+### `WorkerKiller::Middleware::OOMLimiter`
 
 This module automatically restarts the Unicorn workers, based on its memory size.
 
-`memory_limit_min` and `memory_limit_max` specify the min and max of maximum memory in bytes per worker. The actual limit is decided by rand() between `memory_limit_min` and `memory_limit_max` per worker, to prevent all workers to be dead at the same time.  Once the memory size exceeds `memory_size`, that worker is automatically restarted.
+`min` and `max` specify the min and max of maximum memory in bytes per worker. The actual limit is decided by rand() between `min` and `max` per worker, to prevent all workers to be dead at the same time.  Once the memory size exceeds `memory_size`, that worker is automatically restarted.
 
 The memory size check is done in every `check_cycle` requests.
 
@@ -46,4 +55,5 @@ If `verbose` is set to true, then every memory size check will be shown in your
 # Special Thanks
 
 - [@hotchpotch](http://github.com/hotchpotch/) for the [original idea](https://gist.github.com/hotchpotch/1258681)
+- [@kzk](http://github.com/kzk/) for the [unicorn-worker-killer](https://github.com/kzk/unicorn-worker-killer)
 

data/lib/worker-killer.rb

@@ -1 +1,2 @@
-require 'worker_killer'
+require 'worker_killer'
+

data/lib/worker_killer/version.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
 module WorkerKiller
-    VERSION = '0.0.9'
-end
+
+  VERSION = '0.1.0'
+
+end
+

data/spec/middleware_spec.rb

@@ -19,7 +19,7 @@ RSpec.describe WorkerKiller::Middleware do
   end
 
   describe WorkerKiller::Middleware::RequestsLimiter do
-    let(:options){ {reaction: reaction, min: 1111 } }
+    let(:options){ { reaction: reaction, min: 1111 } }
     subject{ described_class.new(app, options) }
 
     it 'is expected to be initialized with reaction' do
@@ -31,7 +31,7 @@ RSpec.describe WorkerKiller::Middleware do
   end
 
   describe WorkerKiller::Middleware::OOMLimiter do
-    let(:options){ {reaction: reaction, min: 2222 } }
+    let(:options){ { reaction: reaction, min: 2222 } }
     subject{ described_class.new(app, options) }
 
     it 'is expected to be initialized with reaction' do
@@ -41,6 +41,5 @@ RSpec.describe WorkerKiller::Middleware do
       expect(subject.limiter.reaction).to eq(reaction)
     end
   end
-
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: worker_killer
 version: !ruby/object:Gem::Version
-  version: 0.0.9.19836
+  version: 0.1.0.19839
 platform: ruby
 authors:
 - Samoilenko Yuri