kubernetes-health 3.5.0 → 3.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b35fdf1eae585364a30777a0f0c8d67210ab99d97c492c33ea7e9c5a71b7d01c
-  data.tar.gz: a4b4f532380c9295e6077d4aba889abb9a17c36889a713d7e84d864b8f9c8e6d
+  metadata.gz: a53b0ea476aa3faef08ebb62fd3b7e9a625881fc8177b17d612625b44a220424
+  data.tar.gz: d031a5233193abb0da1b5fd2ec00acf253e3b5ea2711ad547cbed131ac0be223
 SHA512:
-  metadata.gz: 67cd817d32945e1f17f0b9363c393a408df9aec7352af14567d52a7562eab4969719b637f3c7acf3870595951f33a292ba9855c863b70bc125705f2b9f813ef1
-  data.tar.gz: ca42a6d7350435fb33c40521e4e2c72f2046af6fda5c634b3b4994960b8dea4af93d0015b037e80344559149ce329673dccdee6156baf9cabb98607f87519a6a
+  metadata.gz: cbf4b8efc0b5114eab92e2cb718e94f2f4cae89986e95f3bb8435ab4dc322401718a7d0a3398deec062e6ba5469a0bda5ad9a03f748f872707ae1baa9483a1c4
+  data.tar.gz: f4fffaa2f5a1a5eed2e5266a81361207dd4d16b8723489188ee535ad0a7e514b5c5958ccca731f27072aad7dab013a517cf228cbcfd356b8947199cf90ba9a24

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/kubernetes-health.gemspec

@@ -31,6 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_dependency "rack"
   spec.add_dependency "rails"
-  spec.add_runtime_dependency 'prometheus-client', '~> 0.9.0'
+  spec.add_runtime_dependency 'prometheus-client', '~> 1.0'
   spec.add_runtime_dependency 'puma'
 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,56 @@
+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 = generate_sidekiq_metrics
+
+          if ::Kubernetes::Health::Config.response_format == 'json'
+            content = sidekiq_metrics.to_json
+          else
+            prometheus_registry = generate_prometheus_registry
+            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 generate_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 generate_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.7.1'.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'
@@ -9,7 +9,7 @@ module Puma
       def initialize(launcher)
         @launcher = launcher
         clustered = (@launcher.options[:workers] || 0) > 0
-        @parser = Parser.new clustered
+        @parser = Parser.new(clustered: clustered)
       end
 
       def call(_env)
@@ -18,25 +18,26 @@ module Puma
           type = {}
           content = ''
           type = ::Kubernetes::Health::Config.response_format == 'json' ? { 'Content-Type' => 'application/json' } : { 'Content-Type' => 'text/plain' }
+          extended_puma_stats = generate_extended_puma_stats
           case req.path_info
           when ::Kubernetes::Health::Config.route_liveness
-            i_am_live = ::Kubernetes::Health::Config.live_if.arity == 0 ? ::Kubernetes::Health::Config.live_if.call : ::Kubernetes::Health::Config.live_if.call(req.params)
-            http_code = i_am_live ? 200 : 503
+            i_am_live = ::Kubernetes::Health::Config.live_if.arity.zero? ? ::Kubernetes::Health::Config.live_if.call : ::Kubernetes::Health::Config.live_if.call(req.params)
+            http_code = puma_already_started?(extended_puma_stats) && i_am_live ? 200 : 503
           when ::Kubernetes::Health::Config.route_readiness
-            i_am_ready = ::Kubernetes::Health::Config.ready_if.arity == 0 ? ::Kubernetes::Health::Config.ready_if.call : ::Kubernetes::Health::Config.ready_if.call(req.params)
-            http_code = i_am_ready ? 200 : 503
+            i_am_ready = ::Kubernetes::Health::Config.ready_if.arity.zero? ? ::Kubernetes::Health::Config.ready_if.call : ::Kubernetes::Health::Config.ready_if.call(req.params)
+            http_code = puma_already_started?(extended_puma_stats) && i_am_ready ? 200 : 503
           when ::Kubernetes::Health::Config.route_metrics
             http_code = 200
             if ::Kubernetes::Health::Config.response_format == 'json'
-              content = include_puma_key_prefix(include_usage(merge_worker_status_if_needed(@launcher.stats))).to_json
+              content = puma_status_json(extended_puma_stats)
             else
-              @parser.parse include_usage(merge_worker_status_if_needed(@launcher.stats))
+              prometheus_parse_status!(extended_puma_stats)
               content = Prometheus::Client::Formats::Text.marshal(Prometheus::Client.registry)
             end
           else
             http_code = 404
           end
-        rescue => e
+        rescue StandardError => e
           puts e.message
           puts e.backtrace.join("\n")
           http_code = 500
@@ -46,33 +47,52 @@ module Puma
         [http_code, type, [content]]
       end
 
-      def merge_worker_status_if_needed(stats)
-        return stats unless stats[:worker_status]
+      private
 
+      def prometheus_parse_status!(extended_puma_stats)
+        @parser.parse(extended_puma_stats)
+      end
+
+      def generate_extended_puma_stats
+        puma_stats = @launcher.stats
+        # On puma <= 4 puma_stats is a String
+        puma_stats = JSON.parse(puma_stats, symbolize_names: true) unless puma_stats.is_a?(Hash)
+        # Including usage stats.
+        puma_stats = merge_worker_status(puma_stats) if puma_stats[:worker_status].present?
+        puma_stats[:usage] = (1 - puma_stats[:pool_capacity].to_f / puma_stats[:max_threads]).round(2)
+        puma_stats
+      end
+
+      def merge_worker_status(stats)
         merded_stats = stats[:worker_status].map { |ws| ws[:last_status] }.inject({}) { |sum, hash| sum.merge(hash) { |_key, val1, val2| val1+val2 } }
-        merded_stats[:puma_started_at] = stats[:puma_started_at]
-        merded_stats[:worker_status] = stats[:worker_status]
+        stats.each_key do |k|
+          merded_stats[k] = stats[k]
+        end
+
         merded_stats
       end
 
-      def include_usage(stats)
-        if stats.is_a?(String)
-          # puma <= 4.
-          stats = JSON.parse(stats)
-        else
-          # Puma >=5 uses symbol.
-          stats = JSON.parse(stats.to_json)
-        end
-        stats['usage'] = (1 - stats['pool_capacity'].to_f / stats['max_threads']).round(2)
-        stats
+      def puma_status_json(extended_puma_stats)
+        include_puma_key_prefix(extended_puma_stats).to_json
       end
+
       def include_puma_key_prefix(stats)
         result = {}
-        stats.each do |k,v|
+        stats.each do |k, v|
           result["puma_#{k}"] = v
         end
         result
       end
+
+      def puma_already_started?(extended_puma_stats)
+        if extended_puma_stats[:booted_workers].present?
+          # Cluster Mode
+          extended_puma_stats[:booted_workers].positive?
+        else
+          # Single Mode
+          extended_puma_stats[:running].positive?
+        end
+      end
     end
   end
 end

data/lib/puma/kubernetes/parser.rb

@@ -3,33 +3,58 @@ require 'prometheus/client'
 module Puma
   module Kubernetes
     class Parser
-      def initialize(clustered = false)
-        register_default_kubernetes
-        register_clustered_kubernetes if clustered
+      def initialize(clustered: false)
+        register_default_metrics
+        register_clustered_metrics if clustered
       end
 
-      def parse(stats, labels = {})
-        stats.each do |key, value|
-          value.each { |s| parse(s, labels.merge(index: s['index'])) } if key == 'worker_status'
-          parse(value, labels) if key == 'last_status'
+      def parse(symbol_keyed_stats, labels = {})
+        symbol_keyed_stats.each do |key, value|
+          value.each { |s| parse(s, labels.merge(index: s[:index])) } if key == :worker_status
+          parse(value, labels) if key == :last_status
           update_metric(key, value, labels)
         end
       end
 
       private
 
-      def register_clustered_kubernetes
-        registry.gauge(:puma_booted_workers, 'Number of booted workers').set({}, 1)
-        registry.gauge(:puma_old_workers, 'Number of old workers').set({}, 0)
+      def register_clustered_metrics
+        registry.gauge(:puma_booted_workers,
+                       docstring: 'Number of booted workers')
+                .set(1)
+        registry.gauge(:puma_old_workers,
+                       docstring: 'Number of old workers')
+                .set(0)
       end
 
-      def register_default_kubernetes
-        registry.gauge(:puma_backlog, 'Number of established but unaccepted connections in the backlog', index: 0)
-        registry.gauge(:puma_running, 'Number of running worker threads', index: 0)
-        registry.gauge(:puma_pool_capacity, 'Number of allocatable worker threads', index: 0)
-        registry.gauge(:puma_max_threads, 'Maximum number of worker threads', index: 0)
-        registry.gauge(:puma_workers, 'Number of configured workers').set({}, 1)
-        registry.gauge(:puma_usage, 'Result of (1 - puma_pool_capacity/puma_max_threads)', index: 0)
+      def register_default_metrics # rubocop:disable Metrics/MethodLength
+        registry.gauge(:puma_backlog,
+                       docstring: 'Number of established but unaccepted connections in the backlog',
+                       labels: [:index],
+                       preset_labels: { index: 0 })
+        registry.gauge(:puma_running,
+                       docstring: 'Number of running worker threads',
+                       labels: [:index],
+                       preset_labels: { index: 0 })
+        registry.gauge(:puma_pool_capacity,
+                       docstring: 'Number of allocatable worker threads',
+                       labels: [:index],
+                       preset_labels: { index: 0 })
+        registry.gauge(:puma_max_threads,
+                       docstring: 'Maximum number of worker threads',
+                       labels: [:index],
+                       preset_labels: { index: 0 })
+        registry.gauge(:puma_requests_count,
+                       docstring: 'Number of processed requests',
+                       labels: [:index],
+                       preset_labels: { index: 0 })
+        registry.gauge(:puma_usage,
+                       docstring: 'Result of (1 - puma_pool_capacity/puma_max_threads)',
+                       labels: [:index],
+                       preset_labels: { index: 0 })
+        registry.gauge(:puma_workers,
+                       docstring: 'Number of configured workers')
+                .set(1)
       end
 
       def registry
@@ -39,7 +64,7 @@ module Puma
       def update_metric(key, value, labels)
         return if registry.get("puma_#{key}").nil?
 
-        registry.get("puma_#{key}").set(labels, value)
+        registry.get("puma_#{key}").set(value, labels: labels)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-health
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.7.1
 platform: ruby
 authors:
 - Wagner Caixeta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-08 00:00:00.000000000 Z
+date: 2022-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -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