health-monitor-rails 12.3.0 → 12.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 952a62b089d3b56df2b8ab11b329dae2512d285db4027bde6705892e171ff755
-  data.tar.gz: 36a7996a83a871a82814caef5d31d2cc880b1f40bd12e2f191290e72a9d1537f
+  metadata.gz: 8b3587a34b753e20332f2ee30e5a8fabf95485edc28dbf0521be42895bc2dbb0
+  data.tar.gz: 4b9b77a3c16bb5d01182af1ff1d327deb0089785da6905012a498be977b20038
 SHA512:
-  metadata.gz: a9878debcd730c9848ec50af8ed0b1ed912adffc240c1aab657c82a40e0113ac32a335f53ef32c9c7a3487eee68483235b767009e900c376eb1df55dd28cf2cd
-  data.tar.gz: d361fd7cf5fe894de0d2bce196b06c23f9c3015d1dfa545ba0158c441e2c4f1caed1d6053975a9ff545082025ec1a1c387644a7aaa4dbede0e020c8869289cac
+  metadata.gz: 808e2ed0c5fa88496ff3eae0540e559b871629970210ea371f0cbf95ad8e71f2f9687e72bb802b6f26b961bb59dcc42c0c904a5f6a68af9754d172c5e42ccbfb
+  data.tar.gz: 6d31d3cf3605c2d3eddd144242794774db6abaf7022b2cbf8cb7430ba8495d38ac81018ea97a6d516258a190dd3933e031b52103e036538a60c7d3694e36af96

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/health-monitor-rails.svg)](http://badge.fury.io/rb/health-monitor-rails)
 [![Build Status](https://github.com/lbeder/health-monitor-rails/actions/workflows/ci.yml/badge.svg)](https://github.com/lbeder/health-monitor-rails/actions/workflows/ci.yml)
-[![Coverage Status](https://coveralls.io/repos/lbeder/health-monitor-rails/badge.svg)](https://coveralls.io/r/lbeder/health-monitor-rails)
 
 This is a health monitoring Rails mountable plug-in, which checks various services (db, cache, sidekiq, redis, etc.).
 
@@ -177,6 +176,7 @@ The following services are currently supported:
 * Resque
 * Delayed Job
 * Solr
+* FileAbsence
 
 ## Configuration
 
@@ -318,6 +318,12 @@ Please note that `url` or `connection` can't be used at the same time.
 * `url`: the URL used to connect to your Solr instance - must be a string. You can also use `url` to explicitly configure authentication (e.g., `'https://user:pass@example.solr.com:8983/'`)
 * `collection`: An optional parameter used to connect to your specific Solr collection - must be a string. By setting this parameter the code will check the status of this individual collection in your Solr instance instead of just the status of the overall Solr instance
 
+### 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.
+
+* `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`
+
 ### Adding a Custom Provider
 
 It's also possible to add custom health check providers suited for your needs (of course, it's highly appreciated and encouraged if you'd contribute useful providers to the project).
@@ -441,9 +447,11 @@ nicolas@desktop:$ echo $?
 ```
 
 ## Development
+
 In order to work on development on the gem itself
 
 ### Installing the gems
+
 Use the [appraisal gem](https://github.com/thoughtbot/appraisal) to install the bundles for different rails versions:
 
 ```bash
@@ -453,7 +461,9 @@ appraisal install
 ```
 
 ### Running the tests
+
 Use appraisal to run the tests using rake
+
 ```bash
 appraisal rake
 ```

data/lib/health_monitor/configuration.rb

@@ -2,7 +2,7 @@
 
 module HealthMonitor
   class Configuration
-    PROVIDERS = %i[cache database delayed_job redis resque sidekiq solr].freeze
+    PROVIDERS = %i[cache database delayed_job file_absence redis resque sidekiq solr].freeze
 
     attr_accessor :basic_auth_credentials,
                   :environment_variables,

data/lib/health_monitor/providers/cache.rb

@@ -8,7 +8,7 @@ module HealthMonitor
 
     class Cache < Base
       def check!
-        time = Time.now.to_s
+        time = Time.now.to_formatted_s(:rfc2822)
 
         Rails.cache.write(key, time)
         fetched = Rails.cache.read(key)

data/lib/health_monitor/providers/database.rb

@@ -11,7 +11,7 @@ module HealthMonitor
         failed_databases = []
 
         ActiveRecord::Base.connection_handler.connection_pool_list(:all).each do |cp|
-          cp.connection.execute('SELECT 1')
+          cp.lease_connection.execute('SELECT 1')
         rescue Exception
           failed_databases << cp.db_config.name
         end

data/lib/health_monitor/providers/delayed_job.rb

@@ -14,7 +14,7 @@ module HealthMonitor
         attr_accessor :queue_size
 
         def initialize(provider)
-          super(provider)
+          super
 
           @queue_size = DEFAULT_QUEUES_SIZE
         end

data/lib/health_monitor/providers/file_absence.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'health_monitor/providers/base'
+
+module HealthMonitor
+  module Providers
+    class FileAbsenceException < StandardError; end
+
+    class FileAbsence < Base
+      class Configuration < Base::Configuration
+        DEFAULT_FILENAME = nil
+        attr_accessor :filename
+
+        def initialize(provider)
+          super
+
+          @filename = DEFAULT_FILENAME
+        end
+      end
+
+      def check!
+        return unless File.exist?(configuration.filename)
+
+        raise FileAbsenceException.new("Unwanted file #{configuration.filename} exists!")
+      end
+
+      private
+
+      def configuration_class
+        ::HealthMonitor::Providers::FileAbsence::Configuration
+      end
+    end
+  end
+end

data/lib/health_monitor/providers/redis.rb

@@ -15,7 +15,7 @@ module HealthMonitor
         attr_accessor :url, :connection, :max_used_memory
 
         def initialize(provider)
-          super(provider)
+          super
 
           @url = DEFAULT_URL
         end

data/lib/health_monitor/providers/sidekiq.rb

@@ -18,7 +18,7 @@ module HealthMonitor
         attr_reader :queues
 
         def initialize(provider)
-          super(provider)
+          super
 
           @maximum_amount_of_retries = DEFAULT_RETRY_CHECK
 

data/lib/health_monitor/providers/solr.rb

@@ -13,7 +13,7 @@ module HealthMonitor
         attr_accessor :url, :collection
 
         def initialize(provider)
-          super(provider)
+          super
 
           @url = DEFAULT_URL
           @collection = DEFAULT_COLLECTION

data/lib/health_monitor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health-monitor-rails
 version: !ruby/object:Gem::Version
-  version: 12.3.0
+  version: 12.4.1
 platform: ruby
 authors:
 - Leonid Beder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-22 00:00:00.000000000 Z
+date: 2024-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -45,6 +45,7 @@ files:
 - lib/health_monitor/providers/cache.rb
 - lib/health_monitor/providers/database.rb
 - lib/health_monitor/providers/delayed_job.rb
+- lib/health_monitor/providers/file_absence.rb
 - lib/health_monitor/providers/redis.rb
 - lib/health_monitor/providers/resque.rb
 - lib/health_monitor/providers/sidekiq.rb
@@ -70,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Health monitoring Rails plug-in, which checks various services (db, cache,