health-monitor-rails 12.5.0 → 12.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c16cdc04971eb81463bb19da409b3e1d41cf83683840819882ad33a6d8cdf4b0
-  data.tar.gz: 8091013b1770de119a9d9448696f97c3ec7baadafac9ce4173d6c279b65bc313
+  metadata.gz: 65ddef8cba3d98c9824273f2eb677bb4eb5797a88ea3a020d846ab9e7b170bf9
+  data.tar.gz: 30b1ff30cdc3c8c95a180701b251756514cacc4f8a6969c07dc07b21fddb538c
 SHA512:
-  metadata.gz: 2d6f3818a0dabb60c514382d32815832e94f516ccd3d76751acf90889b61e90edfcfd62b4df44e34669909ed475e2c25585b4c08b5ebc0cfebea33f8f8c965a4
-  data.tar.gz: 7f519417d7e0adee2f367f776c0d193bc44b0cb8dd48661d5e0067171618efced5e0834ba26a66b51e6b0335a9c8ee81f4d483e1d01ae51a3951a4f872200d36
+  metadata.gz: bdba690258230630638d475e00cad004127a086cf548460504864038ec1e02eeb434e083cf49e7c23ab00f08ef764e7bacee01a1beaec16d01c1486854ee6a76
+  data.tar.gz: ca61f98fca9a3adc8b89c47748d82ce7a9523842b807d757171474e73f13721d2db6085f65813b3be2829b7f1b3ff3a176020727eae4d11f5392e5e2b4b1314d

data/README.md

@@ -202,6 +202,21 @@ HealthMonitor.configure do |config|
 end
 ```
 
+When you have multiple databases and and want to check each configuration separately you can use following method:
+```ruby
+HealthMonitor.configure do |config|
+  config.no_database # Disable default all databases check
+  config.database.configure do |provider_config|
+    provider_config.config_name = 'primary'
+  end
+  config.database.configure do |provider_config|
+    provider_config.name = 'Secondary'
+    provider_config.config_name = 'secondary'
+    provider_config.critical = false
+  end
+end
+```
+
 ### Provider Configuration
 
 All providers accept a general set of baseline configuration:
@@ -216,7 +231,7 @@ end
 ```
 
 * __name__: Custom name for the provider (Defaults to __class name__. Ex: 'Redis', 'Sidekiq')
-* __critical__: Whether or not the provider is a critical dependency (Defaults to: __true__). If set to __false__, the monitor will report its status but ignore it when determining overall application health status
+* __critical__: Whether or not the provider is a critical dependency (Defaults to: __true__). If set to __false__, the monitor will report its status as `WARNING` but ignore it when determining overall application health status. This could be used to send to a non critical notifications channel
 
 > The __critical__ option allows you to monitor for additional non-critical dependencies that are not fully required for your application to be operational, like a cache database for instance
 
@@ -273,7 +288,7 @@ HealthMonitor.configure do |config|
 end
 ```
 
-For providers that can be configured with its endpoits/urls you can also add multiple declarations to ensure you are reporting across all dependencies:
+For providers that can be configured with its endpoints/urls you can also add multiple declarations to ensure you are reporting across all dependencies:
 
 ```ruby
 HealthMonitor.configure do |config|
@@ -320,9 +335,9 @@ Please note that `url` or `connection` can't be used at the same time.
 
 ### FileAbsence
 
-This check allows you to create a file on your server when you would like to force the check to fail. For example if you are utilizing the `health.json` as you health check page for your load balancer and would like to force a machine offline.
+This check allows you to create a file on your server when you would like to force the check to fail. For example, if utilizing the `health.json` as the health check page for your load balancer and would like to force a machine offline.
 
-* `filename`: the file relative to the rails root that must remain absent for the health check to remain passing. For example: `public/remove-from-nginx`
+* `filename`: the file relative to the rails root that must remain absent for the health check to remain passing. For example: `public/remove-from-nginx` (Can also be a full path `/opt/app/remove-from-nginx`)
 
 ### Adding a Custom Provider
 

data/lib/health_monitor/monitor.rb

@@ -5,6 +5,7 @@ require 'health_monitor/configuration'
 module HealthMonitor
   STATUSES = {
     ok: 'OK',
+    warning: 'WARNING',
     error: 'ERROR'
   }.freeze
 
@@ -25,10 +26,9 @@ module HealthMonitor
     end
 
     results = providers.map { |provider| provider_result(provider, request) }
-
     {
-      results: results.map { |c| c.without(:critical) },
-      status: results.any? { |res| res[:status] != STATUSES[:ok] && res[:critical] } ? :service_unavailable : :ok,
+      results: results,
+      status: results.any? { |res| res[:status] == STATUSES[:error] } ? :service_unavailable : :ok,
       timestamp: Time.now.to_formatted_s(:rfc2822)
     }
   end
@@ -43,8 +43,7 @@ module HealthMonitor
     {
       name: provider.name,
       message: '',
-      status: STATUSES[:ok],
-      critical: provider.critical
+      status: STATUSES[:ok]
     }
   rescue StandardError => e
     configuration.error_callback.try(:call, e)
@@ -52,8 +51,7 @@ module HealthMonitor
     {
       name: provider.name,
       message: e.message,
-      status: STATUSES[:error],
-      critical: provider.critical
+      status: provider.critical ? STATUSES[:error] : STATUSES[:warning]
     }
   end
 end

data/lib/health_monitor/providers/database.rb

@@ -7,23 +7,58 @@ module HealthMonitor
     class DatabaseException < StandardError; end
 
     class Database < Base
+      class Configuration < Base::Configuration
+        DEFAULT_CONFIG_NAME = nil
+
+        attr_reader :config_name
+
+        def initialize(provider)
+          super
+
+          @config_name = DEFAULT_CONFIG_NAME
+        end
+
+        def config_name=(value)
+          @config_name = value.presence&.to_s
+        end
+      end
+
       def check!
+        checked = false
         failed_databases = []
 
         ActiveRecord::Base.connection_handler.connection_pool_list(:all).each do |cp|
-          if cp.respond_to? :lease_connection
-            cp.lease_connection.execute('SELECT 1')
-          else
-            cp.connection.execute('SELECT 1')
-          end
+          next unless check_connection_pool?(cp)
+
+          checked = true
+          check_connection(cp)
         rescue Exception
           failed_databases << cp.db_config.name
         end
 
         raise "unable to connect to: #{failed_databases.uniq.join(',')}" unless failed_databases.empty?
+        raise "no connections checked with name: #{configuration.config_name}" if configuration.config_name && !checked
       rescue Exception => e
         raise DatabaseException.new(e.message)
       end
+
+      private
+
+      def configuration_class
+        ::HealthMonitor::Providers::Database::Configuration
+      end
+
+      def check_connection_pool?(connection_pool)
+        configuration.config_name.nil? || configuration.config_name == connection_pool.db_config.name
+      end
+
+      def check_connection(connection_pool)
+        if connection_pool.respond_to?(:lease_connection)
+          connection_pool.lease_connection.execute('SELECT 1')
+        else
+          connection_pool.connection.execute('SELECT 1')
+        end
+      end
     end
   end
 end

data/lib/health_monitor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HealthMonitor
-  VERSION = '12.5.0'
+  VERSION = '12.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health-monitor-rails
 version: !ruby/object:Gem::Version
-  version: 12.5.0
+  version: 12.7.0
 platform: ruby
 authors:
 - Leonid Beder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-15 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties