sidekiq-worker-killer 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8573256c162630662fbb9be660375da63c3c8cbe3fb11d9851e36b1c0456eff
-  data.tar.gz: 63a6bea822d499f22f283f704f80e0954ac006ed442f6cb7632fa204602051f3
+  metadata.gz: 1335f7577f6a507808c59651cc9f479a49a9d54e144906b39b06355af0fcfcba
+  data.tar.gz: f61243439575d5ec2f75e0e7e803ff6588279b349a4ab9ebabc62e58fb3fcb7e
 SHA512:
-  metadata.gz: c1fe7ab3d39860cbd742af569a3e5b3a37173bbdffa751ebc76aae1cbf67d09a5745991e8ad9c5b50671705b110abeab3ee4124e69c3ebbccc658579409cbd6d
-  data.tar.gz: f65acd7d78a86152a2d04cd5c4ef0046885366540c362fe0a8c61caa4f1d04d4263f338bd9769c00ea09530151b9a8da48f34cf71377ecfec6517c4c36075d80
+  metadata.gz: 97742129013c4374090ed58f35d9b407f6dc2b9ff44a23d4de187b7d3035c11961ebb089b0753bf7b1688d386d77b2aef7cceba4344dd614a2dd3181fc28a0c2
+  data.tar.gz: cbf8b55a9bbf3171f988c0eabb4a137bbe3e458f9aa8368cb2c1cbe3759a14ce4b6dd919b9568458e48ac473c7780f01ad72be437503ee8e3695e1b67613f59d

data/README.md

@@ -52,6 +52,7 @@ The following options can be overridden.
 | kill_signal | SIGKILL | Signal to use to kill Sidekiq process if it doesn't stop. |
 | gc | true | Try to run garbage collection before Sidekiq process stops in case of exceeded max_rss. |
 | skip_shutdown_if | proc {false} | Executes a block of code after max_rss exceeds but before requesting shutdown. |
+| on_shutdown | nil | Executes a block of code before just before requesting shutdown. This can be used to send custom logs or metrics to external services. |
 
 *skip_shutdown_if* is expected to return anything other than `false` or `nil` to skip shutdown.
 

data/lib/sidekiq/worker_killer/version.rb

@@ -1,7 +1,7 @@
 # rubocop:disable Style/ClassAndModuleChildren
 module Sidekiq
   class WorkerKiller
-    VERSION = "1.0.1".freeze
+    VERSION = "1.1.0".freeze
   end
 end
 # rubocop:enable Style/ClassAndModuleChildren

data/lib/sidekiq/worker_killer.rb

@@ -36,6 +36,9 @@ class Sidekiq::WorkerKiller
   # @option options [Proc] skip_shutdown_if
   #   Executes a block of code after max_rss exceeds but before requesting
   #   shutdown. (default: `proc {false}`)
+  # @option options [Proc] on_shutdown
+  #   Executes a block of code right before a shutdown happens.
+  #   (default: `nil`)
   def initialize(options = {})
     @max_rss         = options.fetch(:max_rss, 0)
     @grace_time      = options.fetch(:grace_time, 15 * 60)
@@ -43,6 +46,7 @@ class Sidekiq::WorkerKiller
     @kill_signal     = options.fetch(:kill_signal, "SIGKILL")
     @gc              = options.fetch(:gc, true)
     @skip_shutdown   = options.fetch(:skip_shutdown_if, proc { false })
+    @on_shutdown     = options.fetch(:on_shutdown, nil)
   end
 
   # @param [String, Class] worker_class
@@ -68,17 +72,23 @@ class Sidekiq::WorkerKiller
 
     warn "current RSS #{current_rss} of #{identity} exceeds " \
          "maximum RSS #{@max_rss}"
+
+    run_shutdown_hook(worker, job, queue)
     request_shutdown
   end
 
   private
 
+  def run_shutdown_hook(worker, job, queue)
+    @on_shutdown.respond_to?(:call) && @on_shutdown.call(worker, job, queue)
+  end
+
   def skip_shutdown?(worker, job, queue)
     @skip_shutdown.respond_to?(:call) && @skip_shutdown.call(worker, job, queue)
   end
 
   def request_shutdown
-    # In another thread to allow undelying job to finish
+    # In another thread to allow underlying job to finish
     Thread.new do
       # Only if another thread is not already
       # shutting down the Sidekiq process

data/spec/sidekiq/worker_killer_spec.rb

@@ -129,6 +129,28 @@ describe Sidekiq::WorkerKiller do
           end
         end
 
+        context "and on_shutdown is given" do
+          subject{ described_class.new(max_rss: 2, on_shutdown: on_shutdown_proc) }
+
+          context "and on_shutdown is a proc" do
+            let(:on_shutdown_proc) { proc { |worker, job, queue| nil } }
+            it "should execute on_shutdown hook" do
+              expect(subject).to receive(:request_shutdown).once
+              expect(on_shutdown_proc).to receive(:call).once
+              subject.call(worker, job, queue){}
+            end
+          end
+
+          context "and on_shutdown is a lambda" do
+            let(:on_shutdown_proc) { ->(worker, job, queue) { nil } }
+            it "should execute on_shutdown hook" do
+              expect(subject).to receive(:request_shutdown).once
+              expect(on_shutdown_proc).to receive(:call).once
+              subject.call(worker, job, queue){}
+            end
+          end
+        end
+
         context "when gc is false" do
           subject{ described_class.new(max_rss: 2, gc: false) }
           it "should not call garbage collect" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-worker-killer
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Cyrille Courtiere
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-02 00:00:00.000000000 Z
+date: 2023-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: get_process_mem
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - dev@klaxit.com
 executables: []
@@ -95,7 +95,7 @@ files:
 homepage: http://github.com/klaxit/sidekiq-worker-killer
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -110,8 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Sidekiq worker killer
 test_files: