sidekiq_alive 2.0.5 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6d5a90f1ac023c49440e1e24d53e05bd3fe1f5362822e125a8989981e51846e
-  data.tar.gz: dd90cc1b6d7b1fc6273426e32f950d68a71eaa7d63b42b32d914450f35eec09a
+  metadata.gz: c6a2151aa5146a6a40096e4513702809296876a902a7def0d24d59bad6f110da
+  data.tar.gz: b99cd52eb4e5b694b6ca23d9b141d59b1ce362f914b74c63ea42b741dd4d7206
 SHA512:
-  metadata.gz: 533ef08f31e90ac4743577c561f3994c2b2e7eb9945cadcc4dc70dda3e2b339d8d8e6ab2d270b82a65dc884812b8d30ce1de49e50648af1a4136eafa77ee9dd3
-  data.tar.gz: 702c96b61ecaa7595b44ff9bd3dcfa29d58e99623a5fcd5534b94221dd92e96b06e0e81f217c826f7d8ee9e75bee55ef063d93ff855381efa5ead8af96a01cc4
+  metadata.gz: e82159d26a9e62445880b525619c11e6fe18d3f18378c72147de816d302efd7b3911aad3ff53c30fdd66982fa58ea4be7ff32ab3abd98c9f83f43127442c2db1
+  data.tar.gz: d5911f55bbd93e93baee10a8f28466eab44ca21980b7922ab05cb697d0d5fc2bdc4a09a70336d6f4f61614ba85a148b1c576eeba3f455078f4a935cec649f1f8

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sidekiq_alive (2.0.5)
+    sidekiq_alive (2.0.6)
       sidekiq
 
 GEM
@@ -15,12 +15,12 @@ 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)
       rack (>= 1.0, < 3)
-    rake (10.5.0)
+    rake (13.0.3)
     redis (4.1.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -52,10 +52,10 @@ DEPENDENCIES
   mock_redis
   pry
   rack-test
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rspec-sidekiq (~> 3.0)
   sidekiq_alive!
 
 BUNDLED WITH
-   1.17.3
+   2.2.22

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/docker-compose.yml

@@ -0,0 +1,6 @@
+version: '3.6'
+services:
+  redis:
+    image: redis
+    ports:
+      - 6379:6379

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/server.rb

@@ -10,7 +10,7 @@ module SidekiqAlive
 
         Signal.trap('TERM') { handler.shutdown }
 
-        handler.run(self, Port: port, Host: host)
+        handler.run(self, Port: port, Host: '0.0.0.0', AccessLog: [])
       end
 
       def host

data/lib/sidekiq_alive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqAlive
-  VERSION = '2.0.5'
+  VERSION = '2.1.0'
 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
 

data/sidekiq_alive.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'mock_redis'
   spec.add_development_dependency 'rack-test'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-sidekiq', '~> 3.0'
   spec.add_dependency 'sidekiq'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_alive
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.1.0
 platform: ruby
 authors:
 - Artur Pañach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -127,6 +127,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".tool-versions"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -136,6 +137,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - lib/sidekiq_alive.rb
 - lib/sidekiq_alive/config.rb
 - lib/sidekiq_alive/server.rb
@@ -161,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Liveness probe for sidekiq on Kubernetes deployments.