health-monitor-rails 10.1.0 → 11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f31145948d53277b016035e3dd3b1580ccc47afc452f2a9a197141c3c96b21ad
-  data.tar.gz: 80f759c330d6086287abd668c6c9bf5c9666092a3ac2d8ac2f0a8439981a36ff
+  metadata.gz: ebb626c2a794dc6f2b1a0e657fb126179155ad88ec12b8d67bb356519517204d
+  data.tar.gz: 45beac4910b662ca499ce4017a53a0bf5671b6b5791a11fa357b432c31ee130e
 SHA512:
-  metadata.gz: c3b4d89aa49a1d799f23ec6e98bf718a584e8c7954e1c4544d61159f0ed012609bb8eb213714cf987f52a537dd00c14bfbce6b92fa8f5f7e64b50fdf1f94310f
-  data.tar.gz: 6e1f95ccc047a279d7cb8658a3186de8b20ae62260ea9832beec3ca7a944522b1a91171ee3aa9c4d9ddc672f964d8c55f2f8005a036d0423281d42dc038d34a0
+  metadata.gz: 368decd1adde6046ec5561573afe27f1423bde4a37ed8c4dee7a99a93bcbde1f2752ff1370ff09f1a807815ebe012f73b514a44ba23231ac5442e99b9d885869
+  data.tar.gz: 4d413a6fdce8c28ce49279867f39ca208274f1c6a226c7ae68a1b2b2b4c80f8ed7dd7a7331be30bae2f7eac0eff81f8e2298cfc76b44b61aa205df789b667c28

data/README.md

@@ -203,6 +203,22 @@ end
 
 ### Provider Configuration
 
+All providers accept a general set of baseline configuration:
+
+```ruby
+HealthMonitor.configure do |config|
+  config.[provider].configure do |provider_config|
+    provider_config.name = 'Redis'
+    provider_config.critical = true
+  end
+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
+
+> 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
+
 Some of the providers can also accept additional configuration:
 
 ```ruby
@@ -256,6 +272,25 @@ 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:
+
+```ruby
+HealthMonitor.configure do |config|
+  config.redis.configure do |c|
+    c.name = 'Redis: Cache'
+    c.url = ENV.fetch('REDISCLOUD_URL', 'redis://localhost:6379/0')
+  end
+  config.redis.configure do |c|
+    c.name = 'Redis: Action Cable'
+    c.url = ENV.fetch('REDISCLOUD_URL', 'redis://localhost:6379/0')
+  end
+  config.redis.configure do |c|
+    c.name = 'Redis: Sidekiq'
+    c.url = ENV.fetch('REDISCLOUD_URL', 'redis://localhost:6379/1')
+  end
+end
+```
+
 The currently supported settings are:
 
 #### Sidekiq

data/app/controllers/health_monitor/health_controller.rb

@@ -16,8 +16,8 @@ module HealthMonitor
 
       respond_to do |format|
         format.html
-        format.json { render json: statuses.to_json, status: statuses[:status] }
-        format.xml { render xml: statuses.to_xml, status: statuses[:status] }
+        format.json { render json: @statuses.to_json, status: @statuses[:status] }
+        format.xml { render xml: @statuses.to_xml, status: @statuses[:status] }
       end
     end
 

data/lib/health_monitor/configuration.rb

@@ -16,7 +16,7 @@ module HealthMonitor
     end
 
     def no_database
-      @providers.delete(HealthMonitor::Providers::Database)
+      @providers.shift
     end
 
     PROVIDERS.each do |provider_name|
@@ -25,7 +25,7 @@ module HealthMonitor
 
         add_provider(
           "HealthMonitor::Providers::#{provider_name.to_s.titleize.delete(' ')}"
-            .constantize
+            .constantize.new
         )
       end
     end
@@ -40,10 +40,10 @@ module HealthMonitor
 
     private
 
-    def add_provider(provider_class)
-      (@providers ||= Set.new) << provider_class
+    def add_provider(provider)
+      (@providers ||= []) << provider
 
-      provider_class
+      provider
     end
   end
 end

data/lib/health_monitor/monitor.rb

@@ -21,14 +21,14 @@ module HealthMonitor
   def check(request: nil, params: {})
     providers = configuration.providers
     if params[:providers].present?
-      providers = providers.select { |provider| params[:providers].include?(provider.provider_name.downcase) }
+      providers = providers.select { |provider| params[:providers].include?(provider.name.downcase) }
     end
 
     results = providers.map { |provider| provider_result(provider, request) }
 
     {
-      results: results,
-      status: results.any? { |res| res[:status] != STATUSES[:ok] } ? :service_unavailable : :ok,
+      results: results.map { |c| c.without(:critical) },
+      status: results.any? { |res| res[:status] != STATUSES[:ok] && res[:critical] } ? :service_unavailable : :ok,
       timestamp: Time.now.to_formatted_s(:rfc2822)
     }
   end
@@ -36,21 +36,24 @@ module HealthMonitor
   private
 
   def provider_result(provider, request)
-    monitor = provider.new(request: request)
+    monitor = provider
+    monitor.request = request
     monitor.check!
 
     {
-      name: provider.provider_name,
+      name: provider.name,
       message: '',
-      status: STATUSES[:ok]
+      status: STATUSES[:ok],
+      critical: provider.critical
     }
   rescue StandardError => e
     configuration.error_callback.try(:call, e)
 
     {
-      name: provider.provider_name,
+      name: provider.name,
       message: e.message,
-      status: STATUSES[:error]
+      status: STATUSES[:error],
+      critical: provider.critical
     }
   end
 end

data/lib/health_monitor/providers/base.rb

@@ -1,35 +1,32 @@
 # frozen_string_literal: true
 
+require 'forwardable'
+
 module HealthMonitor
   module Providers
     class Base
-      @global_configuration = nil
-
-      attr_reader :request
-      attr_accessor :configuration
+      extend Forwardable
 
-      def self.provider_name
-        @provider_name ||= name.demodulize
-      end
+      class Configuration
+        attr_accessor :name, :critical
 
-      def self.global_configuration
-        @global_configuration ||= configuration_class.new
+        def initialize(provider)
+          @name = provider.class.name.demodulize
+          @critical = true
+        end
       end
 
-      def self.configure
-        return unless configurable?
+      attr_accessor :request
+      attr_reader :configuration
 
-        @global_configuration ||= configuration_class.new
+      def_delegators :@configuration, :name, :critical
 
-        yield @global_configuration if block_given?
+      def initialize
+        @configuration = configuration_class.new(self)
       end
 
-      def initialize(request: nil)
-        @request = request
-
-        return unless self.class.configurable?
-
-        self.configuration = self.class.global_configuration
+      def configure
+        yield @configuration if block_given?
       end
 
       # @abstract
@@ -37,12 +34,11 @@ module HealthMonitor
         raise NotImplementedError
       end
 
-      def self.configurable?
-        configuration_class
-      end
+      private
 
-      # @abstract
-      def self.configuration_class; end
+      def configuration_class
+        Configuration
+      end
     end
   end
 end

data/lib/health_monitor/providers/delayed_job.rb

@@ -8,12 +8,14 @@ module HealthMonitor
     class DelayedJobException < StandardError; end
 
     class DelayedJob < Base
-      class Configuration
+      class Configuration < Base::Configuration
         DEFAULT_QUEUES_SIZE = 100
 
         attr_accessor :queue_size
 
-        def initialize
+        def initialize(provider)
+          super(provider)
+
           @queue_size = DEFAULT_QUEUES_SIZE
         end
       end
@@ -24,16 +26,6 @@ module HealthMonitor
         raise DelayedJobException.new(e.message)
       end
 
-      private
-
-      class << self
-        private
-
-        def configuration_class
-          ::HealthMonitor::Providers::DelayedJob::Configuration
-        end
-      end
-
       def check_queue_size!
         size = job_class.count
 
@@ -45,6 +37,12 @@ module HealthMonitor
       def job_class
         @job_class ||= ::Delayed::Job
       end
+
+      private
+
+      def configuration_class
+        ::HealthMonitor::Providers::DelayedJob::Configuration
+      end
     end
   end
 end

data/lib/health_monitor/providers/redis.rb

@@ -9,12 +9,14 @@ module HealthMonitor
     class RedisException < StandardError; end
 
     class Redis < Base
-      class Configuration
+      class Configuration < Base::Configuration
         DEFAULT_URL = nil
 
         attr_accessor :url, :connection, :max_used_memory
 
-        def initialize
+        def initialize(provider)
+          super(provider)
+
           @url = DEFAULT_URL
         end
       end
@@ -22,10 +24,6 @@ module HealthMonitor
       class << self
         private
 
-        def configuration_class
-          ::HealthMonitor::Providers::Redis::Configuration
-        end
-
         def as_connection_pool(connection)
           ConnectionPool.new(size: CONNECTION_POOL_SIZE) { connection }
         end
@@ -40,6 +38,10 @@ module HealthMonitor
 
       private
 
+      def configuration_class
+        ::HealthMonitor::Providers::Redis::Configuration
+      end
+
       def check_values!
         time = Time.now.to_formatted_s(:rfc2822)
 

data/lib/health_monitor/providers/sidekiq.rb

@@ -8,7 +8,7 @@ module HealthMonitor
     class SidekiqException < StandardError; end
 
     class Sidekiq < Base
-      class Configuration
+      class Configuration < Base::Configuration
         DEFAULT_QUEUE_NAME = 'default'
         DEFAULT_LATENCY_TIMEOUT = 30
         DEFAULT_QUEUES_SIZE = 100
@@ -16,7 +16,9 @@ module HealthMonitor
 
         attr_reader :queues
 
-        def initialize
+        def initialize(provider)
+          super(provider)
+
           @queues = {}
           @queues[DEFAULT_QUEUE_NAME] = { latency: DEFAULT_LATENCY_TIMEOUT, queue_size: DEFAULT_QUEUES_SIZE }
         end
@@ -61,12 +63,8 @@ module HealthMonitor
 
       private
 
-      class << self
-        private
-
-        def configuration_class
-          ::HealthMonitor::Providers::Sidekiq::Configuration
-        end
+      def configuration_class
+        ::HealthMonitor::Providers::Sidekiq::Configuration
       end
 
       def check_workers!

data/lib/health_monitor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health-monitor-rails
 version: !ruby/object:Gem::Version
-  version: 10.1.0
+  version: 11.0.0
 platform: ruby
 authors:
 - Leonid Beder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2023-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -24,258 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: capybara-screenshot
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls_reborn
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: delayed_job_active_record
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.1'
-- !ruby/object:Gem::Dependency
-  name: mock_redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: resque
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: spork
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Health monitoring Rails plug-in, which checks various services (db, cache,
   sidekiq, redis, etc.).
 email: