sidekiq_alive 2.0.1 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42f950238fc2224907b8c32fe4219f1ad5d3f3a083e68e0230ce98ede04753a9
-  data.tar.gz: e8d383349ac91b93c86a0f459d59fe963b9e318157c2fe3c7648f5e88cc1c394
+  metadata.gz: cf72b576226b373f7e661aae05d54ec27fcb3e5f612036ab86bd89a18d23b289
+  data.tar.gz: f3148f40e24f04bf743b3f097a12045554109a2a8af965e7d84ef9344f7b4c23
 SHA512:
-  metadata.gz: 71ce02b4cbdc408a6ab9db14200d78bf2750f130a2d5c1bf877c80854f4b03cfd87e7eda9c3874f6f1ae13950f2d7df61c49a587f7a20c6ca8f1e28bd581ac30
-  data.tar.gz: 981d3bccb5c3fc813614c85b4656708af80c7bb392b7454379d740444a2cb8c0ac0c00bf2d5d2e12a8bd67e68d19236d2eaa39970b79719598f32b79d01ffc76
+  metadata.gz: 56b9231da7d95a74a0a0067ca06a91b921502af01b0da62975dfd4b89dcbc2a9694ce3bf6925dac2cc3f9ba1c5453e1627c4a44432a65f5b2fb17a66ee5ef8af
+  data.tar.gz: 9c116fef8bfbfe1db518408b38b2abc3701faf39e21273073e9ca86d295e0c827fa843153fd8e6d9be6d52740203261351292e6f19e3cb6da25b0f639c379d26

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in sidekiq_alive.gemspec
 gemspec

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    sidekiq_alive (2.0.0)
+    sidekiq_alive (2.0.6)
       sidekiq
-      sinatra
 
 GEM
   remote: https://rubygems.org/
@@ -13,11 +12,10 @@ GEM
     diff-lcs (1.3)
     method_source (0.9.2)
     mock_redis (0.19.0)
-    mustermann (1.0.3)
     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)
@@ -45,12 +43,6 @@ GEM
       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.9)
 
 PLATFORMS
   ruby

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.
 ```
 
@@ -123,7 +121,7 @@ spec:
 
 Create file:
 
-__kube/sidekiq_quiet__
+_kube/sidekiq_quiet_
 
 ```bash
 #!/bin/bash
@@ -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"
@@ -227,11 +247,17 @@ SidekiqAlive.setup do |config|
   # ==> 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. 
+  # You can customize the prefix here.
   # default: :sidekiq_alive
   #
   #    config.queue_prefix = :other
 
+  # ==> Rack server
+  # Web server used to serve an HTTP response.
+  # Can also be set with the environment variable SIDEKIQ_ALIVE_SERVER.
+  # default: 'webrick'
+  #
+  #    config.server = 'puma'
 end
 ```
 

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "sidekiq_alive"
+require 'bundler/setup'
+require 'sidekiq_alive'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "sidekiq_alive"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

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

@@ -1,29 +1,39 @@
+# frozen_string_literal: true
+
 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
+                  :queue_prefix,
+                  :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
-      @registration_ttl ? @registration_ttl : time_to_live + 60
+      @registration_ttl || time_to_live + 60
     end
   end
 end

data/lib/sidekiq_alive/server.rb

@@ -1,18 +1,44 @@
-require 'sinatra/base'
+# frozen_string_literal: true
+
+require 'rack'
+
 module SidekiqAlive
-  class Server < Sinatra::Base
-    set :bind, '0.0.0.0'
-    set :port, -> { SidekiqAlive.config.port }
-
-    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: host)
+      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,3 +1,5 @@
+# frozen_string_literal: true
+
 module SidekiqAlive
-  VERSION = '2.0.1'.freeze
+  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)
+    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
 
@@ -21,7 +27,11 @@ module SidekiqAlive
       # Increment ttl for current registered instance
       SidekiqAlive.register_current_instance
       # after callbacks
-      config.callback.call() rescue nil
+      begin
+        config.callback.call
+      rescue StandardError
+        nil
+      end
     end
 
     def current_hostname

data/sidekiq_alive.gemspec

@@ -1,16 +1,15 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "sidekiq_alive/version"
+require 'sidekiq_alive/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sidekiq_alive"
+  spec.name          = 'sidekiq_alive'
   spec.version       = SidekiqAlive::VERSION
-  spec.authors       = ["Artur Pañach"]
-  spec.email         = ["arturictus@gmail.com"]
+  spec.authors       = ['Artur Pañach']
+  spec.email         = ['arturictus@gmail.com']
 
-  spec.summary       = %q{Liveness probe for sidekiq on Kubernetes deployments.}
-  spec.description   = %q{SidekiqAlive offers a solution to add liveness probe of a Sidekiq instance.
+  spec.summary       = 'Liveness probe for sidekiq on Kubernetes deployments.'
+  spec.description   = 'SidekiqAlive offers a solution to add liveness probe of a Sidekiq instance.
 
   How?
 
@@ -19,23 +18,22 @@ Gem::Specification.new do |spec|
   A Sidekiq job is the responsable to storing this key. If Sidekiq stops processing jobs
   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.}
-  spec.homepage      = "https://github.com/arturictus/sidekiq_alive"
-  spec.license       = "MIT"
+  This Job is responsible to requeue itself for the next liveness probe.'
+  spec.homepage      = 'https://github.com/arturictus/sidekiq_alive'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rack-test"
-  spec.add_development_dependency "rspec-sidekiq", "~> 3.0"
-  spec.add_development_dependency "mock_redis"
-  spec.add_dependency "sidekiq"
-  spec.add_dependency "sinatra"
+  spec.require_paths = ['lib']
+
+  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 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-sidekiq', '~> 3.0'
+  spec.add_dependency 'sidekiq'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_alive
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.6
 platform: ruby
 authors:
 - Artur Pañach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-03 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,33 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
+  name: mock_redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -67,49 +53,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-sidekiq
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: mock_redis
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: sidekiq
+  name: rspec-sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '3.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -175,8 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Liveness probe for sidekiq on Kubernetes deployments.