kubernetes-health 3.7.2 → 3.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd3b71bfaba5d0455cb081dfd694554370f858167f3aeafa3e34deb66de9a7b0
-  data.tar.gz: 030dd33dda0725a7d711d808a5e776fd3cd467a610fd17d3ab47c20d9629d756
+  metadata.gz: 5153394dce8ea22cce62b0826008d9febbeb406b6385296471cb00b6e6c50c52
+  data.tar.gz: ae76165497abc6c256d4609c28f27b782fc7d69f88a93a511c94567395c2716c
 SHA512:
-  metadata.gz: ea3434326f57be5a3ebe8c40fce7865484e405862c8a81f93c49d79c0497e6d3723069de9ba2ca77f308e56f7791ff786134c458f5d8011e6cff611191cd6db8
-  data.tar.gz: bb146f7557012fb1b1bdd9ac4dcf7627f2a8385e8f86608e5905bae799f558647e66217356f73350a55b5094bdca37779617a6928f533a6ab837262b86db6c34
+  metadata.gz: 81ce8eaa10395f924d68cca575114a8e47c65f3c3c710b9a66f1801834518556dfa401f5c365586dd13a868758afdb2c83cfbd127034026cf0bf3b83eecde7ce
+  data.tar.gz: e2d8ce82aeb1fe27b7e0a76db760f24dcbf297fbb41bcbc0a4b66354bf04cb4a3e830b8409f6a9fdbd17e88fc79e1627e4b8cb06315619f84fbd2d74e53a0f89

data/README.md

@@ -131,6 +131,12 @@ Kubernetes::Health::Config.route_liveness = '/liveness'
 Kubernetes::Health::Config.route_readiness = '/readiness'
 Kubernetes::Health::Config.route_metrics = '/metrics'
 ```
+or using env
+```
+KUBERNETES_HEALTH_LIVENESS_ROUTE='/liveness'
+KUBERNETES_HEALTH_READINESS_ROUTE='/readiness'
+KUBERNETES_HEALTH_RESPONSE_FORMAT='/metrics'
+```
 
 ## Response format
 If you are using `https://github.com/zalando-incubator/kube-metrics-adapter` you will want to use `json` format.
@@ -139,6 +145,10 @@ Default is `prometheus`.
 ```
 Kubernetes::Health::Config.response_format = 'json'
 ```
+or using env
+```
+KUBERNETES_HEALTH_RESPONSE_FORMAT=json
+```
 
 ## Customizing requests logs
 

data/config/initializers/enable_rack_on_sidekiq.rb

@@ -1,6 +1,6 @@
 require 'kubernetes/health/rack_on_sidekiq'
 
-if Kubernetes::Health::Config.enable_rack_on_sidekiq && Sidekiq.options[:concurrency].positive?
+if Kubernetes::Health::Config.enable_rack_on_sidekiq && Kubernetes::Health::SidekiqOptionsResolver[:concurrency].positive?
   Thread.new do
     Rack::Handler.default.run Kubernetes::Health::RackOnSidekiq.new
   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', '~> 1.0'
-  spec.add_runtime_dependency 'puma'
+  spec.add_runtime_dependency 'prometheus-client', '>= 1.0', '< 5'
+  spec.add_runtime_dependency 'puma', '>= 5.0'
 end

data/lib/kubernetes/health/config.rb

@@ -6,13 +6,13 @@ module Kubernetes
       @@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'
-      @@response_format = 'prometheus'
+      @@route_liveness = ENV['KUBERNETES_HEALTH_LIVENESS_ROUTE']  || '/_liveness'
+      @@route_readiness = ENV['KUBERNETES_HEALTH_READINESS_ROUTE'] || '/_readiness'
+      @@route_metrics = ENV['KUBERNETES_HEALTH_METRICS_ROUTE'] || '/_metrics'
+      @@response_format = ENV['KUBERNETES_HEALTH_RESPONSE_FORMAT'] || 'prometheus'
 
       @@request_log_callback = lambda { |req, http_code, content|
-        Rails.logger.debug "Kubernetes Health: Rack on Migrate - Request: Path: #{req.path_info} / Params: #{req.params} /  HTTP Code: #{http_code}\n#{content}"  rescue nil
+        Rails.logger.debug "Kubernetes Health - Request: Path: #{req.path_info} / Params: #{req.params} /  HTTP Code: #{http_code}\n#{content}"  rescue nil
       }
 
       @@lock_or_wait = lambda { ActiveRecord::Base.connection.execute 'select pg_advisory_lock(123456789123456789);' }

data/lib/kubernetes/health/rack_on_sidekiq.rb

@@ -5,6 +5,7 @@ require 'prometheus/client/formats/text'
 module Kubernetes
   module Health
     class RackOnSidekiq
+      
       def call(env)
         req = ::Rack::Request.new(env)
         content = ''
@@ -18,10 +19,9 @@ module Kubernetes
           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])
+            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
@@ -32,25 +32,28 @@ module Kubernetes
         [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
+      def prometheus_registry
+        return @prometheus_registry unless @prometheus_registry.nil?
+
+        @prometheus_registry = Prometheus::Client.registry
+        @prometheus_registry.gauge(:sidekiq_capacity, docstring: 'Sidekiq Threads Number')
+        @prometheus_registry.gauge(:sidekiq_busy, docstring: 'Sidekiq Busy Threads')
+        @prometheus_registry.gauge(:sidekiq_usage, docstring: 'Result of sidekiq_busy/sidekiq_capacity')
+        @prometheus_registry
       end
 
       def generate_sidekiq_metrics
-        sidekiq_info = Sidekiq::ProcessSet.new.to_a.filter { |p| p.identity == Sidekiq.options[:identity] }
+        sidekiq_info = Sidekiq::ProcessSet.new.to_a.filter { |p| p.identity == SidekiqOptionsResolver[:identity] }
 
         stats = {
-          sidekiq_capacity: Sidekiq.options[:concurrency],
+          sidekiq_capacity: SidekiqOptionsResolver[: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/sidekiq_options_resolver.rb

@@ -0,0 +1,12 @@
+module Kubernetes
+  module Health
+    class SidekiqOptionsResolver
+      def self.[](key)
+        # Sidekiq >= 6.0.0
+        return Sidekiq[key] if Sidekiq.respond_to?('[]')
+
+        Sidekiq.options[key]
+      end
+    end
+  end
+end

data/lib/kubernetes/health/version.rb

@@ -1,5 +1,5 @@
 module Kubernetes
   module Health
-    VERSION = '3.7.2'.freeze
+    VERSION = '3.9.1'.freeze
   end
 end

data/lib/kubernetes/health.rb

@@ -1,4 +1,5 @@
 require "kubernetes/health/config"
+require "kubernetes/health/sidekiq_options_resolver"
 require "kubernetes/health/version"
 require "kubernetes/health/engine"
 require "kubernetes/health/railtie"

data/lib/puma/plugin/kubernetes.rb

@@ -9,26 +9,26 @@ Puma::Plugin.create do
 
     app = Puma::Kubernetes::App.new launcher
     uri = URI.parse str
-
-    kubernetes = Puma::Server.new app, launcher.events
-    kubernetes.min_threads = 0
-    kubernetes.max_threads = 1
+    log_writer = launcher.respond_to?(:log_writer) ? launcher.log_writer : launcher.events
+    puma_options = { min_threads: 0, max_threads: 1 }
+    puma_options[:log_writer] = log_writer unless log_writer.nil?
+    puma_server = Puma::Server.new app, launcher.events, puma_options
 
     case uri.scheme
     when 'tcp'
-      launcher.events.log "* Starting kubernetes-healh server on #{str}"
-      kubernetes.add_tcp_listener uri.host, uri.port
+      log_writer.log "* Starting kubernetes-healh server on #{str}"
+      puma_server.add_tcp_listener uri.host, uri.port
     else
-      launcher.events.error "Invalid control URI: #{str}"
+      log_writer.error "Invalid control URI: #{str}"
     end
 
     launcher.events.register(:state) do |state|
       if %i[halt restart stop].include?(state)
-        kubernetes.stop(true) unless kubernetes.shutting_down?
+        puma_server.stop(true) unless puma_server.shutting_down?
       end
     end
 
-    kubernetes.run
+    puma_server.run
   end
   # rubocop:enable Kubernetes/MethodLength, Kubernetes/AbcSize
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-health
 version: !ruby/object:Gem::Version
-  version: 3.7.2
+  version: 3.9.1
 platform: ruby
 authors:
 - Wagner Caixeta
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2023-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,30 +84,36 @@ dependencies:
   name: prometheus-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 description: "\n    This gem allows kubernetes monitoring your app while it is running
   migrates and after it started.\n    Features:\n    * add routes /_readiness and
   /_liveness on rails stack by default;\n    * allow custom checks for /_readiness
@@ -139,6 +145,7 @@ files:
 - lib/kubernetes/health/rack_on_migrate.rb
 - lib/kubernetes/health/rack_on_sidekiq.rb
 - lib/kubernetes/health/railtie.rb
+- lib/kubernetes/health/sidekiq_options_resolver.rb
 - lib/kubernetes/health/version.rb
 - lib/puma/kubernetes/app.rb
 - lib/puma/kubernetes/dsl.rb
@@ -147,7 +154,7 @@ files:
 homepage: https://github.com/platbr/kubernetes-health
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,8 +169,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: This gem allows kubernetes monitoring your app while it is running migrates
   and after it started.