kubernetes-health 3.6.0 → 3.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f0b091b68d3acd2e69b0e2e259ad841eef9b5030ae7f7a8a404f7d0535722c7
-  data.tar.gz: 2ab614dc570e2b8202533101566a4eb0f6aca71ad2490d27ac10d4739e9cc322
+  metadata.gz: a53b0ea476aa3faef08ebb62fd3b7e9a625881fc8177b17d612625b44a220424
+  data.tar.gz: d031a5233193abb0da1b5fd2ec00acf253e3b5ea2711ad547cbed131ac0be223
 SHA512:
-  metadata.gz: 26068d438952f640c22b9e7ce3d416aeec53fd32bec73013de08c4037ad1183619dd13cd8f23fe1561d2a57f191272a895138b9cb0279bc90fa41cba309d8d2a
-  data.tar.gz: 5c89c1531a8f10b858ba3bcd7626fe7d34fc308bde57bb0ba56fbd26e45e85b50caa72332186e4ce2e04c4e50a17c26226dabb0a7d13738eea02acdd9805491f
+  metadata.gz: cbf4b8efc0b5114eab92e2cb718e94f2f4cae89986e95f3bb8435ab4dc322401718a7d0a3398deec062e6ba5469a0bda5ad9a03f748f872707ae1baa9483a1c4
+  data.tar.gz: f4fffaa2f5a1a5eed2e5266a81361207dd4d16b8723489188ee535ad0a7e514b5c5958ccca731f27072aad7dab013a517cf228cbcfd356b8947199cf90ba9a24

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/rack_on_sidekiq.rb

@@ -13,14 +13,15 @@ module Kubernetes
         when Kubernetes::Health::Config.route_metrics
           http_code = 200
 
-          @sidekiq_metrics = sidekiq_metrics
+          sidekiq_metrics = generate_sidekiq_metrics
 
           if ::Kubernetes::Health::Config.response_format == 'json'
-            content = @sidekiq_metrics.to_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])
+            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
@@ -31,17 +32,15 @@ module Kubernetes
         [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
+      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 sidekiq_metrics
+      def generate_sidekiq_metrics
         sidekiq_info = Sidekiq::ProcessSet.new.to_a.filter { |p| p.identity == Sidekiq.options[:identity] }
 
         stats = {

data/lib/kubernetes/health/version.rb

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

data/lib/puma/kubernetes/app.rb

@@ -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.6.0
+  version: 3.7.1
 platform: ruby
 authors:
 - Wagner Caixeta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-13 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