sidekiq_alive 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06606c5196a6ec3d6f8740b17dd23aa898bc3ba8bdc382a931b34092c3973d5b
-  data.tar.gz: a9ad27ca8677547016c95ce459b61e3eabe2fc5a60479a7cff599504c1015050
+  metadata.gz: 788fbb3fc817ea121b46363271bcd0f1b814688a92082febf0ccd7432195c03c
+  data.tar.gz: 6065782d4680efe3c35695b06ef5ca748ef55942c7c0548b8e77fc4a1b413bbb
 SHA512:
-  metadata.gz: 53342403bd87d484fc32b92d7019bd65aea5fdc6ab7e760c7dcaaae418846cc0d0c66aa6eb6a420546c2d18a14e15cbdfbfa605ddfd6ffa4c9e49141b0c21a8d
-  data.tar.gz: 906c0644472d5f1e1fa13c52a727b3753f0a7216b77eec73a5351989a3dc730fe767f226b8c17759b6b6b3b2a496a52c709eab36b235c25042283f2a285b458f
+  metadata.gz: c388b1aeffd3967a2c126d9f0a6c1b823ac7ff05eff2d5adbb7900342ffa493fd312cf872888da2753484a8d7b9b84461b44ca500c94412d6d6df5906b011207
+  data.tar.gz: c06b9d7cac1f92dfcadb02493190003034fdb3b2144ea7c9d2793b5d1773b07be50804c56ad401f46cd73f0c3af16879ef5e670223816282a25fececeaab695f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sidekiq_alive (1.0.0)
+    sidekiq_alive (1.1.0)
       sidekiq
       sinatra
 
@@ -49,7 +49,7 @@ GEM
       rack (~> 1.5)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
-    tilt (2.0.8)
+    tilt (2.0.9)
 
 PLATFORMS
   ruby
@@ -65,4 +65,4 @@ DEPENDENCIES
   sidekiq_alive!
 
 BUNDLED WITH
-   1.16.4
+   1.17.1

data/README.md

@@ -11,10 +11,10 @@ __How?__
 
 A http server is started and on each requests validates that a liveness key is stored in Redis. If it is there means is working.
 
-A Sidekiq job is the responsable to storing this key. If Sidekiq stops processing jobs
+A Sidekiq worker is the responsable to storing this key. If Sidekiq stops processing workers
 this key gets expired by Redis an consequently the http server will return a 500 error.
 
-This Job is responsible to requeue itself for the next liveness probe.
+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).
 
@@ -35,6 +35,26 @@ 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
+```
+
+__IMPORTANT:__
+
+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)
+
 ## Usage
 
 SidekiqAlive will start when running `sidekiq` command.
@@ -135,6 +155,18 @@ 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!!
+  # default: :sidekiq_alive
+  #
+  #    config.preferred_queue = :other
 end
 ```
 
@@ -144,6 +176,8 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
+Here is a example [rails app](https://github.com/arturictus/sidekiq_alive_example)
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/arturictus/sidekiq_alive. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/sidekiq_alive/config.rb

@@ -6,7 +6,8 @@ module SidekiqAlive
                   :liveness_key,
                   :time_to_live,
                   :callback,
-                  :registered_instance_key
+                  :registered_instance_key,
+                  :preferred_queue
 
     def initialize
       set_defaults
@@ -18,6 +19,7 @@ module SidekiqAlive
       @time_to_live = 10 * 60
       @callback = proc {}
       @registered_instance_key = "SIDEKIQ_REGISTERED_INSTANCE"
+      @preferred_queue = :sidekiq_alive
     end
 
   end

data/lib/sidekiq_alive/version.rb

@@ -1,3 +1,3 @@
 module SidekiqAlive
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/sidekiq_alive.rb

@@ -6,6 +6,9 @@ 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
         SidekiqAlive.tap do |sa|
           sa.logger.info(banner)
@@ -16,6 +19,7 @@ module SidekiqAlive
           sa.logger.info(successful_startup_text)
         end
       end
+
       config.on(:quiet) do
         SidekiqAlive.unregister_current_instance
       end
@@ -26,6 +30,14 @@ module SidekiqAlive
 
   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
+  end
+
   def self.register_current_instance
     register_instance(current_instance_register_key)
   end
@@ -88,6 +100,8 @@ module SidekiqAlive
     Port: #{config.port}
     Time to live: #{config.time_to_live}s
     Current instance register key: #{current_instance_register_key}
+    Worker running on queue: #{@queue}
+
 
     starting ...
     BANNER

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_alive
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Artur Pañach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-08 00:00:00.000000000 Z
+date: 2019-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler