sidekiq_alive 2.0.4 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbf273df09ffb9644877ecc5966a9c7e94615d491b13a79c8b1dc50a298188cd
-  data.tar.gz: f5f6aed93f4504d8ddb2b0b38a24841a93110e09392d08d8e5639458cf505e85
+  metadata.gz: cbebd769f1de056322e4efcae5e38a6ec9f6257dc7b66e7c01ed8383c3f92159
+  data.tar.gz: c17640dff13d58911b06c27ec262718050f949dd649aa4ca70d113aeb04ff99d
 SHA512:
-  metadata.gz: 18a60ff3d82051ca24831b886a7b1a98be6c8121f89d13a25fc2b875357de615afd6620a80e9ed36f99d4b5b48a48eb3172f01548306d7658fcb0f80650d0ec8
-  data.tar.gz: 7365d0aadc34ea188ff9a268222e2c7b7d21840f527f5444653fba72f9fdb3cd5184c5268b66590e8d2f8bacac85884c2a7ed7b0423d9920654372066fc37f58
+  metadata.gz: 101e33628eb65ed68b753d7d7fd6704176895c80085e18d0a72c4eee80d08f331d2533de0853c708de9f716f694d09219baaf16805c2d36b854473c04ef0f010
+  data.tar.gz: 351477e70c6480d85fc035d82b46f294b2da82ea6faac039754c26c388aa9db24ecedb14f867ad5793effcd240d7c50852fbdabe52fc26da1c07d1026e7f1fa1

data/.github/workflows/test.yml

@@ -0,0 +1,41 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [3.0.x, 2.7.x, 2.6.x, 2.5.x]
+      # Service containers to run with `runner-job`
+    services:
+      # Label used to access the service container
+      redis:
+        # Docker Hub image
+        image: redis
+        # Set health checks to wait until redis has started
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          # Maps port 6379 on service container to the host
+          - 6379:6379
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/.tool-versions

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sidekiq_alive (2.0.4)
+    sidekiq_alive (2.1.1)
       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)
@@ -48,14 +48,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (> 1.16)
   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.
 ```
 
@@ -196,6 +194,13 @@ 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.
   # Can also be set with the environment variable SIDEKIQ_ALIVE_PORT.
@@ -210,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.rb

@@ -52,7 +52,14 @@ module SidekiqAlive
   end
 
   def self.registered_instances
-    redis.keys("#{config.registered_instance_key}::*")
+    deep_scan("#{config.registered_instance_key}::*")
+  end
+
+  def self.deep_scan(keyword, keys = [], cursor = 0)
+    next_cursor, found_keys = *redis { |r| r }.scan(cursor, match: keyword)
+    keys += found_keys
+    return keys if next_cursor == "0" || found_keys.blank?
+    deep_scan(keyword, keys, next_cursor)
   end
 
   def self.purge_pending_jobs

data/lib/sidekiq_alive/config.rb

@@ -4,20 +4,23 @@ 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'
@@ -26,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,11 @@ module SidekiqAlive
 
         Signal.trap('TERM') { handler.shutdown }
 
-        handler.run(self, Port: port, Host: '0.0.0.0')
+        handler.run(self, Port: port, Host: '0.0.0.0', AccessLog: [])
+      end
+
+      def host
+        SidekiqAlive.config.host
       end
 
       def port

data/lib/sidekiq_alive/version.rb

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

@@ -29,10 +29,10 @@ Gem::Specification.new do |spec|
   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 '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,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_alive
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.1.1
 platform: ruby
 authors:
 - Artur Pañach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2021-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
@@ -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
@@ -125,8 +125,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
+- ".tool-versions"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -136,6 +138,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 +164,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.