health-monitor-rails 12.2.0 → 12.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b598be966486e38fe823322c1f067e033543ad2df2eb3175c4f48464fd486c0
-  data.tar.gz: c75ceeeffb9d18b5427d2791359a74616b91e830fce1cafd7f737e78b7b87c23
+  metadata.gz: 16d418a94d55bfea53470ed8a0b1d4b8614c32b2f3a0f439dd37859c99cb62b1
+  data.tar.gz: 5f53e4f8bcc43d2a2ae27fa02a14f44c277b2a37388b500b7c9450ca6834197d
 SHA512:
-  metadata.gz: 54c82d499f5230ffb29d25d1f2ae07a82df5b2c31babfae8759c213488c88024beaa286f64adeaa63a932064e8f5d7496dc263136422b694ee130481c2a1fde4
-  data.tar.gz: 446c5607d7eb1f96803318cfca0c460147e45fce68ba0b243f52c91913211f3c1df98a5d0a8a087269ccecd45bf67f882955d46b658e954e9cd240bc0e16f284
+  metadata.gz: e09ede9673ea8c30618eeffb12b169920705b4f54376e091141008303c060a6071ec627eec576724901f046d3c697e30c0519235a22175ec100ce58286188c97
+  data.tar.gz: b0383068465c7ebb1e4beedd46c9f26801fcd2fdae8f0b591be3a4967bb72bb94f13a6a62a3c35290c3385f187ec917cafd3ea5add28386afa2c44bda9a6d6de

data/README.md

@@ -177,6 +177,7 @@ The following services are currently supported:
 * Resque
 * Delayed Job
 * Solr
+* FileAbsence
 
 ## Configuration
 
@@ -316,6 +317,13 @@ Please note that `url` or `connection` can't be used at the same time.
 ### Solr
 
 * `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
 
@@ -440,9 +448,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
@@ -452,7 +462,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/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(provider)
+
+          @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/solr.rb

@@ -9,12 +9,14 @@ module HealthMonitor
     class Solr < Base
       class Configuration < Base::Configuration
         DEFAULT_URL = nil
-        attr_accessor :url
+        DEFAULT_COLLECTION = nil
+        attr_accessor :url, :collection
 
         def initialize(provider)
           super(provider)
 
           @url = DEFAULT_URL
+          @collection = DEFAULT_COLLECTION
         end
       end
 
@@ -31,6 +33,22 @@ module HealthMonitor
       end
 
       def check_solr_connection!
+        if configuration.collection
+          check_solr_collection!
+        else
+          check_solr_uri!
+        end
+      end
+
+      def check_solr_collection!
+        response = solr_response(uri: collection_uri)
+        json = JSON.parse(response.body) if response.code == '200'
+        return if response.is_a?(Net::HTTPSuccess) && json['status'].casecmp?('OK')
+
+        raise "The Solr collection has an invalid status #{collection_uri}"
+      end
+
+      def check_solr_uri!
         json = JSON.parse(solr_response.body)
         raise "The solr has an invalid status #{status_uri}" if json['responseHeader']['status'] != 0
       end
@@ -44,16 +62,24 @@ module HealthMonitor
         end
       end
 
-      def solr_request
+      def collection_uri
+        @collection_uri ||= begin
+          uri = URI(configuration.url)
+          uri.path = "/solr/#{configuration.collection}/admin/ping"
+          uri
+        end
+      end
+
+      def solr_request(uri: status_uri)
         @solr_request ||= begin
-          req = Net::HTTP::Get.new(status_uri)
-          req.basic_auth(status_uri.user, status_uri.password) if status_uri.user && status_uri.password
+          req = Net::HTTP::Get.new(uri)
+          req.basic_auth(uri.user, uri.password) if uri.user && uri.password
           req
         end
       end
 
-      def solr_response
-        Net::HTTP.start(status_uri.hostname, status_uri.port) { |http| http.request(solr_request) }
+      def solr_response(uri: status_uri)
+        Net::HTTP.start(status_uri.hostname, status_uri.port) { |http| http.request(solr_request(uri: uri)) }
       end
     end
   end

data/lib/health_monitor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health-monitor-rails
 version: !ruby/object:Gem::Version
-  version: 12.2.0
+  version: 12.4.0
 platform: ruby
 authors:
 - Leonid Beder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-26 00:00:00.000000000 Z
+date: 2024-11-09 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