kubernetes-health 3.10.1 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b3784236c03b3d08c9509f94da9e16cb0fb29f642f678684b20ef03d0b56a23
-  data.tar.gz: 3dd137f774090002773184febbd91ee0a520e4cd76cb414f74b113f96fe19473
+  metadata.gz: 9db3c40048a1127229efee6653df4da36ef6d38ef1b57ab51677073fecdede0d
+  data.tar.gz: 12402ee8b8e151cb4c5992d63fc37607f6ae7ae070e6e8fb57862825ec0b7146
 SHA512:
-  metadata.gz: b49429f971fad38a11dc3a65cca1553b8e7bc7463f2ca24b3a85d31d59e95506fcf79f6fbbe17cf2efade3e234b29556839171b0a5fec0791adb0456fcb313bc
-  data.tar.gz: 5d1f22d376003de55156937fb7449ae2f233a5c8f4a0ff1956c72f0f41cd773101ffb1b335d1ba1c33c1ea4d88186e7089c5589428a2ee3c0ebfc3345bee14ef
+  metadata.gz: 598d564124cc3ff32b959538f4e3d9d9863c058ece7eadc9dd37fccfbdd4fe1010b503382a24d319d690c87a12bf3a81f8b1c7717ddb3ae954d7c9f242a7db0b
+  data.tar.gz: 8c8bd4f687f964583cb2390bd7c43f141173bb8273a47fed82269e4829a36c43a92bcfa681e5c13e104be2488c905f65361714e1ca4e46e6e38a89406e2e210d

data/README.md

@@ -16,7 +16,7 @@ This gem open a HTTP port for monitoring your rails app while it is running Migr
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'kubernetes-health', '~> 3.6'
+gem 'kubernetes-health', '~> 3.7'
 ```
 
 ## Enabling puma plugin
@@ -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.
 
@@ -62,9 +62,28 @@ or add in your `application.rb`.
 # default: false
 Kubernetes::Health::Config.enable_rack_on_migrate = true
 ```
-The defined port at `config/puma.rb` will be used.
+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 recomend doing some check to make it only enables in 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.
 
@@ -74,10 +93,11 @@ or add in your `application.rb`.
 # default: false
 Kubernetes::Health::Config.enable_rack_on_sidekiq = true
 ```
-The defined port at `config/puma.rb` will be used.
+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
+### How `rake` and `sidekiq` monitoring works
 It will run a RACK server for `/_readiness`, `/_liveness` and `/_metrics`.
+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.
@@ -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/config/initializers/enable_rack_on_sidekiq.rb

@@ -2,6 +2,6 @@ require 'kubernetes/health/rack_on_sidekiq'
 
 if Kubernetes::Health::Config.enable_rack_on_sidekiq && Kubernetes::Health::SidekiqOptionsResolver[:concurrency].positive?
   Thread.new do
-    Rack::Handler.default.run Kubernetes::Health::RackOnSidekiq.new
+    Rack::Handler::WEBrick.run Kubernetes::Health::RackOnSidekiq.new, { Port:  Kubernetes::Health::Config.metrics_port }
   end
 end

data/lib/kubernetes/health/config.rb

@@ -1,8 +1,10 @@
 module Kubernetes
   module Health
     class Config
+      METRICS_PORT_FROM_PUMA_CONFIG = File.read(File.join(Rails.root, 'config', 'puma.rb')).match(/kubernetes_url\s.+:(?<metrics_port>\d+)/)['metrics_port'] rescue nil
       @@live_if = lambda { true }
       @@ready_if = lambda { true }
+      @@metrics_port = ENV['KUBERNETES_HEALTH_METRICS_PORT'] || METRICS_PORT_FROM_PUMA_CONFIG || 9393
       @@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']
@@ -15,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
@@ -113,6 +115,14 @@ module Kubernetes
       def self.response_format=(value)
         @@response_format = value
       end
+
+      def self.metrics_port
+        @@metrics_port
+      end
+
+      def self.metrics_port=(value)
+        @@metrics_port = value
+      end
     end
   end
 end

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
@@ -11,7 +11,7 @@ module Kubernetes
         else
           http_code = 404
         end
-        ::Kubernetes::Health::Config.request_log_callback.call(req, http_code)
+        ::Kubernetes::Health::Config.request_log_callback.call(req, http_code, '')
         [http_code, {}, []]
       end
     end

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.10.1'.freeze
+    VERSION = '3.12.0'.freeze
   end
 end

data/lib/puma/kubernetes/app.rb

@@ -54,7 +54,9 @@ module Puma
       end
 
       def generate_extended_puma_stats
-        puma_stats = @launcher&.stats || {}
+        return {} if @launcher.nil?
+
+        puma_stats = @launcher.stats
         # On puma <= 4 puma_stats is a String
         puma_stats = JSON.parse(puma_stats, symbolize_names: true) unless puma_stats.is_a?(Hash)
         # Including usage stats.

data/lib/puma/plugin/kubernetes.rb

@@ -3,7 +3,7 @@ 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'
+    str = launcher.options[:kubernetes_url] || "tcp://0.0.0.0:#{Kubernetes::Health::Config.metrics_port}"
 
     require 'puma/kubernetes/app'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-health
 version: !ruby/object:Gem::Version
-  version: 3.10.1
+  version: 3.12.0
 platform: ruby
 authors:
 - Wagner Caixeta
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-19 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.default.run Kubernetes::Health::RackOnMigrate.new
-    end
-  end
-end
-Rake::Task['db:migrate'].enhance(['kubernetes_health:rack_on_migrate'])