sidekiq-process_manager 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d03e818fac3487ed18d2763f536b2e97fa526b8d7dd066b1a066407727ff0dba
-  data.tar.gz: 1e3e1837c3367a22ced37e111ad6e7d1e9988bcdd7baaf1d07b0b3083857650e
+  metadata.gz: dc25ffae388e5ca7ad73f0976d00cf09ec84124b2284a000af1dc0970cf87c20
+  data.tar.gz: 94637ae3cfa8a6fa991e95ee434c8410936c62263695f36b6db8c2b664d1f439
 SHA512:
-  metadata.gz: feae2e03df3bc77c6590a1da6bcb5079761184a6e5d37f05c81451b7f52783c8b496dbbdfa71b793a8adfe7eaf8bde293e185ec1ecc1b0a90a802cab772a30dc
-  data.tar.gz: 988f0f484e747142c8b725e80717bc0edefee68d9600595352f27a2c343535bc2c6e56ecde5c10dccf56c775b1210f9e50f3a542ed2095fd2e0041fedbfcff93
+  metadata.gz: 32bba980929441cb06022c829f73e7a7d8ee41de0dba07c98f44cb1f2c339dab87ec21dae8b1847ae2967e5771fb6506dd09a42a9540d784df4defd9f820f664
+  data.tar.gz: e1dc4e4e0e502b0747932b5b12011acfcb04535baeaae835027c50e1ec3ae1ff6ea7c0f6317469a8c4e11f8d9d9bfe40c530064ad4da5b4354231af1182776c6

data/CHANGELOG.md

@@ -4,7 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.1.0] - Unreleased
+## 1.1.2
+
+### Added
+- Added thread to monitor child processes to make sure they exit after a SIGTERM signal has been sent. If a process does not exit after the configured Sidekiq timeout time, then it will be killed with a SIGKILL signal.
+
+### Changed
+- A SIGINT sent to the manager process will sent SIGTERM to the child processes to give them a chance to shutdown gracefully.
+
+## 1.1.1
+
+### Added
+- Guards to ensure signal processing thread doesn't die.
+
+## 1.1.0
 
 ### Added
 - Sidekiq 7 support.
@@ -15,17 +28,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Sidekiq < 5.0 support.
 - Ruby < 2.5 support.
 
-## [1.0.4] - 2021-05-20
+## 1.0.4
 
 ### Fixed
 - Set $0 to "sidekiq" in preforked process so instrumentation libraries detecting sidekiq server from the command line will work.
 
-## [1.0.3] - 2021-05-19
+## 1.0.3
 
 ### Fixed
 - Restore bin dir to gem distribution.
 
-## [1.0.2] - 2021-05-19
+## 1.0.2
 
 ### Added
 - Support for sidekiq >= 6.1.
@@ -34,12 +47,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Minimum Ruby version 2.3.
 
-## [1.0.1] - 2020-02-20
+## 1.0.1
 
 ### Changed
 - Remove auto require of `sidekiq/cli` so `require: false` does not need to be specified in a Gemfile.
 
-## [1.0.0] - 2019-11-27
+## 1.0.0
 
 ### Added
 - Initial release.

data/README.md

@@ -8,7 +8,7 @@ This gem provides a command line script for managing [sidekiq](https://github.co
 
 The sidekiq processes can all be managed by sending signals to the manager process. This process simply forwards the signals on to the child processes, allowing you to control the sidekiq processes as you normally would.
 
-If one of the sidekiq processes dies unexpectedly, the process manager automatically starts a new sidekiq process to replace it.
+If one of the sidekiq processes exits unexpectedly, the process manager automatically starts a new sidekiq process to replace it.
 
 ## Pre-Forking
 
@@ -44,7 +44,7 @@ For a Rails application, you would normally want to preboot the `config/boot.rb`
 
 ## Memory Bloat
 
-You can also specify a maximum memory footprint that you want to allow for each child process. You can use this feature to automatically guard against poorly designed workers that bloat the Ruby memory heap. Note that you can also use an external process monitor to kill processes with memory bloat; the process manager will restart any process regardless of how it dies.
+You can also specify a maximum memory footprint that you want to allow for each child process. You can use this feature to automatically guard against poorly designed workers that bloat the Ruby memory heap. Note that you can also use an external process monitor to kill processes with memory bloat; the process manager will restart any process regardless of how it exits.
 
 ## Usage
 

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.2

data/lib/sidekiq/process_manager/manager.rb

@@ -64,28 +64,37 @@ module Sidekiq
 
         @signal_pipe_read, @signal_pipe_write = IO.pipe
 
+        @signal_thread = Thread.new do
+          Thread.current.name = "signal-handler"
+
+          while @signal_pipe_read.wait_readable
+            begin
+              signal = @signal_pipe_read.gets.strip
+              send_signal_to_children(signal.to_sym)
+            rescue => e
+              log_warning("Error sending signal #{signal} to child processes: #{e.message}")
+            end
+          end
+        end
+
         # Trap signals that will be forwarded to child processes
         [:INT, :TERM, :USR1, :USR2, :TSTP, :TTIN].each do |signal|
           ::Signal.trap(signal) do
             if ::Process.pid == master_pid
+              signal = :TERM if signal == :INT
               @signal_pipe_write.puts(signal)
             end
           end
         end
 
-        @signal_thread = Thread.new do
-          Thread.current.name = "signal-handler"
-
-          while @signal_pipe_read.wait_readable
-            signal = @signal_pipe_read.gets.strip
-            send_signal_to_children(signal.to_sym)
-          end
-        end
-
         # Ensure that child processes receive the term signal when the master process exits.
         at_exit do
-          if ::Process.pid == master_pid && @process_count > 0
-            send_signal_to_children(:TERM)
+          if ::Process.pid == master_pid
+            if @process_count > 0
+              send_signal_to_children(:TERM)
+            end
+            wait_for_children_to_exit
+            log_info("Process manager exiting")
           end
         end
 
@@ -100,9 +109,8 @@ module Sidekiq
 
         start_memory_monitor if @max_memory
 
-        log_info("Process manager started with pid #{::Process.pid}")
+        log_info("Process manager started")
         monitor_child_processes
-        log_info("Process manager #{::Process.pid} exiting")
       end
 
       # Helper to wait on the manager to wait on child processes to start up.
@@ -143,15 +151,6 @@ module Sidekiq
         @started
       end
 
-      # Kill a child process by sending the TERM signal to it.
-      #
-      # @param pid [Integer] The pid of the child process to kill.
-      # @return [void]
-      # @api private
-      def kill(pid)
-        ::Process.kill(:TERM, pid)
-      end
-
       private
 
       def log_info(message)
@@ -242,14 +241,24 @@ module Sidekiq
         log_info("Process manager trapped signal #{signal}")
         @process_count = 0 if signal == :INT || signal == :TERM
         pids.each do |pid|
-          begin
-            log_info("Sending signal #{signal} to sidekiq process #{pid}")
-            ::Process.kill(signal, pid)
-          rescue => e
-            log_warning("Error sending signal #{signal} to sidekiq process #{pid}: #{e.inspect}")
+          send_signal_to_pid(signal, pid)
+        end
+      end
+
+      def send_signal_to_pid(signal, pid)
+        signal = signal.to_sym
+        begin
+          log_info("Sending signal #{signal} to sidekiq process #{pid}")
+          ::Process.kill(signal, pid)
+          if [:TERM, :INT].include?(signal)
+            Thread.new do
+              Thread.current.name = "pid-#{pid}-killer"
+              ensure_pid_dies(pid)
+            end
           end
+        rescue Errno::ESRCH
+          # The process is already dead
         end
-        wait_for_children_to_exit(pids) if @process_count == 0
       end
 
       def start_memory_monitor
@@ -264,8 +273,8 @@ module Sidekiq
               begin
                 memory = GetProcessMem.new(pid)
                 if memory.bytes > @max_memory
-                  log_warning("Kill bloated sidekiq process #{pid}: #{memory.mb.round}mb used")
-                  kill(pid)
+                  log_warning("Killing bloated sidekiq process #{pid}: #{memory.mb.round}mb used")
+                  send_signal_to_pid(:TERM, pid)
                   break
                 end
               rescue => e
@@ -282,18 +291,13 @@ module Sidekiq
         end
       end
 
-      def wait_for_children_to_exit(pids)
-        timeout = monotonic_time + (sidekiq_options[:timeout] || 25).to_f
+      def wait_for_children_to_exit
         pids.each do |pid|
-          while monotonic_time < timeout
-            break unless process_alive?(pid)
+          while process_alive?(pid)
             sleep(0.01)
           end
         end
-
-        pids.each do |pid|
-          ::Process.kill(:INT, pid) if process_alive?(pid)
-        end
+        log_info("All sidekiq processes have exited")
       end
 
       def process_alive?(pid)
@@ -305,6 +309,24 @@ module Sidekiq
         end
       end
 
+      def ensure_pid_dies(pid)
+        # Wait for the process to die, or kill it after a timeout.
+        timeout = (sidekiq_options[:timeout] || 25).to_f
+        end_time = monotonic_time + timeout
+        while monotonic_time < end_time && process_alive?(pid)
+          sleep(0.1)
+        end
+
+        if process_alive?(pid)
+          begin
+            ::Process.kill(:KILL, pid)
+            log_warning("Sidekiq process #{pid} failed to exit after #{timeout} seconds; killed with SIGKILL")
+          rescue Errno::ESRCH
+            # The process is already dead
+          end
+        end
+      end
+
       # Listen for child processes dying and restart if necessary.
       def monitor_child_processes
         loop do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-process_manager
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-19 00:00:00.000000000 Z
+date: 2023-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq