kubernetes-health 3.12.0 → 3.12.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9db3c40048a1127229efee6653df4da36ef6d38ef1b57ab51677073fecdede0d
-  data.tar.gz: 12402ee8b8e151cb4c5992d63fc37607f6ae7ae070e6e8fb57862825ec0b7146
+  metadata.gz: 69c1ed0bafbc26dfa3d4cf60ed954557841469e134131a58826c5b17dbd2dd6e
+  data.tar.gz: 6300a0c9d587f641cd649b0715162f701544560a39a69bfbaab40d16dc0c482d
 SHA512:
-  metadata.gz: 598d564124cc3ff32b959538f4e3d9d9863c058ece7eadc9dd37fccfbdd4fe1010b503382a24d319d690c87a12bf3a81f8b1c7717ddb3ae954d7c9f242a7db0b
-  data.tar.gz: 8c8bd4f687f964583cb2390bd7c43f141173bb8273a47fed82269e4829a36c43a92bcfa681e5c13e104be2488c905f65361714e1ca4e46e6e38a89406e2e210d
+  metadata.gz: b622eb35caa632f931a22c4da90c6613ac65307d8def6a635ef91f73709a65b0d303f77ea9752e0a0e9e90e5b87d90892237a86cc4e7fd5bdf77fbb334697385
+  data.tar.gz: 749a290a82252eb12a526c06fa84c201ef83d5e4122610ad1de0aa84683e316459515e1a174e6360104b4bd01d407f7ad9f0652b9ae25eb2b8c056ce1b82c334

data/README.md

@@ -1,13 +1,13 @@
 # Kubernetes::Health
-This gem open a HTTP port for monitoring your rails app while it is running Migrates, Sidekiq and Puma.
+This gem opens a dedicated HTTP port to allow Kubernetes to monitor your Rails app while it is running migrations, Rake tasks, Sidekiq, or Puma.
 
 # Features
 - Puma and Sidekiq metrics for autoscaling.
-- Prometheus and JSON metrics (tested using https://github.com/zalando-incubator/kube-metrics-adapter and JSON format).
+- Prometheus and JSON metrics.
 - 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 routes `/_readiness` and `/_liveness` while `sidekiq` runs. (optional)
+- add routes `/_metrics` 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`.
  
@@ -16,7 +16,7 @@ This gem open a HTTP port for monitoring your rails app while it is running Migr
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'kubernetes-health', '~> 3.7'
+gem 'kubernetes-health', '~> 3.12.1'
 ```
 
 ## Enabling puma plugin
@@ -80,7 +80,7 @@ Rake::Task['assets:precompile'].enhance(['kubernetes_health:rack_on_rake'])
 Rake::Task['assets:clobber'].enhance(['kubernetes_health:rack_on_rake'])
 ```
 
-I do recomend doing some check to make it only enables in K8S environment.
+I do recommend doing some checks to make it only enabled in the K8S environment.
 The defined port at `config/puma.rb` will be used but can be overrided by `KUBERNETES_HEALTH_METRICS_PORT` env var.
 
 ## Enabling liveness/readiness routes for `sidekiq`
@@ -96,11 +96,11 @@ Kubernetes::Health::Config.enable_rack_on_sidekiq = true
 The defined port at `config/puma.rb` will be used but can be overrided by `KUBERNETES_HEALTH_METRICS_PORT` env var.
 
 ### How `rake` and `sidekiq` monitoring works
-It will run a RACK server for `/_readiness`, `/_liveness` and `/_metrics`.
+It will run a rack server for `/_readiness`, `/_liveness` and `/_metrics` for rake and `/_metrics` for Sidekiq.
 The liveness route will respond using `200` but readiness `503`.
 
 ## 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.
+Rails already avoid migrations running in parallel, but it raises exceptions. This gem will just wait for other migrations without exit.
 If you enable `rack_on_migrate` together with this, kubernetes will just wait, avoiding erros.
 
 

data/lib/kubernetes/health/version.rb

@@ -1,5 +1,5 @@
 module Kubernetes
   module Health
-    VERSION = '3.12.0'.freeze
+    VERSION = '3.12.4'.freeze
   end
 end

data/lib/puma/kubernetes/app.rb

@@ -22,7 +22,7 @@ module Puma
           case req.path_info
           when ::Kubernetes::Health::Config.route_liveness
             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
+            http_code = i_am_live ? 200 : 503
           when ::Kubernetes::Health::Config.route_readiness
             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
@@ -54,11 +54,13 @@ module Puma
       end
 
       def generate_extended_puma_stats
-        return {} if @launcher.nil?
-
-        puma_stats = @launcher.stats
+        begin
+          puma_stats = @launcher.stats
+        rescue NoMethodError
+          puma_stats = {}
+        end
         # On puma <= 4 puma_stats is a String
-        puma_stats = JSON.parse(puma_stats, symbolize_names: true) unless puma_stats.is_a?(Hash)
+        puma_stats = JSON.parse(puma_stats, symbolize_names: true) if puma_stats.is_a?(String)
         # 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) if puma_stats[:pool_capacity].present?
@@ -87,6 +89,8 @@ module Puma
       end
 
       def puma_already_started?(extended_puma_stats)
+        return false if extended_puma_stats.empty?
+
         if extended_puma_stats[:booted_workers].present?
           # Cluster Mode
           extended_puma_stats[:booted_workers].positive?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-health
 version: !ruby/object:Gem::Version
-  version: 3.12.0
+  version: 3.12.4
 platform: ruby
 authors:
 - Wagner Caixeta
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-28 00:00:00.000000000 Z
+date: 2024-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler