sidekiq_alive 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7b89d09d3a01cd0774ea9a4955a407f3fa397a5799e9d01d65c71e7e448bdca
-  data.tar.gz: 5241eee33524f7115bc9345aec7803e54c5035cb5071dfd92ac1479bcc40fd7d
+  metadata.gz: 364bf320e50acf4acacc6b092ddc878e094762a048f03b8496b03dca50c79c67
+  data.tar.gz: a19db126856fbb3629994f2d0aec3fd839462c204a62abe03e0833f140fb16f5
 SHA512:
-  metadata.gz: 5bef84e7c6f9ab1f28c3512f2628918676f7df835d1c389defb4e50ad47eca6e13cf82a2b6453cc4b9776ecf7e37a4d84d845b3af510222045e115e0316cae9a
-  data.tar.gz: ee57bf4f7d780d5b8b45b7775989a30af47d77a2faa0db1877280a69ea374471d0143a5ab4edb004f08e28e12a8c9cc8c59e7a4fa9e972a8162b1ab82f8fa1d7
+  metadata.gz: c23f150276af1a182dc6dd7eef752125f12c65de9479ca9877294e0344dd02c9b49cd4174ebbb593996ab8937d538ef5a9b446eed19d5667b6462335d97e5e3a
+  data.tar.gz: 251ddc155702aa38adcd7368f5dd7e55c9fc40558a2e90fcd05d8641e78faa40337060deef492c23e602884250c6e66dfed1a77c46e058149658975e1e858543

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sidekiq_alive (1.2.0)
+    sidekiq_alive (2.0.0)
       sidekiq
       sinatra
 

data/README.md

@@ -18,6 +18,23 @@ This worker is responsible to requeue itself for the next liveness probe.
 
 Each instance in kubernetes will be checked based on `ENV` variable `HOSTNAME` (kubernetes sets this for each replica/pod).
 
+On initialization SidekiqAlive will asign to Sidekiq::Worker a queue with the current host and add this queue to the current instance queues to process.
+
+example:
+
+```
+hostname: foo
+  Worker queue: sidekiq_alive-foo
+  instance queues:
+   - sidekiq_alive-foo
+   *- your queues
+
+hostname: bar
+  Worker queue: sidekiq_alive-bar
+  instance queues:
+   - sidekiq_alive-bar
+   *- your queues
+```
 
 ## Installation
 
@@ -35,29 +52,21 @@ Or install it yourself as:
 
     $ gem install sidekiq_alive
 
-Run `Sidekiq` with a `sidekiq_alive` queue.
-
-```
-sidekiq -q sidekiq_alive
-```
-
-or in your config:
 
-_sidekiq.yml_
-```yaml
-queues:
- - default
- - sidekiq_alive
-```
+## Usage
 
-__IMPORTANT:__
+SidekiqAlive will start when running `sidekiq` command.
 
-Make sure you run a `quiet` every time before you stop the pods [(issue)](https://github.com/arturictus/sidekiq_alive/issues/10). That's not only important for SidekiqAlive it's important that your workers finish before you stop Sidekiq.
-Check [recommended kubernetes setup](#kubernetes-setup)
+Run `Sidekiq`
 
-## Usage
+```
+bundle exec sidekiq
+```
 
-SidekiqAlive will start when running `sidekiq` command.
+```
+curl localhost:7433
+#=> Alive!                                   
+```
 
 
 __how to disable?__
@@ -156,28 +165,14 @@ SidekiqAlive.setup do |config|
   #    require 'net/http'
   #    config.callback = proc { Net::HTTP.get("https://status.com/ping") }
 
-  # ==> Preferred Queue
-  # Sidekiq Alive will try to enqueue the workers to this queue. If not found
-  # will do it to the first available queue.
-  # It's a good practice to add a dedicated queue for sidekiq alive. If the queue
-  # where sidekiq is processing SidekiqALive gets overloaded and takes
-  # longer than the `ttl` to process SidekiqAlive::Worker will make the liveness probe
-  # to fail. Sidekiq overloaded and restarting every `ttl` cicle.
-  # Add the sidekiq alive queue!!
+  # ==> Queue Prefix
+  # SidekiqAlive will run in a independent queue for each instance/replica
+  # This queue name will be generated with: "#{queue_prefix}-#{hostname}.
+  # You can customize the prefix here. 
   # 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
+  #    config.queue_prefix = :other
+
 end
 ```
 

data/lib/sidekiq_alive.rb

@@ -6,10 +6,12 @@ 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])
+    SidekiqAlive::Worker.sidekiq_options queue: current_queue
+    Sidekiq.configure_server do |sq_config|
 
-      config.on(:startup) do
+      sq_config.options[:queues] << current_queue
+
+      sq_config.on(:startup) do
         SidekiqAlive.tap do |sa|
           sa.logger.info(banner)
           sa.register_current_instance
@@ -22,10 +24,10 @@ module SidekiqAlive
         end
       end
 
-      config.on(:quiet) do
+      sq_config.on(:quiet) do
         SidekiqAlive.unregister_current_instance
       end
-      config.on(:shutdown) do
+      sq_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
@@ -33,12 +35,8 @@ module SidekiqAlive
     end
   end
 
-  def self.select_queue(queues)
-    @queue = if queues.find { |e| e.to_sym == config.preferred_queue.to_sym }
-               config.preferred_queue.to_sym
-             else
-               queues.first
-             end
+  def self.current_queue
+    "#{config.queue_prefix}-#{hostname}"
   end
 
   def self.register_current_instance
@@ -57,10 +55,15 @@ module SidekiqAlive
   end
 
   def self.purge_pending_jobs
+    # TODO:
+    # Sidekiq 6 allows better way to find scheduled jobs:
+    # https://github.com/mperham/sidekiq/wiki/API#scan
     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 = scheduled_set.select { |job| job.klass == 'SidekiqAlive::Worker' && job.queue == current_queue }
+    logger.info("[SidekiqAlive] Purging #{jobs.count} pending for #{hostname}")
     jobs.each(&:delete)
+    logger.info("[SidekiqAlive] Removing queue #{current_queue}")
+    Sidekiq::Queue.new(current_queue).clear
   end
 
   def self.current_instance_register_key

data/lib/sidekiq_alive/config.rb

@@ -7,8 +7,7 @@ module SidekiqAlive
                   :time_to_live,
                   :callback,
                   :registered_instance_key,
-                  :preferred_queue,
-                  :delay_between_async_other_host_queue
+                  :queue_prefix
 
     def initialize
       set_defaults
@@ -20,8 +19,7 @@ module SidekiqAlive
       @time_to_live = 10 * 60
       @callback = proc {}
       @registered_instance_key = 'SIDEKIQ_REGISTERED_INSTANCE'
-      @preferred_queue = :sidekiq_alive
-      @delay_between_async_other_host_queue = 1
+      @queue_prefix = :sidekiq_alive
     end
 
     def registration_ttl

data/lib/sidekiq_alive/version.rb

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

data/lib/sidekiq_alive/worker.rb

@@ -4,19 +4,9 @@ module SidekiqAlive
     sidekiq_options retry: false
 
     def perform(hostname = SidekiqAlive.hostname)
-      return unless hostname_registered?(hostname)
-      if current_hostname == hostname
-        write_living_probe
-        # schedule next living probe
-        self.class.perform_in(config.time_to_live / 2, current_hostname)
-      else
-        # requeue for hostname to validate it's own liveness probe
-        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
+      write_living_probe
+      # schedule next living probe
+      self.class.perform_in(config.time_to_live / 2, current_hostname)
     end
 
     def hostname_registered?(hostname)
@@ -31,7 +21,7 @@ module SidekiqAlive
       # Increment ttl for current registered instance
       SidekiqAlive.register_current_instance
       # after callbacks
-      config.callback.call()
+      config.callback.call() rescue nil
     end
 
     def current_hostname

metadata

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