sidekiq_process_killer 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84e5673903431a47d9158bcbcb9de3d7f6863159
-  data.tar.gz: 54a0738048a84cc9a92506b7d196bac333ef24cb
+  metadata.gz: 2e33b6c981e60c62cb2d759e7477282962d48e20
+  data.tar.gz: be03799031354434d562e4095dc31b4fc31d7572
 SHA512:
-  metadata.gz: 4ea1e73fde7afaea140bf2340ffc11e825afb628b49ad30876670ab0beb28285cf9099e0ac271acb3786c9defaa6a0cef0b1333897f4f441035f7b4a2679e5b7
-  data.tar.gz: 33bcfb95b67911b32613673c742115bc2441b5b8f0fa6101b04d73cc78419f904b32d1e279e59979ab7676dbda86203a79f44062a876ab791971759edfddc0ca
+  metadata.gz: 3b87f6986e8ce7f86ee9410cbd1346aa7aa0fc86d9f46906704ae6cacb65669d5635559740ca7e881b9f99674108b1d957abdfc39beafd2ae36fd550dd259dd1
+  data.tar.gz: 42b3a2cfab92aff9b5c08dc28035589360571cdf0b99aab7efd4e0c5ab3ea928d9c0bf404fbd4dbe377c4b849163ef4cbc05418ed0c53432c5e4282f616a1e76

data/README.md

@@ -4,7 +4,7 @@
 
 When you have memory leaks or "bloats" in your ruby application, identifying and fixing them can at times be a nightmare. Instead, an _"acceptable"_ mitigation is to re-spin the workers. Its a common technique that can be found in [Puma Worker Killer](https://github.com/schneems/puma_worker_killer) or [Unicorn Worker Killer](https://github.com/kzk/unicorn-worker-killer). Though, its neater and good practice to find and fix your leaks.
 
-SidekiqProcessKiller plugs into Sidekiq's middleware and kills a process if its processing beyond the supplied [RSS](https://en.wikipedia.org/wiki/Resident_set_size) threshold. Since this plugs into the middleware, the check is performed after each job.
+SidekiqProcessKiller plugs into Sidekiq's middleware and kills a process (by sending `SIGTERM`) if its processing beyond the supplied [RSS](https://en.wikipedia.org/wiki/Resident_set_size) threshold. Since this plugs into the middleware, the check is performed after each job.
 
 ## Installation
 
@@ -20,22 +20,21 @@ Add the following to your Gemfile
 
 ### Configuration
 
-The default configurations are:
 
 ```ruby
 memory_threshold: 250.0 # mb
-shutdown_wait_timeout: 25 # seconds
-shutdown_signal: "SIGKILL"
 silent_mode: false
 statsd_klass: nil
 ```
 
-- `silent_mode`: When set to `true`, it will mean that no signals for terminate or otherwise will be sent. This is helpful if you are planning to launch this, but want to first do a dry run.
-- `memory_threshold`: This is the threshold, which, when, breached, the respective Sidekiq worker will be instructed for termination (via `TERM` signal, which sidekiq gracefully exits).
-- `shutdown_signal`: Signal for force shutdown/kill/quit.
-- `shutdown_wait_timeout`: If, for some reason, the process takes more than the timeout defined in `shutdown_wait_timeout`, to die, the process will be forced terminated using the signal set in `shutdown_signal`.
-- `statsd_klass`: This is your custom statsd class object which responds to an `increment` function. If present, then it will send custom metrics about the worker process that is being terminated and its respective RSS.
-  - The `increment` is called with a single argument of type `Hash` which contains, `metric_name`, `worker_name` and `current_memory_usage`. The implementation of this may not be very flexible, its expected that your custom class reads the passed in information and appropriately send to your statsd agent. PRs/patches welcome to extend this functionality :).
+
+
+| Config name           	| Description                                                                                                                                                                                                                                                                                                                                                                                                	|
+|-------------------------	|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------	|
+| `silent_mode`           	| When set to `true`, no signal will be sent to running process. This is helpful if you are planning to launch this, but want to first do a dry run.
+| `memory_threshold`      	| When current RSS is above this threshold, the respective Sidekiq worker will be instructed for termination (via `TERM` signal, which sidekiq gracefully exits).                                                                                                                                                                                                                                                                                                                                                                                                              	|
+| `statsd_klass`          	| This is a class object which responds to an `increment`. If present, the `increment` function will be called with a single argument of type `Hash` which contains, `metric_name`, `worker_name` and `current_memory_usage`. This class is called when attempting to terminate a process or if the process had to be forcefully be terminated.	|
+
 
 ### Updating default configuration:
 
@@ -57,8 +56,6 @@ end
 
 SidekiqProcessKiller.config do |con|
   con.memory_threshold = 1024.0
-  con.shutdown_wait_timeout = 60
-  con.shutdown_signal = "SIGUSR2"
   con.silent_mode = false
   con.statsd_klass = CustomMetric.new # your custom statsd class object
 end

data/lib/sidekiq_process_killer/middleware.rb

@@ -18,32 +18,12 @@ module SidekiqProcessKiller
       return if memory_threshold > memory
 
       log_warn("Breached RSS threshold at #{memory_threshold}. Sending TERM Signal.")
-
+      increment_statsd({
+        metric_name: "process.term.signal.sent",
+        worker_name: worker.class,
+        current_memory_usage: memory
+      })
       send_signal("SIGTERM", pid)
-      sleep(SidekiqProcessKiller.shutdown_wait_timeout)
-
-      shutdown_signal = SidekiqProcessKiller.shutdown_signal
-
-      begin
-        ::Process.getpgid(pid)
-        log_warn("Forcefully killing process with #{shutdown_signal}.")
-
-        increment_statsd({
-          metric_name: "process.killed.forcefully",
-          worker_name: worker.class,
-          current_memory_usage: memory
-        })
-
-        send_signal(shutdown_signal, pid)
-      rescue Errno::ESRCH
-        log_warn("Process killed successfully.")
-
-        increment_statsd({
-          metric_name: "process.killed.successfully",
-          worker_name: worker.class,
-          current_memory_usage: memory
-        })
-      end
     end
 
     private def process_memory
@@ -66,10 +46,6 @@ module SidekiqProcessKiller
       Sidekiq.logger.warn("[#{LOG_PREFIX}]#{silent_mode_msg} #{msg} #{humanized_attributes}")
     end
 
-    private def log_info(msg)
-      Sidekiq.logger.info("[#{LOG_PREFIX}]#{silent_mode_msg} #{msg} #{humanized_attributes}")
-    end
-
     private def send_signal(name, pid)
       return if SidekiqProcessKiller.silent_mode
 

data/lib/sidekiq_process_killer/version.rb

@@ -1,3 +1,3 @@
 module SidekiqProcessKiller
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/sidekiq_process_killer.rb

@@ -1,10 +1,8 @@
 module SidekiqProcessKiller
   extend self
 
-  attr_accessor :shutdown_wait_timeout, :shutdown_signal, :silent_mode, :statsd_klass
+  attr_accessor :silent_mode, :statsd_klass
 
-  self.shutdown_wait_timeout = 25 # seconds
-  self.shutdown_signal = "SIGKILL"
   self.silent_mode = false
   self.statsd_klass = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_process_killer
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Shayon Mukherjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2017-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler