sidekiq_alive 2.0.5 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6d5a90f1ac023c49440e1e24d53e05bd3fe1f5362822e125a8989981e51846e
-  data.tar.gz: dd90cc1b6d7b1fc6273426e32f950d68a71eaa7d63b42b32d914450f35eec09a
+  metadata.gz: cf72b576226b373f7e661aae05d54ec27fcb3e5f612036ab86bd89a18d23b289
+  data.tar.gz: f3148f40e24f04bf743b3f097a12045554109a2a8af965e7d84ef9344f7b4c23
 SHA512:
-  metadata.gz: 533ef08f31e90ac4743577c561f3994c2b2e7eb9945cadcc4dc70dda3e2b339d8d8e6ab2d270b82a65dc884812b8d30ce1de49e50648af1a4136eafa77ee9dd3
-  data.tar.gz: 702c96b61ecaa7595b44ff9bd3dcfa29d58e99623a5fcd5534b94221dd92e96b06e0e81f217c826f7d8ee9e75bee55ef063d93ff855381efa5ead8af96a01cc4
+  metadata.gz: 56b9231da7d95a74a0a0067ca06a91b921502af01b0da62975dfd4b89dcbc2a9694ce3bf6925dac2cc3f9ba1c5453e1627c4a44432a65f5b2fb17a66ee5ef8af
+  data.tar.gz: 9c116fef8bfbfe1db518408b38b2abc3701faf39e21273073e9ca86d295e0c827fa843153fd8e6d9be6d52740203261351292e6f19e3cb6da25b0f639c379d26

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sidekiq_alive (2.0.5)
+    sidekiq_alive (2.0.6)
       sidekiq
 
 GEM
@@ -15,7 +15,7 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rack (2.0.6)
+    rack (2.2.3)
     rack-protection (2.0.5)
       rack
     rack-test (1.1.0)

data/README.md

@@ -7,7 +7,7 @@
 SidekiqAlive offers a solution to add liveness probe for a Sidekiq instance deployed in Kubernetes.
 This library can be used to check sidekiq health outside kubernetes.
 
-__How?__
+**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.
 
@@ -52,7 +52,6 @@ Or install it yourself as:
 
     $ gem install sidekiq_alive
 
-
 ## Usage
 
 SidekiqAlive will start when running `sidekiq` command.
@@ -68,8 +67,7 @@ curl localhost:7433
 #=> Alive!
 ```
 
-
-__how to disable?__
+**how to disable?**
 You can disabled by setting `ENV` variable `DISABLE_SIDEKIQ_ALIVE`
 example:
 
@@ -115,7 +113,7 @@ spec:
         preStop:
           exec:
             # SIGTERM triggers a quick exit; gracefully terminate instead
-            command: ["bundle", "exec", "sidekiqctl", "quiet"]
+            command: ['bundle', 'exec', 'sidekiqctl', 'quiet']
   terminationGracePeriodSeconds: 60 # put your longest Job time here plus security time.
 ```
 
@@ -172,7 +170,7 @@ spec:
         preStop:
           exec:
             # SIGTERM triggers a quick exit; gracefully terminate instead
-            command: ["kube/sidekiq_quiet"]
+            command: ['kube/sidekiq_quiet']
   terminationGracePeriodSeconds: 60 # put your longest Job time here plus security time.
 ```
 
@@ -217,6 +215,13 @@ SidekiqAlive.setup do |config|
   #
   #   config.path = '/'
 
+  # ==> Custom Liveness Probe
+  # Extra check to decide if restart the pod or not for example connection to DB.
+  # `false`, `nil` or `raise` will not write the liveness probe
+  # default: proc { true }
+  #
+  #     config.custom_liveness_probe = proc { db_running? }
+
   # ==> Liveness key
   # Key to be stored in Redis as probe of liveness
   # default: "SIDEKIQ::LIVENESS_PROBE_TIMESTAMP"

data/lib/sidekiq_alive/config.rb

@@ -12,7 +12,8 @@ module SidekiqAlive
                   :callback,
                   :registered_instance_key,
                   :queue_prefix,
-                  :server
+                  :server,
+                  :custom_liveness_probe
 
     def initialize
       set_defaults
@@ -28,6 +29,7 @@ module SidekiqAlive
       @registered_instance_key = 'SIDEKIQ_REGISTERED_INSTANCE'
       @queue_prefix = :sidekiq_alive
       @server = ENV['SIDEKIQ_ALIVE_SERVER'] || 'webrick'
+      @custom_liveness_probe = proc { true }
     end
 
     def registration_ttl

data/lib/sidekiq_alive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqAlive
-  VERSION = '2.0.5'
+  VERSION = '2.0.6'
 end

data/lib/sidekiq_alive/worker.rb

@@ -1,11 +1,17 @@
+# frozen_string_literal: true
+
 module SidekiqAlive
   class Worker
     include Sidekiq::Worker
     sidekiq_options retry: false
 
     def perform(_hostname = SidekiqAlive.hostname)
+      # Checks if custom liveness probe passes should fail or return false
+      return unless config.custom_liveness_probe.call
+
+      # Writes the liveness in Redis
       write_living_probe
-      # schedule next living probe
+      # schedules next living probe
       self.class.perform_in(config.time_to_live / 2, current_hostname)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_alive
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.6
 platform: ruby
 authors:
 - Artur Pañach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler