kubernetes-health 3.1.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e427d7c50b8d63641547d488f86ea2d0e1d8ef3bb2203e6038c7e72fdbaf9983
-  data.tar.gz: 4b3d7dc8dcf097ec2bb26c416261271dbe2d438cc4d05988eaf960b824b1fb9f
+  metadata.gz: b50f5907432e2efafb49e0541ff792e1bfb086e0b5ced6f2c21308a20cf5e1e0
+  data.tar.gz: 2ca4a7a600c71caf1704272c95bbb7d2c354d0bdd32e1eee778f10b39043ea90
 SHA512:
-  metadata.gz: 135d139da735b92862dda7579219f8e7e9b6faca03a537792a187fc43ac1f5ef200e86b95abf62495d515ed036a7a23f811229660f5d781651d13c5bc38d2c41
-  data.tar.gz: fe05142bde12ed043ecf91fc776f213272e5fa8ee0e261dbcf9702d82db674964ddb58130aaf8a6fc4a6e8cb6a03f3da2999347635ea10670d10dccf608d751a
+  metadata.gz: d633dc94b6e18c839cdb0658efc6fbcb3d924b73dc8fb23a14bdb4b6babcdd856d5ee6f0eccd2cd4bae24272b97678d5fab4fee4154493c1a11a196a37532a57
+  data.tar.gz: c49e6472031a756436d3f17d6c3b1f2a736c3dcbdd1c63c13c0f980e200eff31d217bb44d48f8901eaecc90d75daef74c9a2261c0816e245977afa2755dd4c64

data/README.md

@@ -1,11 +1,11 @@
 # Kubernetes::Health
 
-This gem allows kubernetes monitoring your app while it is running migrates and after it started.
+This gem allows kubernetes monitoring your app while it is running migrates and after it starts.
 
 # 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).
+- metrics are prometheus compatible (code copied from `puma-metrics` gem) or json.
 - allow custom checks for `/_readiness` and `/_liveness`.
 - 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)
@@ -15,7 +15,7 @@ This gem allows kubernetes monitoring your app while it is running migrates and
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'kubernetes-health', '~> 3.0'
+gem 'kubernetes-health', '~> 3.4'
 ```
 
 ## Enabling puma plugin
@@ -48,18 +48,6 @@ 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 prometheus metrics
-
-```
-  template:
-    metadata:
-      annotations:
-        prometheus.io/path: '/_metrics'
-        prometheus.io/port: '9393'
-        prometheus.io/scrape: 'true'
-```
-
 ## Enabling monitoring while `rake db:migrate` runs
 
 Your Dockerfile's entry script needs to run migrates before start your web app.
@@ -106,18 +94,19 @@ Kubernetes::Health::Config.unlock = lambda {
 
 It only works for routes in rails stack, they are not executed while `rake db:migrate` runs.
 
-I prefer do nothing else on `liveness` to avoid unnecessary `CrashLoopBackOff` status. `params` is optional.
+I prefer do nothing else on `liveness` to avoid unnecessary `CrashLoopBackOff` status. `params` is optional (request params).
 
 ```
-Kubernetes::Health::Config.live_if = lambda {
+Kubernetes::Health::Config.live_if = lambda { |params|
   true
 }
 
 ```
-Ex. Check if PostgreSQL is reachable on `readiness`. `params` is optional.
+Ex. Check if PostgreSQL is reachable on `readiness` indicating that credentials are setup right and keeps cache to avoid doing it a lot. `params` is optional (request params).
 ```
 Kubernetes::Health::Config.ready_if = lambda { |params|
-  ActiveRecord::Base.connection.execute("SELECT 1").cmd_tuples != 1
+  return $kubernetes_health_test_db_connection if $kubernetes_health_test_db_connection
+  $kubernetes_health_test_db_connection = ActiveRecord::Base.connection.execute("SELECT 1").cmd_tuples == 1
 }
 ```
 
@@ -127,3 +116,19 @@ Kubernetes::Health::Config.route_liveness = '/liveness'
 Kubernetes::Health::Config.route_readiness = '/readiness'
 Kubernetes::Health::Config.route_metrics = '/metrics'
 ```
+
+## Response format
+If you are using `https://github.com/zalando-incubator/kube-metrics-adapter` you will want to use `json` format.
+
+Default is `prometheus`.
+```
+Kubernetes::Health::Config.response_format = 'json'
+```
+
+## Customizing requests logs
+
+```
+Kubernetes::Health::Config.request_log_callback = lambda { |req, http_code|
+  Rails.logger.debug "Kubernetes Health: Rack on Migrate - Request: Path: #{req.path_info} / Params: #{req.params} /  HTTP Code: #{http_code}"  rescue nil
+}
+```

data/kubernetes-health.gemspec

@@ -26,9 +26,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
   spec.add_dependency "rack"
   spec.add_dependency "rails"
   spec.add_runtime_dependency 'prometheus-client', '~> 0.9.0'

data/lib/kubernetes/health/config.rb

@@ -8,6 +8,12 @@ module Kubernetes
       @@route_liveness = '/_liveness'
       @@route_readiness = '/_readiness'
       @@route_metrics = '/_metrics'
+      @@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
+      }
+
       @@lock_or_wait = lambda { ActiveRecord::Base.connection.execute 'select pg_advisory_lock(123456789123456789);' }
       @@unlock = lambda { ActiveRecord::Base.connection.execute 'select pg_advisory_unlock(123456789123456789);' }
 
@@ -19,6 +25,14 @@ module Kubernetes
         @@lock_or_wait = value
       end
 
+      def self.request_log_callback
+        @@request_log_callback
+      end
+
+      def self.request_log_callback=(value)
+        @@request_log_callback = value
+      end
+
       def self.unlock
         @@unlock
       end
@@ -83,6 +97,13 @@ module Kubernetes
         @@ready_if = value
       end
 
+      def self.response_format
+        @@response_format
+      end
+
+      def self.response_format=(value)
+        @@response_format = value
+      end
     end
   end
 end

data/lib/kubernetes/health/rack_on_migrate.rb

@@ -11,7 +11,7 @@ module Kubernetes
         else
           http_code = 404
         end
-        Rails.logger.debug "Kubernetes Health: Rack on Migrate - Request: Path: #{req.path_info} / Params: #{req.params} /  HTTP Code: #{http_code}"
+        ::Kubernetes::Health::Config.request_log_callback.call(req, http_code)
         [http_code, {}, []]
       end
     end

data/lib/kubernetes/health/version.rb

@@ -1,5 +1,5 @@
 module Kubernetes
   module Health
-    VERSION = "3.1.0"
+    VERSION = "3.4.0"
   end
 end

data/lib/puma/kubernetes/app.rb

@@ -13,26 +13,47 @@ module Puma
       end
 
       def call(_env)
-        req = ::Rack::Request.new(_env)
-        type = {}
-        content = []
-        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
-        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
-        when ::Kubernetes::Health::Config.route_metrics
-          http_code = 200
-          @parser.parse JSON.parse(@launcher.stats)
-          type = { 'Content-Type' => 'text/plain' }
-          content = [Prometheus::Client::Formats::Text.marshal(Prometheus::Client.registry)]
-        else
-          http_code = 404
+        begin
+          req = ::Rack::Request.new(_env)
+          type = {}
+          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_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
+          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
+          when ::Kubernetes::Health::Config.route_metrics
+            http_code = 200
+            if ::Kubernetes::Health::Config.response_format == 'json'
+              content = include_puma_key_prefix(include_usage(JSON.parse(@launcher.stats))).to_json
+            else
+              @parser.parse include_usage(JSON.parse(@launcher.stats))
+              content = Prometheus::Client::Formats::Text.marshal(Prometheus::Client.registry)
+            end
+          else
+            http_code = 404
+          end
+        rescue
+          http_code = 500
+          content = []
         end
-        Rails.logger.debug "Kubernetes Health: Puma Plugin - Request: Path: #{req.path_info} / Params: #{req.params} /  HTTP Code: #{http_code}" rescue nil
-        [http_code, type, content]
+        ::Kubernetes::Health::Config.request_log_callback.call(req, http_code, content)
+        [http_code, type, [content]]
+      end
+
+      def include_usage(stats)
+        stats['usage'] = (1 - stats['pool_capacity'].to_f / stats['max_threads']).round(2)
+        stats
+      end
+      def include_puma_key_prefix(stats)
+        result = {}
+        stats.each do |k,v|
+          result["puma_#{k}"] = v
+        end
+        result
       end
     end
   end

data/lib/puma/kubernetes/parser.rb

@@ -29,6 +29,7 @@ module Puma
         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)
       end
 
       def registry

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-health
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Wagner Caixeta
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-12-11 00:00:00.000000000 Z
+date: 2021-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -145,7 +145,7 @@ files:
 homepage: https://github.com/platbr/kubernetes-health
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,8 +160,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.17
+signing_key:
 specification_version: 4
 summary: This gem allows kubernetes monitoring your app while it is running migrates
   and after it started.