worker_killer 1.0.3.189564 → 1.0.5.213889

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8de386a9112f6941110e0cc8f75d2276c859ca36d9cff4e5eadfb39dd33013fe
-  data.tar.gz: 7a1f7f3b042a3603db7e0a51a30cdb99f872bfb1288d8545c1b893241a1118f8
+  metadata.gz: 1d0558051a55e944e97bb26729239a97d7f150fb37885af8761246f78db4e280
+  data.tar.gz: 417bb8c4f0c4818d4e2a19ad4f2cb8cc5e3ca82621b925c81c2e4b33102803fb
 SHA512:
-  metadata.gz: a6397322a93eb40332f728b0b0bf5114aec40571f76ee3a6a64b1125be8fa7d9221f3158be4b1960fcd8c28b26cebe2b500cb582ebee39876414a881e709a0ed
-  data.tar.gz: 39bafdacf68392a4c1c05ac5b600d821a7e3cd368acbe3b585d855b1527e08b3898c53b17f458a74207c0987c2d93e9689302ce5c1a3b0d4b5c9138e8a382a67
+  metadata.gz: 855f6852cb2c7c8115388038f07d234958a6183c008d21b28ad8867a34a53dcfd713f34645c1b0f435fafc67f5f7ad0c1272b7b4f94f2d91b170ca91c0f97133
+  data.tar.gz: 8699bc63da513186e47cb1ef626f732e61cfe7a603231370223cbcea5ec3b6d8897a314ed5fe8dee9a23765822b4c20aa43ddc6fda7b02bb775f01aa1f838a7e

data/README.md

@@ -17,6 +17,7 @@ Features:
 
 - generic middleware implementation
 - Phusion Passenger support(through `passenger-config detach-process <PID>`)
+- Puma phased-restart support(through `pumactl phased-restart`)
 - DelayedJob support
 - custom reaction hook
 
@@ -42,14 +43,14 @@ Add these lines to your `config.ru` or `application.rb`. (These lines should be
 
   # Max requests per worker
   middleware.insert_before(
-    Rack::Sendfile,
+    Rack::Runtime,
     WorkerKiller::Middleware::RequestsLimiter, killer: killer, min: 3072, max: 4096
   )
 
   # Max memory size (RSS) per worker
   middleware.insert_before(
-    Rack::Sendfile,
-    WorkerKiller::Middleware::OOMLimiter, killer: killer, min: 500 * (1024**2), max: 600 * (1024**2)
+    Rack::Runtime,
+    WorkerKiller::Middleware::OOMLimiter, killer: killer, min: nil, max: 0.5, check_cycle: 16
   )
 ```
 
@@ -74,6 +75,39 @@ Add these lines to your `initializers/delayed_job.rb` or `application.rb`.
   end
 ```
 
+## Puma Web-server
+
+Add these lines to your `puma.rb` AND `application.rb`.
+
+```ruby
+  # puma.rb
+
+  on_worker_boot do |*args|
+    require 'worker_killer/killer'
+    require 'active_support/notifications'
+
+    ::ActiveSupport::Notifications.subscribe 'initialize.custom.rails' do |*eargs|
+      event = ActiveSupport::Notifications::Event.new(*eargs)
+      config = event.payload[:config]
+
+      killer = ::WorkerKiller::Killer::Puma.new
+      config.middleware.insert_before(
+        ::Rack::Runtime,
+        ::WorkerKiller::Middleware::RequestsLimiter, killer: killer, min: 3072, max: 4096
+      )
+
+      config.middleware.insert_before(
+        ::Rack::Runtime,
+        ::WorkerKiller::Middleware::OOMLimiter, killer: killer, min: nil, max: 0.5, verbose: true, check_cycle: 16
+      )
+    end
+  end
+
+  # application.rb
+
+  ActiveSupport::Notifications.instrument 'initialize.custom.rails', config: config
+```
+
 This gem provides two modules: WorkerKiller::CountLimiter and WorkerKiller::MemoryLimiter, some Rack integration and DelayedJob plugin.
 
 ### WorkerKiller::Middleware::RequestsLimiter and WorkerKiller::DelayedJobPlugin::JobsLimiter

data/lib/worker_killer/killer/passenger.rb

@@ -35,8 +35,8 @@ module WorkerKiller
 
       def self.check_passenger_config path
         path.strip!
-        help = `#{path} detach-process --help 2> /dev/null`
-        return path if help['Remove an application process from the Phusion Passenger process pool']
+        help_str = `#{path} detach-process --help 2> /dev/null`
+        return path if help_str['Remove an application process'] || help_str['Phusion Passenger']
       rescue StandardError => e
         nil
       end

data/lib/worker_killer/killer/puma.rb

@@ -0,0 +1,33 @@
+module ::WorkerKiller
+  module Killer
+    class Puma < ::WorkerKiller::Killer::Base
+
+      def initialize **kwrags
+        super
+      end
+
+      def do_kill(sig, pid, alive_sec, **_params)
+        cmd = 'pumactl phased-restart'
+
+        if sig == :KILL
+          logger.error "#{self} force to kill self (pid: #{pid}) alive: #{alive_sec} sec (trial #{kill_attempts})"
+          Process.kill sig, pid
+          return
+        end
+
+        return if @already_detached
+
+        logger.warn "#{self} run #{cmd.inspect} (pid: #{pid}) alive: #{alive_sec} sec (trial #{kill_attempts})"
+        @already_detached = true
+
+        Thread.new(cmd) do |command|
+          unless Kernel.system(command)
+            logger.warn "#{self} run #{command.inspect} failed: #{$?.inspect}"
+          end
+        end
+      end
+
+    end
+  end
+end
+

data/lib/worker_killer/killer.rb

@@ -38,5 +38,6 @@ end
 
 require_relative 'killer/signal'
 require_relative 'killer/passenger'
+require_relative 'killer/puma'
 require_relative 'killer/delayed_job'
 

data/lib/worker_killer/version.rb

@@ -2,7 +2,7 @@
 
 module WorkerKiller
 
-  VERSION = '1.0.3'
+  VERSION = '1.0.5'
 
 end
 

data/spec/killer/puma_spec.rb

@@ -0,0 +1,33 @@
+RSpec.describe WorkerKiller::Killer::Puma do
+  let(:config) do
+    WorkerKiller::Configuration.new.tap do |c|
+      c.quit_attempts = 2
+      c.term_attempts = 2
+    end
+  end
+
+  let(:killer){ described_class.new }
+
+  describe '#kill' do
+    around do |example|
+      prev = WorkerKiller.configuration
+      WorkerKiller.configuration = config
+      example.run
+    ensure
+      WorkerKiller.configuration = prev
+    end
+
+    it 'expect right signal order' do
+      expect(Kernel).to receive(:system).with('pumactl phased-restart').and_return(true)
+      expect(Process).to receive(:kill).with(:KILL, anything).exactly(5).times
+
+      thread = killer.kill(Time.now)
+      thread.join
+
+      1.times { killer.kill(Time.now) } # 1 QUIT
+      2.times { killer.kill(Time.now) } # 1 TERM
+      5.times { killer.kill(Time.now) } # 5 KILL
+    end
+  end
+end
+

data/spec/killer_spec.rb

@@ -19,7 +19,7 @@ RSpec.describe WorkerKiller::Killer::Base do
       end
 
       it 'expect right signal order' do
-        if RUBY_VERSION >= "3.0.0"
+        if RUBY_VERSION >= "2.7.0"
           expect(killer).to receive(:do_kill).with(:QUIT, anything, anything).exactly(2).times
           expect(killer).to receive(:do_kill).with(:TERM, anything, anything).exactly(2).times
           expect(killer).to receive(:do_kill).with(:KILL, anything, anything).exactly(5).times

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: worker_killer
 version: !ruby/object:Gem::Version
-  version: 1.0.3.189564
+  version: 1.0.5.213889
 platform: ruby
 authors:
 - Samoilenko Yuri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-04 00:00:00.000000000 Z
+date: 2024-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: get_process_mem
@@ -131,6 +131,7 @@ files:
 - lib/worker_killer/killer.rb
 - lib/worker_killer/killer/delayed_job.rb
 - lib/worker_killer/killer/passenger.rb
+- lib/worker_killer/killer/puma.rb
 - lib/worker_killer/killer/signal.rb
 - lib/worker_killer/memory_limiter.rb
 - lib/worker_killer/middleware.rb
@@ -140,6 +141,7 @@ files:
 - spec/delayed_job_plugin/oom_limiter_spec.rb
 - spec/killer/delayed_job_spec.rb
 - spec/killer/passenger_spec.rb
+- spec/killer/puma_spec.rb
 - spec/killer/signal_spec.rb
 - spec/killer_spec.rb
 - spec/memory_limiter_spec.rb
@@ -172,6 +174,7 @@ specification_version: 4
 summary: Kill any workers by memory and request counts or take custom reaction
 test_files:
 - spec/killer/signal_spec.rb
+- spec/killer/puma_spec.rb
 - spec/killer/delayed_job_spec.rb
 - spec/killer/passenger_spec.rb
 - spec/killer_spec.rb