resque-worker-killer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9828594da6a4652add1a03fcd46ad5b3f3e06c68
-  data.tar.gz: d31927afb2293274a0755de5047821fb5c99cb87
+  metadata.gz: a1a23bdc379d3a62bce0e338cf942521a66cb9c8
+  data.tar.gz: c17c3e400a02b970e191d6fc5dbe3637fa6d19e9
 SHA512:
-  metadata.gz: 0d5c4fa9aebe743de6fd326ebc9e5b7491c7a79bc4fd438c5ac69cd101ddb8d59887ea1b5220a7f4424a021be808c2d4c3ee5c9e975b16c1b261ec771851e727
-  data.tar.gz: 9da4c88ed48f8a63f05e6b51938258b187192a756fe95a9be4f34da4d831f2d73b02b9f5441bf91b8d9a4ad2fd5846997550523564b0540ecd7179fd1a8265db
+  metadata.gz: ffce9a6ea932cf1aed36a2b309b883543cd6e79d1233f99f61b6dfe9cdf7c2104f1bab409692c07e878e28273349c6019e9450c9c38b745b84f4d85af6ad911c
+  data.tar.gz: 0c18a8d59ac8ee941f4ecfaaa656980dc29e59f8d97dcc9df5b8c410b865515f1cfcb74b0edf0ebf63cbaec37c5b69527d05b6199bb21fceaf47e904225e2993

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.1.1 (2016/08/21)
+
+Changes:
+
+* Change the default value of `@worker_killer_max_term` to `(ENV['TERM_CHILD'] ? 10 : 0)` from 10.
+
 # 0.1.0 (2016/08/20)
 
 First vesion

data/README.md

@@ -4,6 +4,8 @@
 
 resque-worker-killer gem provides automatic kill of a forked child of Resque worker based on process memory size (RSS) not to exceed the maximum allowed memory size.
 
+The name was inspired by [unicorn-worker-killer](https://github.com/kzk/unicorn-worker-killer) :-p
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -49,17 +51,29 @@ class MyJob
 end
 ```
 
-`TERM_CHILD` environment variable must be set on starting resque worker:
+### TERM_CHILD=1
+
+Resque requires to set `TERM_CHILD` environment variable to accept killing a forked child with SIGTERM.
 
 ```
 $ TERM_CHILD=1 bundle exec rake resque:work
 ```
+Thus,
+
+* Without `TERM_CHILD=1`, set `@worker_killter_max_term = 0` to send SIGKILL immediately
+* With `TERM_CHILD=1`, set `@worker_killer_max_term > 0` to try SIGTERM first, then SIGKILL
+
+With `TERM_CHILD=1`, `Resque::TermException` is raised if a forked child is killed by SIGTERM.
+
+## Options
 
 Options are:
 
 * `@worker_killer_monitor_interval`: Monotring interval to check RSS size (default: 1.0 sec)
 * `@worker_killer_mem_limit`: RSS usage limit, in killobytes (default: 300MB)
-* `@worker_killer_max_term`: Try kiling child process with SIGTERM in `@worker_killer_max_term` times (default: 10), then SIGKILL if it still does not die. Please note that resque worker must be started `TERM_CHILD=1` environment variable.
+* `@worker_killer_max_term`: Try kiling child process with SIGTERM in `max_term` times, then SIGKILL if it still does not die. 
+  Please note that setting `TERM_CHILD` environment variable is required to accept killing the child with SIGTERM.
+  The default is, 10 with `TERM_CHILD=1`, 0 without `TERM_CHILD=1`.
 * `@worker_killer_verbose`: Verbose log
 * `@worker_killer_logger`: Logger instance (default: Resque.logger)
 

data/example/my_job.rb

@@ -8,15 +8,15 @@ class MyJob
   extend Resque::Plugins::WorkerKiller
   @worker_killer_monitor_interval = 0.5 # sec
   @worker_killer_mem_limit = 10_000 # KB
-  @worker_killer_max_term = 10
+  @worker_killer_max_term = (ENV['TERM_CHILD'] ? 10 : 0)
   @worker_killer_verbose = true
   @worker_killer_logger = ::Logger.new(STDOUT)
 
   def self.perform(params)
     puts 'started'
-    sleep 3
+    sleep 1
     str = 'a' * 10 * 1024 * 1024
-    sleep 7
+    sleep 3
     puts 'finished'
   rescue Resque::TermException => e # env TERM_CHILD=1
     puts 'terminated'

data/lib/resque/plugins/worker_killer.rb

@@ -13,7 +13,7 @@ module Resque
       end
 
       def worker_killer_max_term
-        @worker_killer_max_term ||= 10
+        @worker_killer_max_term ||= (ENV['TERM_CHILD'] ? 10 : 0)
       end
 
       def worker_killer_verbose

data/lib/resque/plugins/worker_killer/version.rb

@@ -1,7 +1,7 @@
 module Resque
   module Plugins
     module WorkerKiller
-      VERSION = "0.1.0"
+      VERSION = "0.1.1"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-worker-killer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-19 00:00:00.000000000 Z
+date: 2016-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque