kubernetes-health 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b35fdf1eae585364a30777a0f0c8d67210ab99d97c492c33ea7e9c5a71b7d01c
-  data.tar.gz: a4b4f532380c9295e6077d4aba889abb9a17c36889a713d7e84d864b8f9c8e6d
+  metadata.gz: 6f0b091b68d3acd2e69b0e2e259ad841eef9b5030ae7f7a8a404f7d0535722c7
+  data.tar.gz: 2ab614dc570e2b8202533101566a4eb0f6aca71ad2490d27ac10d4739e9cc322
 SHA512:
-  metadata.gz: 67cd817d32945e1f17f0b9363c393a408df9aec7352af14567d52a7562eab4969719b637f3c7acf3870595951f33a292ba9855c863b70bc125705f2b9f813ef1
-  data.tar.gz: ca42a6d7350435fb33c40521e4e2c72f2046af6fda5c634b3b4994960b8dea4af93d0015b037e80344559149ce329673dccdee6156baf9cabb98607f87519a6a
+  metadata.gz: 26068d438952f640c22b9e7ce3d416aeec53fd32bec73013de08c4037ad1183619dd13cd8f23fe1561d2a57f191272a895138b9cb0279bc90fa41cba309d8d2a
+  data.tar.gz: 5c89c1531a8f10b858ba3bcd7626fe7d34fc308bde57bb0ba56fbd26e45e85b50caa72332186e4ce2e04c4e50a17c26226dabb0a7d13738eea02acdd9805491f

data/README.md

@@ -1,21 +1,22 @@
 # Kubernetes::Health
-
-This gem allows kubernetes monitoring your app while it is running migrates and after it starts.
+This gem open a HTTP port for monitoring your rails app while it is running Migrates, Sidekiq and Puma.
 
 # Features
-- add routes `/_readiness`, `/_liveness` on rails stack.
-- add routes `/_readiness`, `/_liveness` and `/_metrics` as a puma plugin.
-- metrics are prometheus compatible (code copied from `puma-metrics` gem) or json.
-- allow custom checks for `/_readiness` and `/_liveness`.
+- Puma and Sidekiq metrics for autoscaling.
+- Prometheus and JSON metrics (tested using https://github.com/zalando-incubator/kube-metrics-adapter and JSON format).
+- add routes `/_readiness`, `/_liveness` on Rails Stack.
+- add routes `/_readiness`, `/_liveness` and `/_metrics` as a puma plugin at another port to avoid problems when your app get busy. (code copied from `puma-metrics` gem).
 - add routes `/_readiness` and `/_liveness` while `rake db:migrate` runs. (optional)
-- add support to avoid parallel running of `rake db:migrate` while keep kubernetes waiting. (optional)
-
+- add routes `/_readiness` and `/_liveness` while `sidekiq` runs. (optional)
+- add support to avoid parallel running of `rake db:migrate` while keep kubernetes waiting (PostgreSQL required).
+- allow custom checks for `/_readiness` and `/_liveness`.
+ 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'kubernetes-health', '~> 3.5'
+gem 'kubernetes-health', '~> 3.6'
 ```
 
 ## Enabling puma plugin
@@ -48,6 +49,7 @@ In Kubernetes you need to configure your deployment `readinessProbe` and `livene
 ```
 
 Setting `failureThreshold` is import to avoid problems when app finish migrates and is starting the web process.
+
 ## Enabling monitoring while `rake db:migrate` runs
 
 Your Dockerfile's entry script needs to run migrates before start your web app.
@@ -60,9 +62,22 @@ or add in your `application.rb`.
 # default: false
 Kubernetes::Health::Config.enable_rack_on_migrate = true
 ```
+The defined port at `config/puma.rb` will be used.
+
+## Enabling monitoring for `sidekiq`
+
+Add `KUBERNETES_HEALTH_ENABLE_RACK_ON_SIDEKIQ=true` environment variable.
+
+or add in your `application.rb`.
+
+```
+# default: false
+Kubernetes::Health::Config.enable_rack_on_sidekiq = true
+```
+The defined port at `config/puma.rb` will be used.
 
-### How `rake db:migrate` monitoring works
-It will run a RACK server for `/_readiness` and `/_liveness` routes while `rake db:migrate` is running.
+### How `rake db:migrate` and `sidekiq` monitoring works
+It will run a RACK server for `/_readiness`, `/_liveness` and `/_metrics`.
 
 ## Avoiding migrations running in parallel and making kubernetes happy.
 Rails already avoid migrations running in parallel, but it raise exceptions. This gem will just wait for other migrations without exit.

data/Rakefile

@@ -12,7 +12,7 @@ task :server do
   require 'puma'
   require 'puma/configuration'
   require 'puma/events'
-  require 'puma/plugin/kubernetes.rb'
+  require 'puma/plugin/kubernetes'
 
   configuration = Puma::Configuration.new do |config|
     config.bind 'tcp://127.0.0.1:0'

data/config/initializers/enable_rack_on_sidekiq.rb

@@ -0,0 +1,7 @@
+require 'kubernetes/health/rack_on_sidekiq'
+
+if Kubernetes::Health::Config.enable_rack_on_sidekiq && Sidekiq.options[:concurrency].positive?
+  Thread.new do
+    Rack::Handler.default.run Kubernetes::Health::RackOnSidekiq.new
+  end
+end

data/lib/kubernetes/health/config.rb

@@ -5,6 +5,7 @@ module Kubernetes
       @@ready_if = lambda { true }
       @@enable_lock_on_migrate = [true, 'true'].include? ENV['KUBERNETES_HEALTH_ENABLE_LOCK_ON_MIGRATE']
       @@enable_rack_on_migrate = [true, 'true'].include? ENV['KUBERNETES_HEALTH_ENABLE_RACK_ON_MIGRATE']
+      @@enable_rack_on_sidekiq = [true, 'true'].include? ENV['KUBERNETES_HEALTH_ENABLE_RACK_ON_SIDEKIQ']
       @@route_liveness = '/_liveness'
       @@route_readiness = '/_readiness'
       @@route_metrics = '/_metrics'
@@ -57,6 +58,14 @@ module Kubernetes
         @@enable_rack_on_migrate = value
       end
 
+      def self.enable_rack_on_sidekiq
+        @@enable_rack_on_sidekiq
+      end
+
+      def self.enable_rack_on_sidekiq=(value)
+        @@enable_rack_on_sidekiq = value
+      end
+
       def self.route_metrics
         @@route_metrics
       end

data/lib/kubernetes/health/rack_on_migrate.rake

@@ -1,10 +1,11 @@
 require 'rack'
 require "kubernetes/health/rack_on_migrate"
+
 namespace :kubernetes_health do
   task :rack_on_migrate do
-    Thread.new {
+    Thread.new do
       Rack::Handler.default.run Kubernetes::Health::RackOnMigrate.new
-    }
+    end
   end
 end
 Rake::Task['db:migrate'].enhance(['kubernetes_health:rack_on_migrate'])

data/lib/kubernetes/health/rack_on_sidekiq.rb

@@ -0,0 +1,57 @@
+require 'rack'
+require 'prometheus/client'
+require 'prometheus/client/formats/text'
+
+module Kubernetes
+  module Health
+    class RackOnSidekiq
+      def call(env)
+        req = ::Rack::Request.new(env)
+        content = ''
+        type = ::Kubernetes::Health::Config.response_format == 'json' ? { 'Content-Type' => 'application/json' } : { 'Content-Type' => 'text/plain' }
+        case req.path_info
+        when Kubernetes::Health::Config.route_metrics
+          http_code = 200
+
+          @sidekiq_metrics = sidekiq_metrics
+
+          if ::Kubernetes::Health::Config.response_format == 'json'
+            content = @sidekiq_metrics.to_json
+          else
+            prometheus_registry.get(:sidekiq_capacity).set({}, @sidekiq_metrics[:sidekiq_capacity])
+            prometheus_registry.get(:sidekiq_busy).set({}, @sidekiq_metrics[:sidekiq_busy])
+            prometheus_registry.get(:sidekiq_usage).set({}, @sidekiq_metrics[:sidekiq_usage])
+            content = Prometheus::Client::Formats::Text.marshal(prometheus_registry)
+          end
+        else
+          http_code = 404
+        end
+        ::Kubernetes::Health::Config.request_log_callback.call(req, http_code, content)
+
+        [http_code, type, [content]]
+      end
+
+      def prometheus_registry
+        return @prometheus_registry if @prometheus_registry
+
+        @prometheus_registry = Prometheus::Client.registry
+        @prometheus_registry.gauge(:sidekiq_capacity, 'Sidekiq Threads Number', index: 0)
+        @prometheus_registry.gauge(:sidekiq_busy, 'Sidekiq Busy Threads', index: 0)
+        @prometheus_registry.gauge(:sidekiq_usage, 'Result of sidekiq_busy/sidekiq_capacity', index: 0)
+        @prometheus_registry
+      end
+
+      def sidekiq_metrics
+        sidekiq_info = Sidekiq::ProcessSet.new.to_a.filter { |p| p.identity == Sidekiq.options[:identity] }
+
+        stats = {
+          sidekiq_capacity: Sidekiq.options[:concurrency],
+          sidekiq_busy: sidekiq_info.size.zero? ? 0 : sidekiq_info[0]['busy']
+        }
+
+        stats[:sidekiq_usage] = (stats[:sidekiq_busy] / stats[:sidekiq_capacity].to_f).round(2)
+        stats
+      end
+    end
+  end
+end

data/lib/kubernetes/health/version.rb

@@ -1,5 +1,5 @@
 module Kubernetes
   module Health
-    VERSION = "3.5.0"
+    VERSION = '3.6.0'.freeze
   end
 end

data/lib/puma/kubernetes/app.rb

@@ -1,4 +1,4 @@
-require "kubernetes/health/config"
+require 'kubernetes/health/config'
 require 'prometheus/client/formats/text'
 require 'puma/kubernetes/parser'
 require 'rack'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-health
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Wagner Caixeta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-08 00:00:00.000000000 Z
+date: 2022-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,6 +128,7 @@ files:
 - app/controllers/kubernetes/health_controller.rb
 - bin/console
 - bin/setup
+- config/initializers/enable_rack_on_sidekiq.rb
 - config/routes.rb
 - kubernetes-health.gemspec
 - lib/kubernetes/health.rb
@@ -136,6 +137,7 @@ files:
 - lib/kubernetes/health/lock_on_migrate.rake
 - lib/kubernetes/health/rack_on_migrate.rake
 - lib/kubernetes/health/rack_on_migrate.rb
+- lib/kubernetes/health/rack_on_sidekiq.rb
 - lib/kubernetes/health/railtie.rb
 - lib/kubernetes/health/version.rb
 - lib/puma/kubernetes/app.rb