kubernetes-health 3.8.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adaef68a4c3f4b6e2dcb2b3c7aa5f8c4e72544b22edb147e35e2f72c3e8c6da4
-  data.tar.gz: 52f4cf9f5aabdf55ad239ff23fab548e3d2e883c674b7a68bef0848699774078
+  metadata.gz: f3ad95fa7855c4e929a649861a3b8e76c4c5178d4f0a9d15d4f59dbecd412d05
+  data.tar.gz: 8ddc6657bc1625af9a8397717a5c624363117396aa9f356d686d020753925a29
 SHA512:
-  metadata.gz: ee8c2fc80a2e8635a573beb6e8298a9756aaf292c0deb658797d77cc3a3337c7e9bfd83d00409068574b538156c2836d1fc5b2c6a41e5984d759864e05850595
-  data.tar.gz: 99855e3a23eb0c0f3fe90957c4d106bfebdd09c0e4434a1550907b300640ba4a7ed70c3ec8a845ca1aa2e2fc9f801a2ec811e000024544587d955dfbd945d469
+  metadata.gz: 0b50588ad78d95dc0bb29ca932062eaf30ed6fdc5174e6e5a1c158d8c97494315ecde1bc1a67ebf4b53cb769dbabdbf8e8e998a78592a62a41cd108f36ee5f79
+  data.tar.gz: 707b24d2add09186c55db3899765b3ef560c55d8941785ea6b0a727189305dfe178885839f14ce498da1fa070fff67a38c8f42e925c7f927cb2193483c616815

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 'prometheus-client', '>= 1.0', '< 5'
   spec.add_runtime_dependency 'puma', '>= 5.0'
 end

data/lib/kubernetes/health/config.rb

@@ -6,10 +6,10 @@ 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 - Request: Path: #{req.path_info} / Params: #{req.params} /  HTTP Code: #{http_code}\n#{content}"  rescue nil

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,13 @@
+module Kubernetes
+  module Health
+    class SidekiqOptionsResolver
+      def self.[](key)
+        return Sidekiq[key] if Sidekiq.respond_to?('[]')
+        return Sidekiq.options[key] if Sidekiq.respond_to?('options') # Sidekiq ~> 6.0
+        return Sidekiq::Config.new[key] if defined?(Sidekiq::Config) # Sidekiq ~> 7.0
+
+        raise 'Sidekiq version not supported'
+      end
+    end
+  end
+end

data/lib/kubernetes/health/version.rb

@@ -1,5 +1,5 @@
 module Kubernetes
   module Health
-    VERSION = '3.8.0'.freeze
+    VERSION = '3.10.0'.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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-health
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 3.10.0
 platform: ruby
 authors:
 - Wagner Caixeta
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-03 00:00:00.000000000 Z
+date: 2023-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,16 +84,22 @@ 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
@@ -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