sidekiq_alive 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88b19f6100070c1ec21dcb21c0ffeed162339684ca9151d5f1fc96bc0a08d4c7
-  data.tar.gz: 368c75147329255b31de98b83a3ccfa635ff7bb51624777875fc2c00751b0102
+  metadata.gz: c6a2151aa5146a6a40096e4513702809296876a902a7def0d24d59bad6f110da
+  data.tar.gz: b99cd52eb4e5b694b6ca23d9b141d59b1ce362f914b74c63ea42b741dd4d7206
 SHA512:
-  metadata.gz: b5aaf5daef764005e61d19b21e30ba9fb811b017ee767e9fb51e832b4186f3f107f6b7001907457bed6a2230f368f3b11b396ee95032d81e5a65b799627af404
-  data.tar.gz: 9b3fd7ca0f1218f88f517f78d11221c7e92c71c6776a53a77aacb3567c9a63f343d4473d4a453a116271807e7d249ea99ee81f2763fc44ac792f59502eb36bd4
+  metadata.gz: e82159d26a9e62445880b525619c11e6fe18d3f18378c72147de816d302efd7b3911aad3ff53c30fdd66982fa58ea4be7ff32ab3abd98c9f83f43127442c2db1
+  data.tar.gz: d5911f55bbd93e93baee10a8f28466eab44ca21980b7922ab05cb697d0d5fc2bdc4a09a70336d6f4f61614ba85a148b1c576eeba3f455078f4a935cec649f1f8

data/.tool-versions

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

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    sidekiq_alive (2.0.2)
+    sidekiq_alive (2.0.6)
       sidekiq
-      sinatra
 
 GEM
   remote: https://rubygems.org/
@@ -13,17 +12,15 @@ GEM
     diff-lcs (1.3)
     method_source (0.9.2)
     mock_redis (0.19.0)
-    mustermann (1.1.1)
-      ruby2_keywords (~> 0.0.1)
     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)
@@ -41,18 +38,11 @@ GEM
       rspec-core (~> 3.0, >= 3.0.0)
       sidekiq (>= 2.4.0)
     rspec-support (3.8.0)
-    ruby2_keywords (0.0.2)
     sidekiq (5.2.5)
       connection_pool (~> 2.2, >= 2.2.2)
       rack (>= 1.5.0)
       rack-protection (>= 1.5.0)
       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.10)
 
 PLATFORMS
   ruby
@@ -62,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.
@@ -65,11 +64,10 @@ bundle exec sidekiq
 
 ```
 curl localhost:7433
-#=> Alive!                                   
+#=> 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.
 ```
 
@@ -196,12 +194,34 @@ curl localhost:7433
 
 ```ruby
 SidekiqAlive.setup do |config|
+  # ==> Server host
+  # Host to bind the server.
+  # Can also be set with the environment variable SIDEKIQ_ALIVE_HOST.
+  # default: 0.0.0.0
+  #
+  #   config.host = 0.0.0.0
+
   # ==> Server port
-  # Port to bind the server
+  # Port to bind the server.
+  # Can also be set with the environment variable SIDEKIQ_ALIVE_PORT.
   # default: 7433
   #
   #   config.port = 7433
 
+  # ==> Server path
+  # HTTP path to respond to.
+  # Can also be set with the environment variable SIDEKIQ_ALIVE_PATH.
+  # default: '/'
+  #
+  #   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"
@@ -233,11 +253,11 @@ SidekiqAlive.setup do |config|
   #    config.queue_prefix = :other
 
   # ==> Rack server
-  # Web server used to run Sinatra
-  # default: webrick
+  # Web server used to serve an HTTP response.
+  # Can also be set with the environment variable SIDEKIQ_ALIVE_SERVER.
+  # default: 'webrick'
   #
-  #   config.server = 'puma'
-
+  #    config.server = 'puma'
 end
 ```
 

data/docker-compose.yml

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

data/lib/sidekiq_alive.rb

@@ -9,7 +9,7 @@ module SidekiqAlive
     SidekiqAlive::Worker.sidekiq_options queue: current_queue
     Sidekiq.configure_server do |sq_config|
 
-      sq_config.options[:queues] << current_queue
+      sq_config.options[:queues].unshift(current_queue)
 
       sq_config.on(:startup) do
         SidekiqAlive.tap do |sa|
@@ -27,6 +27,7 @@ module SidekiqAlive
       sq_config.on(:quiet) do
         SidekiqAlive.unregister_current_instance
       end
+
       sq_config.on(:shutdown) do
         Process.kill('TERM', @server_pid) unless @server_pid.nil?
         Process.wait(@server_pid) unless @server_pid.nil?

data/lib/sidekiq_alive/config.rb

@@ -4,26 +4,32 @@ module SidekiqAlive
   class Config
     include Singleton
 
-    attr_accessor :port,
+    attr_accessor :host,
+                  :port,
+                  :path,
                   :liveness_key,
                   :time_to_live,
                   :callback,
                   :registered_instance_key,
                   :queue_prefix,
-                  :server
+                  :server,
+                  :custom_liveness_probe
 
     def initialize
       set_defaults
     end
 
     def set_defaults
+      @host = ENV['SIDEKIQ_ALIVE_HOST'] || '0.0.0.0'
       @port = ENV['SIDEKIQ_ALIVE_PORT'] || 7433
+      @path = ENV['SIDEKIQ_ALIVE_PATH'] || '/'
       @liveness_key = 'SIDEKIQ::LIVENESS_PROBE_TIMESTAMP'
       @time_to_live = 10 * 60
       @callback = proc {}
       @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

@@ -1,21 +1,44 @@
 # frozen_string_literal: true
 
-require 'sinatra/base'
+require 'rack'
+
 module SidekiqAlive
-  class Server < Sinatra::Base
-    set :bind, '0.0.0.0'
-    set :port, -> { SidekiqAlive.config.port }
-    set :server, -> { SidekiqAlive.config.server }
-
-    get '/' do
-      if SidekiqAlive.alive?
-        status 200
-        body 'Alive!'
-      else
-        response = "Can't find the alive key"
-        SidekiqAlive.logger.error(response)
-        status 404
-        body response
+  class Server
+    class << self
+      def run!
+        handler =  Rack::Handler.get(server)
+
+        Signal.trap('TERM') { handler.shutdown }
+
+        handler.run(self, Port: port, Host: '0.0.0.0', AccessLog: [])
+      end
+
+      def host
+        SidekiqAlive.config.host
+      end
+
+      def port
+        SidekiqAlive.config.port
+      end
+
+      def path
+        SidekiqAlive.config.path
+      end
+
+      def server
+        SidekiqAlive.config.server
+      end
+
+      def call(env)
+        if Rack::Request.new(env).path != path
+          [404, {}, ['Not found']]
+        elsif SidekiqAlive.alive?
+          [200, {}, ['Alive!']]
+        else
+          response = "Can't find the alive key"
+          SidekiqAlive.logger.error(response)
+          [404, {}, [response]]
+        end
       end
     end
   end

data/lib/sidekiq_alive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqAlive
-  VERSION = '2.0.2'
+  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,9 +32,8 @@ 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'
-  spec.add_dependency 'sinatra'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_alive
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Artur Pañach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-16 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
@@ -108,20 +108,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: |-
   SidekiqAlive offers a solution to add liveness probe of a Sidekiq instance.
 
@@ -141,6 +127,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".tool-versions"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -150,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
@@ -175,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.