kubernetes-health 2.2.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4425830e42d12960033f406ddb4e3da9d33e7d4f2836362cfad272b2aefa7aee
-  data.tar.gz: 72ea97e57b9100f0e465abf1e1e17168a8706f8eeb85f9d14b3e4f5d5660d6ed
+  metadata.gz: e7237a6079afe249dc00d6f75a99b30c6ed594cc090f25d43b9677a63aee28f3
+  data.tar.gz: ec385cbc59cb999647c85d5ac1813585a55ffa283b9922f32dc2eceb55313d7d
 SHA512:
-  metadata.gz: 779947240739615102d287539e8f9542c1e73c2af1c5cc4d2d11d2760c866b5b6669d4482a881518844d028be4e53e930549d80b41bbfb6af3136ea6207ad84f
-  data.tar.gz: 16127f3a04957449a1c731ff2649e5b480b88486c1d2d94d572c80c162cfdd802e05c8db36a722b7435624d4b604d5d4deae151281702468182cc3a2b95390ed
+  metadata.gz: be3c95a034f79708968f24808656961f611819e6d559d6f24549fb497e99224d94369787911467886ca1f0ae2b5d2040ec42acd8b6b735d8b80bad5c1a790b02
+  data.tar.gz: 85cbe5b9902df2cbfa154fb642f3878fcd203ad1e6a3da05adb78c4f50974ebbc3844fe6018e5aae8115f281c0dbc92ccee5e134fd332096e49756ed7486c503

data/README.md

@@ -3,8 +3,10 @@
 This gem allows kubernetes monitoring your app while it is running migrates and after it started.
 
 # Features
-- add routes `/_readiness` and `/_liveness` on rails stack by default.
-- allow custom checks for `/_readiness` and `/_liveness` on rails stack.
+- 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).
+- 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)
 
@@ -13,7 +15,49 @@ 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', '~> 2.1'
+gem 'kubernetes-health', '~> 3.0'
+```
+
+## Enabling puma plugin
+
+add in `config/puma.rb`
+```
+plugin 'kubernetes'
+kubernetes_url 'tcp://0.0.0.0:9393'
+```
+
+In Kubernetes you need to configure your deployment `readinessProbe` and `livenessProbe` like this:
+
+```
+        livenessProbe:
+          httpGet:
+            path: /_liveness
+            port: 9393
+          initialDelaySeconds: 30
+          timeoutSeconds: 5
+          failureThreshold: 3
+          successThreshold: 1
+        readinessProbe:
+          httpGet:
+            path: /_readiness
+            port: 9393
+          initialDelaySeconds: 30
+          timeoutSeconds: 5
+          failureThreshold: 3
+          successThreshold: 1
+```
+
+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
@@ -29,27 +73,13 @@ or add in your `application.rb`.
 Kubernetes::Health::Config.enable_rack_on_migrate = true
 ```
 
-In Kubernetes you need to configure your deployment `readinessProbe` like this:
-
-```
-    livenessProbe:
-        httpGet:
-        path: /_liveness
-        port: 80
-        initialDelaySeconds: 10
-        timeoutSeconds: 5
-    readinessProbe:
-        httpGet:
-        path: /_readiness
-        port: 80
-        initialDelaySeconds: 10
-        timeoutSeconds: 5
-```
-
 ### How `rake db:migrate` monitoring works
 It will run a RACK server for `/_readiness` and `/_liveness` routes while `rake db:migrate` is running.
 
-## Avoid `rake db:migrate` parallel running.
+## Avoiding migrations running in parallel and making kubernetes happy.
+Rails already avoid migrations running in parallel, but it raise exceptions. This gem will just wait for other migrations without exit.
+If you enable `rack_on_migrate` together with this, kubernetes will just wait, avoiding erros.
+
 
 Add `KUBERNETES_HEALTH_ENABLE_LOCK_ON_MIGRATE=true` environment variable.
 
@@ -76,22 +106,24 @@ Kubernetes::Health::Config.unlock = lambda {
 
 It only works for routes in rails stack, they are not executed while `rake db:migrate` runs.
 
-Ex. Check if PostgreSQL is reachable. `params` is optional.
+I prefer do nothing else on `liveness` to avoid unnecessary `CrashLoopBackOff` status. `params` is optional.
 
 ```
-Kubernetes::Health::Config.ready_if = lambda { |params|
-    ActiveRecord::Base.connection.execute("SELECT 1").cmd_tuples != 1
+Kubernetes::Health::Config.live_if = lambda {
+  true
 }
-```
 
 ```
-Kubernetes::Health::Config.live_if = lambda { |params|
-    ActiveRecord::Base.connection.execute("SELECT 1").cmd_tuples != 1
+Ex. Check if PostgreSQL is reachable on `readiness`. `params` is optional.
+```
+Kubernetes::Health::Config.ready_if = lambda { |params|
+  ActiveRecord::Base.connection.execute("SELECT 1").cmd_tuples != 1
 }
 ```
 
 ## Customizing routes
 ```
 Kubernetes::Health::Config.route_liveness = '/liveness'
-Kubernetes::Health::Config.route_readiness = '/readiness
+Kubernetes::Health::Config.route_readiness = '/readiness'
+Kubernetes::Health::Config.route_metrics = '/metrics'
 ```

data/Rakefile

@@ -1,6 +1,32 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+task :default => :spec
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
-RSpec::Core::RakeTask.new(:spec)
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
 
-task :default => :spec
+task :server do
+  require 'puma'
+  require 'puma/configuration'
+  require 'puma/events'
+  require 'puma/plugin/kubernetes.rb'
+
+  configuration = Puma::Configuration.new do |config|
+    config.bind 'tcp://127.0.0.1:0'
+    config.kubernetes_url 'tcp://127.0.0.1:9494'
+    config.plugin 'kubernetes'
+    config.workers 1
+    config.app do |_env|
+      [200, {}, ['hello world']]
+    end
+  end
+
+  events = Puma::Events.new STDOUT, STDERR
+  launcher = Puma::Launcher.new(configuration, events: events)
+  launcher.run
+end
+
+task default: :test

data/kubernetes-health.gemspec

@@ -31,4 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_dependency "rack"
   spec.add_dependency "rails"
+  spec.add_runtime_dependency 'prometheus-client', '~> 0.8'
+  spec.add_runtime_dependency 'puma', '~> 3.0'
 end

data/lib/kubernetes/health/config.rb

@@ -3,10 +3,11 @@ module Kubernetes
     class Config
       @@live_if = lambda { true }
       @@ready_if = lambda { true }
-      @@enable_lock_on_migrate = ActiveRecord::Type::Boolean.new.cast(ENV['KUBERNETES_HEALTH_ENABLE_LOCK_ON_MIGRATE']) || false
-      @@enable_rack_on_migrate = ActiveRecord::Type::Boolean.new.cast(ENV['KUBERNETES_HEALTH_ENABLE_RACK_ON_MIGRATE']) || false
+      @@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']
       @@route_liveness = '/_liveness'
       @@route_readiness = '/_readiness'
+      @@route_metrics = '/_metrics'
       @@lock_or_wait = lambda { ActiveRecord::Base.connection.execute 'select pg_advisory_lock(123456789123456789);' }
       @@unlock = lambda { ActiveRecord::Base.connection.execute 'select pg_advisory_unlock(123456789123456789);' }
 
@@ -42,6 +43,14 @@ module Kubernetes
         @@enable_rack_on_migrate = value
       end
 
+      def self.route_metrics
+        @@route_metrics
+      end
+
+      def self.route_metrics=(value)
+        @@route_metrics = value
+      end
+
       def self.route_liveness
         @@route_liveness
       end

data/lib/kubernetes/health/rack_on_migrate.rb

@@ -2,7 +2,7 @@ module Kubernetes
   module Health
     class RackOnMigrate
       def call(env)
-        req = Rack::Request.new(env)
+        req = ::Rack::Request.new(env)
         case req.path_info
         when Kubernetes::Health::Config.route_readiness
           http_code = 503

data/lib/kubernetes/health/version.rb

@@ -1,5 +1,5 @@
 module Kubernetes
   module Health
-    VERSION = "2.2.0"
+    VERSION = "3.0.2"
   end
 end

data/lib/puma/kubernetes/app.rb

@@ -0,0 +1,39 @@
+require "kubernetes/health/config"
+require 'prometheus/client/formats/text'
+require 'puma/kubernetes/parser'
+require 'rack'
+
+module Puma
+  module Kubernetes
+    class App
+      def initialize(launcher)
+        @launcher = launcher
+        clustered = (@launcher.options[:workers] || 0) > 0
+        @parser = Parser.new clustered
+      end
+
+      def call(_env)
+        req = ::Rack::Request.new(_env)
+        type = {}
+        content = []
+        case req.path_info
+        when ::Kubernetes::Health::Config.route_readiness
+          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_liveness
+          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
+        end
+        Rails.logger.info "Kubernetes Health: Rack on Migrate - Request: Path: #{req.path_info} / Params: #{req.params} /  HTTP Code: #{http_code}" rescue nil
+        [http_code, type, content]
+      end
+    end
+  end
+end

data/lib/puma/kubernetes/dsl.rb

@@ -0,0 +1,7 @@
+module Puma
+  class DSL
+    def kubernetes_url(url)
+      @options[:kubernetes_url] = url
+    end
+  end
+end

data/lib/puma/kubernetes/parser.rb

@@ -0,0 +1,45 @@
+require 'prometheus/client'
+
+module Puma
+  module Kubernetes
+    class Parser
+      def initialize(clustered = false)
+        register_default_kubernetes
+        register_clustered_kubernetes 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'
+          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)
+      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)
+      end
+
+      def registry
+        Prometheus::Client.registry
+      end
+
+      def update_metric(key, value, labels)
+        return if registry.get("puma_#{key}").nil?
+
+        registry.get("puma_#{key}").set(labels, value)
+      end
+    end
+  end
+end

data/lib/puma/plugin/kubernetes.rb

@@ -0,0 +1,34 @@
+require 'puma/kubernetes/dsl'
+
+Puma::Plugin.create do
+  # rubocop:disable Kubernetes/MethodLength, Kubernetes/AbcSize
+  def start(launcher)
+    str = launcher.options[:kubernetes_url] || 'tcp://0.0.0.0:9393'
+
+    require 'puma/kubernetes/app'
+
+    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
+
+    case uri.scheme
+    when 'tcp'
+      launcher.events.log "* Starting kubernetes-healh server on #{str}"
+      kubernetes.add_tcp_listener uri.host, uri.port
+    else
+      launcher.events.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?
+      end
+    end
+
+    kubernetes.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: 2.2.0
+  version: 3.0.2
 platform: ruby
 authors:
 - Wagner Caixeta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2019-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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
@@ -110,6 +138,10 @@ files:
 - lib/kubernetes/health/rack_on_migrate.rb
 - lib/kubernetes/health/railtie.rb
 - lib/kubernetes/health/version.rb
+- lib/puma/kubernetes/app.rb
+- lib/puma/kubernetes/dsl.rb
+- lib/puma/kubernetes/parser.rb
+- lib/puma/plugin/kubernetes.rb
 homepage: https://github.com/platbr/kubernetes-health
 licenses: []
 metadata: {}
@@ -128,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: This gem allows kubernetes monitoring your app while it is running migrates