kubernetes-health 3.11.0 → 3.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 588adb5d1b5a937a87c4c71f9b98902faee308d64b679df40784bbf66a7a8cc1
-  data.tar.gz: ebecbf287f66d584e48b22cbf038dd042cb32bfc7dde3be298c9cc87766ed0fe
+  metadata.gz: 3f1527d74312ef1d4c77095b8ee8c87f65dee6308e6340a697cee5bcedfe40f2
+  data.tar.gz: 1671089c58d3f7ba73e015a830e2622b324216a21ef25e9a7dc86d1b21527aa5
 SHA512:
-  metadata.gz: cd730152d639adbf4402234873b77c00573a61c4c56c8d8ccfd2868518bba40fb3fa0fd7245e38543b52bed32c92647ce4d875af16d9af08bd2f93ae2ee92a4a
-  data.tar.gz: 9862d03e7c574cdb148473f47ce872f8a83c072fd28f49e7e0fec1c8e4ccd073edfaf1eb4d0b77077299e79ed2f6a56105c7189cc6fdea1f99543062b5886dc5
+  metadata.gz: a4b6ad22f24f40d719ab62cf1b14d45c9e4030d899a0370e774d5deface1ebfebfe13feea5047b4c12de09cdf3b4421f05f58165bd086dbc8755f941755c3459
+  data.tar.gz: e35f96cbfc2a13a5c49ce2d6e98d1e9c51bdb660e81ce3990d0481a2d7e3a7793dcf349579b1994555d255e22d7f0d63b54f08194bec8d518f662090a26924f1

data/README.md

@@ -1,13 +1,13 @@
 # Kubernetes::Health
-This gem open a HTTP port for monitoring your rails app while it is running Migrates, Sidekiq and Puma.
+This gem opens a dedicated HTTP port to allow Kubernetes to monitor your Rails app while it is running migrations, Rake tasks, Sidekiq, or Puma.
 
 # Features
 - Puma and Sidekiq metrics for autoscaling.
-- Prometheus and JSON metrics (tested using https://github.com/zalando-incubator/kube-metrics-adapter and JSON format).
+- Prometheus and JSON metrics.
 - add routes `/_readiness`, `/_liveness` on Rails Stack.
 - add routes `/_readiness`, `/_liveness` and `/_metrics` as a puma plugin at another port to avoid problems when your app get busy. (code copied from `puma-metrics` gem).
 - add routes `/_readiness` and `/_liveness` while `rake db:migrate` runs. (optional)
-- add routes `/_readiness` and `/_liveness` while `sidekiq` runs. (optional)
+- add routes `/_metrics` while `sidekiq` runs. (optional)
 - add support to avoid parallel running of `rake db:migrate` while keep kubernetes waiting (PostgreSQL required).
 - allow custom checks for `/_readiness` and `/_liveness`.
  
@@ -50,7 +50,7 @@ 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 monitoring while `rake db:migrate` runs
+## Enabling liveness/readiness routes while `rake db:migrate` runs
 
 Your Dockerfile's entry script needs to run migrates before start your web app.
 
@@ -64,7 +64,26 @@ Kubernetes::Health::Config.enable_rack_on_migrate = true
 ```
 The defined port at `config/puma.rb` will be used but can be overrided by `KUBERNETES_HEALTH_METRICS_PORT` env var.
 
-## Enabling monitoring for `sidekiq`
+## Enabling liveness/readiness routes while any `rake` tasks runs
+
+If you need to run another rake tasks than `db:migrate`, like `assets:precompile`, you can enable the monitoring routes by this way:
+
+Add a `rake` file enhancing the original task by using `kubernetes_health:rack_on_rake` task. For example:
+
+```
+# File: lib/tasks/kubernetes_health_enable_rack_on_assets_precompile.rake
+Rake::Task['assets:precompile'].enhance(['kubernetes_health:rack_on_rake'])
+```
+
+```
+# File: lib/tasks/kubernetes_health_enable_rack_on_assets_clobber.rake
+Rake::Task['assets:clobber'].enhance(['kubernetes_health:rack_on_rake'])
+```
+
+I do recommend doing some checks to make it only enabled in the K8S environment.
+The defined port at `config/puma.rb` will be used but can be overrided by `KUBERNETES_HEALTH_METRICS_PORT` env var.
+
+## Enabling liveness/readiness routes for `sidekiq`
 
 Add `KUBERNETES_HEALTH_ENABLE_RACK_ON_SIDEKIQ=true` environment variable.
 
@@ -76,11 +95,12 @@ Kubernetes::Health::Config.enable_rack_on_sidekiq = true
 ```
 The defined port at `config/puma.rb` will be used but can be overrided by `KUBERNETES_HEALTH_METRICS_PORT` env var.
 
-### How `rake db:migrate` and `sidekiq` monitoring works
-It will run a RACK server for `/_readiness`, `/_liveness` and `/_metrics`.
+### How `rake` and `sidekiq` monitoring works
+It will run a rack server for `/_readiness`, `/_liveness` and `/_metrics` for rake and `/_metrics` for Sidekiq.
+The liveness route will respond using `200` but readiness `503`.
 
 ## 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.
+Rails already avoid migrations running in parallel, but it raises 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.
 
 
@@ -97,7 +117,7 @@ Kubernetes::Health::Config.enable_lock_on_migrate = true
 By default it is working for PostgreSQL, but you can customize it using a lambda:
 ```
 Kubernetes::Health::Config.lock_or_wait = lambda {
-    ActiveRecord::Base.connection.execute 'select pg_advisory_lock(123456789123456789);'
+  ActiveRecord::Base.connection.execute "SET lock_timeout TO '3600s'; SELECT pg_advisory_lock(123456789123456789);"
 }
 
 Kubernetes::Health::Config.unlock = lambda {

data/lib/kubernetes/health/config.rb

@@ -17,7 +17,7 @@ module Kubernetes
         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);' }
+      @@lock_or_wait = lambda { ActiveRecord::Base.connection.execute "SET lock_timeout TO '3600s'; SELECT pg_advisory_lock(123456789123456789);" }
       @@unlock = lambda { ActiveRecord::Base.connection.execute 'select pg_advisory_unlock(123456789123456789);' }
 
       def self.lock_or_wait

data/lib/kubernetes/health/{lock_on_migrate.rake → lock_on_rake.rake}

@@ -1,5 +1,5 @@
 namespace :kubernetes_health do
-  task :lock_on_migrate do
+  task :lock_on_rake do
     Rails.logger.info "Kubernetes Health: Lock on Migrate - Locking or waiting started."
     Kubernetes::Health::Config.lock_or_wait.call
     Rails.logger.info "Kubernetes Health: Lock on Migrate - Locking or waiting finished."
@@ -9,5 +9,4 @@ namespace :kubernetes_health do
       Rails.logger.info "Kubernetes Health: Lock on Migrate - Unlocking finished."
     }
   end
-end
-Rake::Task['db:migrate'].enhance(['kubernetes_health:lock_on_migrate'])
+end

data/lib/kubernetes/health/rack_on_rake.rake

@@ -0,0 +1,10 @@
+require 'rack'
+require "kubernetes/health/rack_on_rake"
+
+namespace :kubernetes_health do
+  task :rack_on_rake do
+    Thread.new do
+      Rack::Handler::WEBrick.run Kubernetes::Health::RackOnRake.new, { Port: Kubernetes::Health::Config.metrics_port }
+    end
+  end
+end

data/lib/kubernetes/health/{rack_on_migrate.rb → rack_on_rake.rb}

@@ -1,6 +1,6 @@
 module Kubernetes
   module Health
-    class RackOnMigrate
+    class RackOnRake
       def call(env)
         req = ::Rack::Request.new(env)
         case req.path_info

data/lib/kubernetes/health/railtie.rb

@@ -2,8 +2,10 @@ module Kubernetes
   module Health
     class Railtie < Rails::Railtie
       rake_tasks do
-        load 'kubernetes/health/rack_on_migrate.rake' if Kubernetes::Health::Config.enable_rack_on_migrate
-        load 'kubernetes/health/lock_on_migrate.rake' if Kubernetes::Health::Config.enable_lock_on_migrate
+        load 'kubernetes/health/rack_on_rake.rake'
+        load 'kubernetes/health/lock_on_rake.rake'
+        Rake::Task['db:migrate'].enhance(['kubernetes_health:rack_on_rake']) if Kubernetes::Health::Config.enable_rack_on_migrate
+        Rake::Task['db:migrate'].enhance(['kubernetes_health:lock_on_rake']) if Kubernetes::Health::Config.enable_lock_on_migrate
       end
     end
   end

data/lib/kubernetes/health/version.rb

@@ -1,5 +1,5 @@
 module Kubernetes
   module Health
-    VERSION = '3.11.0'.freeze
+    VERSION = '3.12.1'.freeze
   end
 end

data/lib/puma/kubernetes/app.rb

@@ -22,7 +22,7 @@ module Puma
           case req.path_info
           when ::Kubernetes::Health::Config.route_liveness
             i_am_live = ::Kubernetes::Health::Config.live_if.arity.zero? ? ::Kubernetes::Health::Config.live_if.call : ::Kubernetes::Health::Config.live_if.call(req.params)
-            http_code = puma_already_started?(extended_puma_stats) && i_am_live ? 200 : 503
+            http_code = i_am_live ? 200 : 503
           when ::Kubernetes::Health::Config.route_readiness
             i_am_ready = ::Kubernetes::Health::Config.ready_if.arity.zero? ? ::Kubernetes::Health::Config.ready_if.call : ::Kubernetes::Health::Config.ready_if.call(req.params)
             http_code = puma_already_started?(extended_puma_stats) && i_am_ready ? 200 : 503

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-health
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 3.12.1
 platform: ruby
 authors:
 - Wagner Caixeta
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-21 00:00:00.000000000 Z
+date: 2024-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,9 +140,9 @@ files:
 - lib/kubernetes/health.rb
 - lib/kubernetes/health/config.rb
 - lib/kubernetes/health/engine.rb
-- lib/kubernetes/health/lock_on_migrate.rake
-- lib/kubernetes/health/rack_on_migrate.rake
-- lib/kubernetes/health/rack_on_migrate.rb
+- lib/kubernetes/health/lock_on_rake.rake
+- lib/kubernetes/health/rack_on_rake.rake
+- lib/kubernetes/health/rack_on_rake.rb
 - lib/kubernetes/health/rack_on_sidekiq.rb
 - lib/kubernetes/health/railtie.rb
 - lib/kubernetes/health/sidekiq_options_resolver.rb

data/lib/kubernetes/health/rack_on_migrate.rake

@@ -1,11 +0,0 @@
-require 'rack'
-require "kubernetes/health/rack_on_migrate"
-
-namespace :kubernetes_health do
-  task :rack_on_migrate do
-    Thread.new do
-      Rack::Handler::WEBrick.run Kubernetes::Health::RackOnMigrate.new, { Port: Kubernetes::Health::Config.metrics_port }
-    end
-  end
-end
-Rake::Task['db:migrate'].enhance(['kubernetes_health:rack_on_migrate'])