health-monitor-rails 12.6.0 → 12.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e05b368505661b4b4a0849035c3449309b6905f92651e2e41701f6651bd36e4
-  data.tar.gz: 57fab8c81135598a106a2f07e35956db9bcf3eb2c7bcba91d826a7af5f20b167
+  metadata.gz: 65ddef8cba3d98c9824273f2eb677bb4eb5797a88ea3a020d846ab9e7b170bf9
+  data.tar.gz: 30b1ff30cdc3c8c95a180701b251756514cacc4f8a6969c07dc07b21fddb538c
 SHA512:
-  metadata.gz: b0f62bf00240926b34f102b96670513caed11686d57a475c0fca7d149da3752bb3331d5a621eccbeea8d233758ec9cc25a359ad537e7399b5a921b1411311529
-  data.tar.gz: 148f73504ac45c215629a1761a844b29eef80cac3d72e212bd66caba59a6fddd4d1be6c81061c7e0bbbc22447b1ecaefe01896107cbf91f9c1fef88c27c48242
+  metadata.gz: bdba690258230630638d475e00cad004127a086cf548460504864038ec1e02eeb434e083cf49e7c23ab00f08ef764e7bacee01a1beaec16d01c1486854ee6a76
+  data.tar.gz: ca61f98fca9a3adc8b89c47748d82ce7a9523842b807d757171474e73f13721d2db6085f65813b3be2829b7f1b3ff3a176020727eae4d11f5392e5e2b4b1314d

data/README.md

@@ -231,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
 
@@ -288,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|
@@ -335,7 +335,7 @@ 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` (Can also be a full path `/opt/app/remove-from-nginx`)
 

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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HealthMonitor
-  VERSION = '12.6.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.6.0
+  version: 12.7.0
 platform: ruby
 authors:
 - Leonid Beder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-17 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties