sidekiq_alive 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0e7e972b09b3d5ee8de3fe0e32bd23adae47a46d
-  data.tar.gz: 3c7e7ebcfcba7f850e0563f2fc8d2651cf585321
+SHA256:
+  metadata.gz: 3d830981c90cc8b2fe8ac0bf9effc622122a4eede48a0f0b3bfcfa56c46141e6
+  data.tar.gz: ead02f79ea837523c3cb2ed27e75fb4acaa679bfea96b16612c245c0564ce6a0
 SHA512:
-  metadata.gz: 1470c68f1fecbafa1d5a6e0e53c0767b89c65cd3e8cfec47662df6ed738179f467c0e603efbf56b24a91c0a54764f9aafa775b955b08c51172e48d1affc1ba26
-  data.tar.gz: 4e67168aa2f3de897070748382482df8d1b69f11aa24d482affae8bdb3d02e0a06475f5102e8a683ed79e0b5ad8e6127daed7f0249c71f15edb2d855fd3fab42
+  metadata.gz: 4888b18026c9252aaff4088f4f7bd0d023c6494cb2151a351068a14fe09608bbcf3af9482eb291e9c931e9afc8a3b20bff4b74fe4e8db916771ca51df6a642a2
+  data.tar.gz: 350800b476d209af711a4682f3f5acefc7cac0fec82d66ba0ade63e2f30056cfa1964dbcb4df778c22aedeea86ae6d54000df2b8ba824221bce5d7799855865f

data/Gemfile

@@ -4,3 +4,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in sidekiq_alive.gemspec
 gemspec
+
+gem 'pry'

data/Gemfile.lock

@@ -1,17 +1,22 @@
 PATH
   remote: .
   specs:
-    sidekiq_alive (0.1.1)
+    sidekiq_alive (1.0.0)
       sidekiq
       sinatra
 
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.2)
     concurrent-ruby (1.0.5)
     connection_pool (2.2.1)
     diff-lcs (1.3)
+    method_source (0.9.0)
     mock_redis (0.18.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rack (1.6.8)
     rack-protection (1.5.3)
       rack
@@ -52,6 +57,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   mock_redis
+  pry
   rack-test
   rake (~> 10.0)
   rspec (~> 3.0)
@@ -59,4 +65,4 @@ DEPENDENCIES
   sidekiq_alive!
 
 BUNDLED WITH
-   1.16.2
+   1.16.4

data/README.md

@@ -1,6 +1,7 @@
 # SidekiqAlive
 
 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?__
 
@@ -11,6 +12,8 @@ this key gets expired by Redis an consequently the http server will return a 500
 
 This Job is responsible to requeue itself for the next liveness probe.
 
+Each instance in kubernetes will be checked based on `ENV` variable `HOSTNAME` (kubernetes sets this for each replica/pod).
+
 
 ## Installation
 
@@ -30,26 +33,15 @@ Or install it yourself as:
 
 ## Usage
 
-### start the server
-
-rails example:
-
-`config/initializers/sidekiq.rb`
-
-```ruby
-SidekiqAlive.start
-```
+SidekiqAlive will start when running `sidekiq` command.
 
-### Run the job for first time
 
-It should only be run on the first time you deploy the app.
-It would reschedule itself.
+__how to disable?__
+You can disabled by setting `ENV` variable `DISABLE_SIDEKIQ_ALIVE`
+example:
 
-rails example:
 ```
-$ bundle exec rails console
-
-#=> SidekiqAlive::Worker.perform_async
+DISABLE_SIDEKIQ_ALIVE=true bundle exec sidekiq
 ```
 
 ### Kubernetes setup
@@ -92,12 +84,28 @@ spec:
   terminationGracePeriodSeconds: 60 # put your longest Job time here plus security time.
 ```
 
+### Outside kubernetes
+
+It's just up to you how you want to use it.
+
+An example in local would be:
+
+```
+bundle exec sidekiq
+# let it initialize ...
+```
+
+```
+curl localhost:7433
+#=> Alive!
+```
+
 ## Options
 
 ```ruby
 SidekiqAlive.setup do |config|
   # ==> Server port
-  # port to bind the server
+  # Port to bind the server
   # default: 7433
   #
   #   config.port = 7433

data/lib/sidekiq_alive.rb

@@ -7,14 +7,32 @@ module SidekiqAlive
   def self.start
     Sidekiq.configure_server do |config|
       config.on(:startup) do
-        SidekiqAlive::Worker.perform_async
-        SidekiqAlive::Server.start
+        SidekiqAlive.tap do |sa|
+          sa.logger.info(banner)
+          sa.register_current_instance
+          sa.store_alive_key
+          sa::Worker.perform_async(hostname)
+          sa::Server.start
+          sa.logger.info(successful_startup_text)
+        end
       end
     end
   end
 
+  def self.register_current_instance
+    register_instance(current_instance_register_key)
+  end
+
+  def self.registered_instances
+    redis.keys("#{config.registered_instance_key}::*")
+  end
+
+  def self.current_instance_register_key
+    "#{config.registered_instance_key}::#{hostname}"
+  end
+
   def self.store_alive_key
-    redis.set(config.liveness_key,
+    redis.set(current_lifeness_key,
               Time.now.to_i,
               { ex: config.time_to_live.to_i })
   end
@@ -24,7 +42,7 @@ module SidekiqAlive
   end
 
   def self.alive?
-    redis.ttl(config.liveness_key) == -2 ? false : true
+    redis.ttl(current_lifeness_key) == -2 ? false : true
   end
 
   # CONFIG ---------------------------------------
@@ -33,10 +51,56 @@ module SidekiqAlive
     yield(config)
   end
 
+  def self.logger
+    Sidekiq::Logging.logger
+  end
+
   def self.config
     @config ||= SidekiqAlive::Config.instance
   end
+
+  def self.current_lifeness_key
+    "#{config.liveness_key}::#{hostname}"
+  end
+
+  def self.hostname
+    ENV['HOSTNAME'] || 'HOSTNAME_NOT_SET'
+  end
+
+  def self.banner
+    <<-BANNER.strip_heredoc
+
+    =================== SidekiqAlive =================
+
+    Hostname: #{hostname}
+    Liveness key: #{current_lifeness_key}
+    Port: #{config.port}
+    Time to live: #{config.time_to_live}s
+    Current instance register key: #{current_instance_register_key}
+
+    starting ...
+    BANNER
+  end
+
+  def self.successful_startup_text
+    <<-BANNER.strip_heredoc
+
+    =================== SidekiqAlive Ready! =================
+
+    Registered instances:
+
+      - #{registered_instances.join("\n\s\s- ")}
+    BANNER
+  end
+
+  def self.register_instance(instance_name)
+    redis.set(instance_name,
+              Time.now.to_i,
+              { ex: config.time_to_live.to_i + 60 })
+  end
 end
 
 require "sidekiq_alive/worker"
 require "sidekiq_alive/server"
+
+SidekiqAlive.start unless ENV['DISABLE_SIDEKIQ_ALIVE']

data/lib/sidekiq_alive/config.rb

@@ -2,13 +2,23 @@ module SidekiqAlive
   class Config
     include Singleton
 
-    attr_accessor :port, :liveness_key, :time_to_live, :callback
+    attr_accessor :port,
+                  :liveness_key,
+                  :time_to_live,
+                  :callback,
+                  :registered_instance_key
 
     def initialize
-      @port = 7433
+      set_defaults
+    end
+
+    def set_defaults
+      @port = ENV['SIDEKIQ_ALIVE_PORT'] || 7433
       @liveness_key = 'SIDEKIQ::LIVENESS_PROBE_TIMESTAMP'
       @time_to_live = 10 * 60
       @callback = proc {}
+      @registered_instance_key = "SIDEKIQ_REGISTERED_INSTANCE"
     end
+
   end
 end

data/lib/sidekiq_alive/server.rb

@@ -6,8 +6,6 @@ module SidekiqAlive
 
     class << self
       def start
-        Sidekiq::Logging.logger.info "Writing SidekiqAlive alive key in redis: #{SidekiqAlive.config.liveness_key}"
-        SidekiqAlive.store_alive_key
         set :port, SidekiqAlive.config.port
         Thread.start { run! }
       end
@@ -24,7 +22,7 @@ module SidekiqAlive
         body "Alive!"
       else
         response = "Can't find the alive key"
-        Sidekiq::Logging.logger.error(response)
+        SidekiqAlive.logger.error(response)
         status 404
         body response
       end

data/lib/sidekiq_alive/version.rb

@@ -1,3 +1,3 @@
 module SidekiqAlive
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/lib/sidekiq_alive/worker.rb

@@ -3,18 +3,37 @@ module SidekiqAlive
     include Sidekiq::Worker
     sidekiq_options retry: false
 
-    def perform
-      write_living_probe
-      self.class.perform_in(config.time_to_live / 2)
+    def perform(hostname = SidekiqAlive.hostname)
+      return unless hostname_registered?(hostname)
+      if current_hostname == hostname
+        write_living_probe
+        # schedule next living probe
+        self.class.perform_in(config.time_to_live / 2, current_hostname)
+      else
+        # requeue for hostname to validate it's own liveness probe
+        self.class.perform_async(hostname)
+      end
+    end
+
+    def hostname_registered?(hostname)
+      SidekiqAlive.registered_instances.any? do |ri|
+        /#{hostname}/ =~ ri
+      end
     end
 
     def write_living_probe
       # Write liveness probe
       SidekiqAlive.store_alive_key
+      # Increment ttl for current registered instance
+      SidekiqAlive.register_current_instance
       # after callbacks
       config.callback.call()
     end
 
+    def current_hostname
+      SidekiqAlive.hostname
+    end
+
     def config
       SidekiqAlive.config
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_alive
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Artur Pañach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-11 00:00:00.000000000 Z
+date: 2018-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -176,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Liveness probe for sidekiq on Kubernetes deployments.