unicorn_wrangler 0.3.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 39f9ac2e8cbfa6df6d0028f7290ce66aa63f04d0
-  data.tar.gz: 51c10c3a567dae4aaa5fdb585946b1e35232b64d
+SHA256:
+  metadata.gz: f027def0eaa75e21daf9efc322a1be988248b5cd117d12eb2ddfadc10494e4d7
+  data.tar.gz: a765f7d06d90f8ef448ae1ac87eeb0fc01dddac587dce8d1c69f00acbf6c0164
 SHA512:
-  metadata.gz: 88cb0d183f32cbf7e15d0da3a070e90106dc2858d2224f349224225d8bd645aa36631b4c2516e239c35cef97b9a6f6e46b7b020207b02e173d66393d71f41eae
-  data.tar.gz: 79c384c059e73b602d7d2e6d74387c1ea495098279f6284819072596a7e2db84e2ca700ed66a9b8b171ee32de1164f766f828cb9fa99a8e98ead96e4f0cf0fe2
+  metadata.gz: 91787cc20b2bafa1334af58dc5bc29985c3f7d165451cfd36fb45e5d63069ce36525f4d63f2a27fb09fdc29215aab0dcb62ad8cacf0e1cae067b5a20e4740188
+  data.tar.gz: 7b6ca2549873589cd9c837affafcc9a9fc07878476c7554f785b20c30b132a1d9e1f9ad12c24af9c16b27d40dae70cd47a7581f28642ea643e055bf9ff95d2ca

data/lib/unicorn_wrangler.rb

@@ -9,6 +9,7 @@ module UnicornWrangler
 
   class << self
     attr_reader :handlers
+    attr_accessor :sending_myself_term
 
     # called from unicorn config (usually config/unicorn.rb)
     # high level interface to keep setup consistent / simple
@@ -17,6 +18,7 @@ module UnicornWrangler
       kill_after_requests: 10000,
       gc_after_request_time: 10,
       kill_on_too_much_memory: {},
+      map_term_to_quit: false,
       logger:,
       stats: nil # provide a statsd client with your apps namespace to collect stats
     )
@@ -25,9 +27,40 @@ module UnicornWrangler
       @handlers << RequestKiller.new(logger, stats, kill_after_requests) if kill_after_requests
       @handlers << OutOfMemoryKiller.new(logger, stats, kill_on_too_much_memory) if kill_on_too_much_memory
       @handlers << OutOfBandGC.new(logger, stats, gc_after_request_time) if gc_after_request_time
+
+      @hooks = {}
+      if map_term_to_quit
+        # - on heroku & kubernetes all processes get TERM, so we need to trap in master and worker
+        # - trapping has to be done in the before_fork since unicorn sets up it's own traps on start
+        # - we cannot write to logger inside of a trap, so need to spawn a new Thread
+        # - manual test: add a slow route + rails s + curl + pkill -TERM -f 'unicorn master' - request finished?
+        @hooks[:before_fork] = -> do
+          Signal.trap :TERM do
+            Thread.new { logger.info 'master intercepting TERM and sending myself QUIT instead' }
+            Process.kill :QUIT, Process.pid
+          end
+        end
+
+        @hooks[:after_fork] = ->(*) do
+          # Signal.trap returns the trap that unicorn set, which is an exit!(0) and calls that when sending myself term
+          previous_trap = Signal.trap :TERM do
+            if sending_myself_term
+              previous_trap.call
+            else
+              Thread.new { logger.info 'worker intercepting TERM and doing nothing. Wait for master to send QUIT' }
+            end
+          end
+        end
+      end
+
       Unicorn::HttpServer.prepend UnicornExtension
     end
 
+    def kill_worker
+      self.sending_myself_term = true # no need to clean up since we are dead after
+      Process.kill(:TERM, Process.pid)
+    end
+
     # called from the unicorn server after each request
     def perform_request
       returned = nil
@@ -39,12 +72,37 @@ module UnicornWrangler
     ensure
       @handlers.each { |handler| handler.call(@requests, @request_time) }
     end
+
+    def perform_hook(name)
+      if hook = @hooks[name]
+        hook.call
+      end
+    end
   end
 
   module UnicornExtension
+    # call our hook and the users hook since only a single hook can be configured at a time
+    # we need to call super so the @<hook> variables get set and unset properly in after_fork to not leak memory
+    [:after_fork, :before_fork].each do |hook|
+      define_method("#{hook}=") do |value|
+        super(->(*args) do
+          UnicornWrangler.perform_hook(hook)
+          value.call(*args)
+        end)
+      end
+    end
+
     def process_client(*)
       UnicornWrangler.perform_request { super }
     end
+
+    # run GC after we finished loading out app so forks inherit a clean GC environment
+    def build_app!
+      super
+    ensure
+      GC.start
+      GC.disable
+    end
   end
 
   class Killer
@@ -67,9 +125,9 @@ module UnicornWrangler
         @stats.histogram("#{STATS_NAMESPACE}.kill.total_request_time", request_time)
       end
 
-      report_status "Killing", reason, memory, requests, request_time
+      report_status "Killing", reason, memory, requests, request_time, :warn
 
-      Process.kill(:TERM, Process.pid)
+      UnicornWrangler.kill_worker
     end
 
     # expensive, do not run on every request
@@ -77,8 +135,8 @@ module UnicornWrangler
       `ps -o rss= -p #{Process.pid}`.to_i / 1024
     end
 
-    def report_status(status, reason, memory, requests, request_time)
-      @logger.info "#{status} unicorn worker ##{Process.pid} for #{reason}. Requests: #{requests}, Time: #{request_time}, Memory: #{memory}MB"
+    def report_status(status, reason, memory, requests, request_time, log_level = :debug)
+      @logger.send log_level, "#{status} unicorn worker ##{Process.pid} for #{reason}. Requests: #{requests}, Time: #{request_time}, Memory: #{memory}MB"
     end
   end
 
@@ -124,7 +182,6 @@ module UnicornWrangler
       @logger = logger
       @stats = stats
       @max_request_time = max_request_time
-      GC.disable
       @logger.info "Garbage collecting after #{@max_request_time}s of request processing time"
       @gc_ran_at = 0
     end
@@ -145,7 +202,7 @@ module UnicornWrangler
         @stats.increment("#{STATS_NAMESPACE}.oobgc.runs")
         @stats.timing("#{STATS_NAMESPACE}.oobgc.time", time)
       end
-      @logger.info "Garbage collecting: took #{time}ms"
+      @logger.debug "Garbage collecting: took #{time}ms"
       true
     end
   end

data/lib/unicorn_wrangler/version.rb

@@ -1,3 +1,3 @@
 module UnicornWrangler
-  VERSION = "0.3.0"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unicorn_wrangler
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-19 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: michael@grosser.it
@@ -38,8 +38,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: 'Unicorn: out of band GC / restart on max memory bloat / restart after X