health-monitor-rails 12.1.0 → 12.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a4b35be2c84bd3859456f041a978da8828cb72294d86bfab7b97dc3478134b3
-  data.tar.gz: a393dbc7c46777aae939589d443b67ef41abbeb238879adf4ff6985511aceda9
+  metadata.gz: 952a62b089d3b56df2b8ab11b329dae2512d285db4027bde6705892e171ff755
+  data.tar.gz: 36a7996a83a871a82814caef5d31d2cc880b1f40bd12e2f191290e72a9d1537f
 SHA512:
-  metadata.gz: 1f18d57cdf6471cf63e7ad493b4019bf1a5edfca635393aa1f35def68439dfd859b19ccf2fb3f5ab178015db46b24bf7507ed43fbc8efc8114e44d7d7e8ff736
-  data.tar.gz: 4da774036fbbf7e4baf0e6abb2bd7eb313282bc2ea3ca39feded6bfe0c099f2fe5549e02b799e255d9d4738d07bf80ecda5dfd2b10caa213f3f68170204d684d
+  metadata.gz: a9878debcd730c9848ec50af8ed0b1ed912adffc240c1aab657c82a40e0113ac32a335f53ef32c9c7a3487eee68483235b767009e900c376eb1df55dd28cf2cd
+  data.tar.gz: d361fd7cf5fe894de0d2bce196b06c23f9c3015d1dfa545ba0158c441e2c4f1caed1d6053975a9ff545082025ec1a1c387644a7aaa4dbede0e020c8869289cac

data/README.md

@@ -176,6 +176,7 @@ The following services are currently supported:
 * Sidekiq
 * Resque
 * Delayed Job
+* Solr
 
 ## Configuration
 
@@ -312,6 +313,11 @@ Please note that `url` or `connection` can't be used at the same time.
 
 * `queue_size`: the size (maximum) of a queue which is considered unhealthy (the default is 100).
 
+### 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
+
 ### 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).
@@ -434,6 +440,24 @@ nicolas@desktop:$ echo $?
 2
 ```
 
+## 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
+appraisal clean
+appraisal generate
+appraisal install
+```
+
+### Running the tests
+Use appraisal to run the tests using rake
+```bash
+appraisal rake
+```
+
 ## License
 
 The MIT License (MIT)

data/lib/health_monitor/configuration.rb

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

data/lib/health_monitor/providers/solr.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'health_monitor/providers/base'
+
+module HealthMonitor
+  module Providers
+    class SolrException < StandardError; end
+
+    class Solr < Base
+      class Configuration < Base::Configuration
+        DEFAULT_URL = nil
+        DEFAULT_COLLECTION = nil
+        attr_accessor :url, :collection
+
+        def initialize(provider)
+          super(provider)
+
+          @url = DEFAULT_URL
+          @collection = DEFAULT_COLLECTION
+        end
+      end
+
+      def check!
+        check_solr_connection!
+      rescue Exception => e
+        raise SolrException.new(e.message)
+      end
+
+      private
+
+      def configuration_class
+        ::HealthMonitor::Providers::Solr::Configuration
+      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
+
+      def status_uri
+        @status_uri ||= begin
+          uri = URI(configuration.url)
+          uri.path = '/solr/admin/cores'
+          uri.query = 'action=STATUS'
+          uri
+        end
+      end
+
+      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(uri)
+          req.basic_auth(uri.user, uri.password) if uri.user && uri.password
+          req
+        end
+      end
+
+      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
+end

data/lib/health_monitor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health-monitor-rails
 version: !ruby/object:Gem::Version
-  version: 12.1.0
+  version: 12.3.0
 platform: ruby
 authors:
 - Leonid Beder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -48,6 +48,7 @@ files:
 - lib/health_monitor/providers/redis.rb
 - lib/health_monitor/providers/resque.rb
 - lib/health_monitor/providers/sidekiq.rb
+- lib/health_monitor/providers/solr.rb
 - lib/health_monitor/version.rb
 homepage: https://github.com/lbeder/health-monitor-rails
 licenses: