kubernetes-health 3.2.0 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33187ecbabbca1f845ed61bd7159731e7477d113fa83f319eeeb77e715458f12
-  data.tar.gz: 40059808df7f3f1f91b94f77583ab43a8bb8a6bc41df9794f1345f45b5f4c218
+  metadata.gz: e002184325d2c508f38c8fc4c73532d748046664fcc65764e345d0119734d066
+  data.tar.gz: 85419dad18b1fe9df0d0fcdcbbf1686f0e7233497bc1685f2a1182baba7cceb8
 SHA512:
-  metadata.gz: 37f4e926a7a7d649b723c692f903b8863dc91ba8088e392ea2afeab1666fe20a43d411a56577fff4795ac1538c923cc320e1527a58cfb0da02e886dab62e9f15
-  data.tar.gz: abdc9fe6fcf8a28c508a2508d3e996887a936e125f8817e7a9756c10a24d7dac10c0d6330bb3d623325b8a940d571c37191fd3f0cbe8ccab96e5fddbc4cb5e86
+  metadata.gz: 5b3cc913270ba83fda812e464bbcd3469e6949778059e707b6de62f4b2391747ade9f957c12062c0f98c42fbd0beb421403caed4c0bd6c15acc553edb917f560
+  data.tar.gz: b147c8e17cee0c3648116ac10eb1e9e6cfa89d1f78a5d03815629d2aa0d27b8b066fb4abcf70b6ea3b0595de36828911b8959c1cf2a0bd9f3077c0f9d1d8a6af

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.2'
+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
 }
 ```
 
@@ -128,10 +117,18 @@ 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,9 +8,10 @@ module Kubernetes
       @@route_liveness = '/_liveness'
       @@route_readiness = '/_readiness'
       @@route_metrics = '/_metrics'
-      
-      @@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
+      @@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);' }
@@ -23,7 +24,7 @@ module Kubernetes
       def self.lock_or_wait=(value)
         @@lock_or_wait = value
       end
-      
+
       def self.request_log_callback
         @@request_log_callback
       end
@@ -96,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/version.rb

@@ -1,5 +1,5 @@
 module Kubernetes
   module Health
-    VERSION = "3.2.0"
+    VERSION = "3.4.1"
   end
 end

data/lib/puma/kubernetes/app.rb

@@ -16,8 +16,8 @@ module Puma
         begin
           req = ::Rack::Request.new(_env)
           type = {}
-          content = []
-          type = { 'Content-Type' => 'text/plain' }
+          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)
@@ -27,17 +27,33 @@ module Puma
             http_code = i_am_ready ? 200 : 503
           when ::Kubernetes::Health::Config.route_metrics
             http_code = 200
-            @parser.parse JSON.parse(@launcher.stats)
-            content = [Prometheus::Client::Formats::Text.marshal(Prometheus::Client.registry)]
+            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 = []
+          content = ''
         end
-        ::Kubernetes::Health::Config.request_log_callback.call(req, http_code)
-        [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.2.0
+  version: 3.4.1
 platform: ruby
 authors:
 - Wagner Caixeta
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-04 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
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.17
 signing_key:
 specification_version: 4
 summary: This gem allows kubernetes monitoring your app while it is running migrates