sidekiq_alive 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 353fe633b29953f77cd04c9c7f3fe956c2c258c925de88c98f9ef8bf7338c4fd
-  data.tar.gz: 2f2e3845a01d3b546cd9dc16829bf7ba196ad53edbd71d6b7a01f7e940f6fb34
+  metadata.gz: e7b89d09d3a01cd0774ea9a4955a407f3fa397a5799e9d01d65c71e7e448bdca
+  data.tar.gz: 5241eee33524f7115bc9345aec7803e54c5035cb5071dfd92ac1479bcc40fd7d
 SHA512:
-  metadata.gz: 67ae1f11a7b5f436552c80ef9a389c80b3945444b8ffd04f9ab1c732d8d78ea26ad54fef7e2365ad89f73db33a441429f4a38c57eebad16ba4e3d22c7c7754bb
-  data.tar.gz: 578c4786ec814f79d6a2acb623a66ad6a732e7365397e573d1b582f051e7b9968971accc824481c0dc6d50e6de89281bdc83650c92e4db5d9d551e4cf2084d64
+  metadata.gz: 5bef84e7c6f9ab1f28c3512f2628918676f7df835d1c389defb4e50ad47eca6e13cf82a2b6453cc4b9776ecf7e37a4d84d845b3af510222045e115e0316cae9a
+  data.tar.gz: ee57bf4f7d780d5b8b45b7775989a30af47d77a2faa0db1877280a69ea374471d0143a5ab4edb004f08e28e12a8c9cc8c59e7a4fa9e972a8162b1ab82f8fa1d7

data/.travis.yml

@@ -5,9 +5,13 @@ cache: bundler
 rvm:
   - 2.3.7
   - 2.4.4
-  - 2.5.1
+  - 2.5.5
+  - 2.6.2
   - ruby-head
-before_install: gem install bundler -v 1.16.1
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+before_install: gem install bundler -v 1.17.3
 env:
   global:
     - CC_TEST_REPORTER_ID=571b470a2b61f8a58b2a0ebbcf297805efa07c548e45bac9d1c9ce0c5edcfc20

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sidekiq_alive (1.1.1)
+    sidekiq_alive (1.2.0)
       sidekiq
       sinatra
 
@@ -9,46 +9,47 @@ GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.2)
-    concurrent-ruby (1.0.5)
-    connection_pool (2.2.1)
+    connection_pool (2.2.2)
     diff-lcs (1.3)
-    method_source (0.9.0)
-    mock_redis (0.18.0)
-    pry (0.11.3)
+    method_source (0.9.2)
+    mock_redis (0.19.0)
+    mustermann (1.0.3)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rack (1.6.8)
-    rack-protection (1.5.3)
+    rack (2.0.6)
+    rack-protection (2.0.5)
       rack
-    rack-test (1.0.0)
+    rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rake (10.5.0)
-    redis (3.3.5)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    redis (4.1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
+      rspec-support (~> 3.8.0)
     rspec-sidekiq (3.0.3)
       rspec-core (~> 3.0, >= 3.0.0)
       sidekiq (>= 2.4.0)
-    rspec-support (3.7.1)
-    sidekiq (4.2.10)
-      concurrent-ruby (~> 1.0)
-      connection_pool (~> 2.2, >= 2.2.0)
+    rspec-support (3.8.0)
+    sidekiq (5.2.5)
+      connection_pool (~> 2.2, >= 2.2.2)
+      rack (>= 1.5.0)
       rack-protection (>= 1.5.0)
-      redis (~> 3.2, >= 3.2.1)
-    sinatra (1.4.8)
-      rack (~> 1.5)
-      rack-protection (~> 1.4)
-      tilt (>= 1.3, < 3)
+      redis (>= 3.3.5, < 5)
+    sinatra (2.0.5)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.5)
+      tilt (~> 2.0)
     tilt (2.0.9)
 
 PLATFORMS
@@ -65,4 +66,4 @@ DEPENDENCIES
   sidekiq_alive!
 
 BUNDLED WITH
-   1.17.1
+   1.17.3

data/README.md

@@ -167,6 +167,17 @@ SidekiqAlive.setup do |config|
   # default: :sidekiq_alive
   #
   #    config.preferred_queue = :other
+
+  # ==> delay_between_async_other_host_queue
+  # When instance receives a job from another instance it requeues itself again 
+  # until the owner instance process it. This was causing a lot of read/writes in big deployments 
+  # with a lot of replicas.
+  # Delaying the requeue proves to be less read/write intensive
+  # default: 1
+  #
+  #    config.delay_between_async_other_host_queue = 0.5
+  #    #or 
+  #    config.delay_between_async_other_host_queue = false
 end
 ```
 

data/lib/sidekiq_alive.rb

@@ -1,12 +1,12 @@
-require "sidekiq"
-require "singleton"
-require "sidekiq_alive/version"
-require "sidekiq_alive/config"
+require 'sidekiq'
+require 'sidekiq/api'
+require 'singleton'
+require 'sidekiq_alive/version'
+require 'sidekiq_alive/config'
 
 module SidekiqAlive
   def self.start
     Sidekiq.configure_server do |config|
-
       SidekiqAlive::Worker.sidekiq_options queue: SidekiqAlive.select_queue(config.options[:queues])
 
       config.on(:startup) do
@@ -15,7 +15,9 @@ module SidekiqAlive
           sa.register_current_instance
           sa.store_alive_key
           sa::Worker.perform_async(hostname)
-          sa::Server.start
+          @server_pid = fork do
+            sa::Server.run!
+          end
           sa.logger.info(successful_startup_text)
         end
       end
@@ -24,10 +26,11 @@ module SidekiqAlive
         SidekiqAlive.unregister_current_instance
       end
       config.on(:shutdown) do
+        Process.kill('TERM', @server_pid) unless @server_pid.nil?
+        Process.wait(@server_pid) unless @server_pid.nil?
         SidekiqAlive.unregister_current_instance
       end
     end
-
   end
 
   def self.select_queue(queues)
@@ -43,6 +46,9 @@ module SidekiqAlive
   end
 
   def self.unregister_current_instance
+    # Delete any pending jobs for this instance
+    logger.info(shutdown_info)
+    purge_pending_jobs
     redis.del(current_instance_register_key)
   end
 
@@ -50,6 +56,13 @@ module SidekiqAlive
     redis.keys("#{config.registered_instance_key}::*")
   end
 
+  def self.purge_pending_jobs
+    scheduled_set = Sidekiq::ScheduledSet.new
+    jobs = scheduled_set.select { |job| job.klass == 'SidekiqAlive::Worker' && job.args[0] == hostname }
+    logger.info("Purging #{jobs.count} pending for #{hostname}")
+    jobs.each(&:delete)
+  end
+
   def self.current_instance_register_key
     "#{config.registered_instance_key}::#{hostname}"
   end
@@ -57,7 +70,7 @@ module SidekiqAlive
   def self.store_alive_key
     redis.set(current_lifeness_key,
               Time.now.to_i,
-              { ex: config.time_to_live.to_i })
+              ex: config.time_to_live.to_i)
   end
 
   def self.redis
@@ -65,7 +78,7 @@ module SidekiqAlive
   end
 
   def self.alive?
-    redis.ttl(current_lifeness_key) == -2 ? false : true
+    redis.ttl(current_lifeness_key) != -2
   end
 
   # CONFIG ---------------------------------------
@@ -90,8 +103,20 @@ module SidekiqAlive
     ENV['HOSTNAME'] || 'HOSTNAME_NOT_SET'
   end
 
+  def self.shutdown_info
+    <<~BANNER
+
+    =================== Shutting down SidekiqAlive =================
+
+    Hostname: #{hostname}
+    Liveness key: #{current_lifeness_key}
+    Current instance register key: #{current_instance_register_key}
+
+    BANNER
+  end
+
   def self.banner
-    <<-BANNER.strip_heredoc
+    <<~BANNER
 
     =================== SidekiqAlive =================
 
@@ -108,7 +133,7 @@ module SidekiqAlive
   end
 
   def self.successful_startup_text
-    <<-BANNER.strip_heredoc
+    <<~BANNER
     Registered instances:
 
     - #{registered_instances.join("\n\s\s- ")}
@@ -120,11 +145,11 @@ module SidekiqAlive
   def self.register_instance(instance_name)
     redis.set(instance_name,
               Time.now.to_i,
-              { ex: config.time_to_live.to_i + 60 })
+              ex: config.registration_ttl.to_i)
   end
 end
 
-require "sidekiq_alive/worker"
-require "sidekiq_alive/server"
+require 'sidekiq_alive/worker'
+require 'sidekiq_alive/server'
 
 SidekiqAlive.start unless ENV['DISABLE_SIDEKIQ_ALIVE']

data/lib/sidekiq_alive/config.rb

@@ -7,7 +7,8 @@ module SidekiqAlive
                   :time_to_live,
                   :callback,
                   :registered_instance_key,
-                  :preferred_queue
+                  :preferred_queue,
+                  :delay_between_async_other_host_queue
 
     def initialize
       set_defaults
@@ -18,9 +19,13 @@ module SidekiqAlive
       @liveness_key = 'SIDEKIQ::LIVENESS_PROBE_TIMESTAMP'
       @time_to_live = 10 * 60
       @callback = proc {}
-      @registered_instance_key = "SIDEKIQ_REGISTERED_INSTANCE"
+      @registered_instance_key = 'SIDEKIQ_REGISTERED_INSTANCE'
       @preferred_queue = :sidekiq_alive
+      @delay_between_async_other_host_queue = 1
     end
 
+    def registration_ttl
+      @registration_ttl ? @registration_ttl : time_to_live + 60
+    end
   end
 end

data/lib/sidekiq_alive/server.rb

@@ -1,25 +1,13 @@
-require "sinatra/base"
-require_relative "./config"
+require 'sinatra/base'
 module SidekiqAlive
   class Server < Sinatra::Base
     set :bind, '0.0.0.0'
-
-    class << self
-      def start
-        set :port, SidekiqAlive.config.port
-        Thread.start { run! }
-      end
-
-      def quit!
-        super
-        exit
-      end
-    end
+    set :port, SidekiqAlive.config.port
 
     get '/' do
       if SidekiqAlive.alive?
         status 200
-        body "Alive!"
+        body 'Alive!'
       else
         response = "Can't find the alive key"
         SidekiqAlive.logger.error(response)

data/lib/sidekiq_alive/version.rb

@@ -1,3 +1,3 @@
 module SidekiqAlive
-  VERSION = "1.1.1"
+  VERSION = '1.2.0'.freeze
 end

data/lib/sidekiq_alive/worker.rb

@@ -11,7 +11,11 @@ module SidekiqAlive
         self.class.perform_in(config.time_to_live / 2, current_hostname)
       else
         # requeue for hostname to validate it's own liveness probe
-        self.class.perform_async(hostname)
+        if config.delay_between_async_other_host_queue
+          self.class.perform_in(config.delay_between_async_other_host_queue, hostname)
+        else
+          self.class.perform_async(hostname)
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_alive
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Artur Pañach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-20 00:00:00.000000000 Z
+date: 2019-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler