health-monitor-rails 9.3.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fefcb47918931ba220666f67809857de73b45f8ccbb07611bcceb8ffd5661cb
-  data.tar.gz: 6002b738f3b4c8ed4cd1f6d9d07fc55b218a71bf04a0a0c53fcef8bd1a8b2369
+  metadata.gz: 0502db2e6a54cf73defc3f9333fe3a157c79d8b5b2a4122fd65b6f54c48c76c5
+  data.tar.gz: 1b1a0591c7660abf3d38f8b0dd5c21761125f5a9da46bfc3283b2a46f49d40a8
 SHA512:
-  metadata.gz: 1b0e752bee2272ab5b708a2073e5b3385c71c2003db2886849ab648928b8324caa8bfbf3738f494c6313bfba3bbb08a6f54b5ee39794efac4a517444d02e8521
-  data.tar.gz: 7dbe3909de4048a29a9395c84da5ae6ed58d2971379d03352db5b47a00b7dda8a01e313462cb591badd207e58bb878ee8b36b76acd39cf596d5db53dcb95c523
+  metadata.gz: cc7cd0673bf3c88b9ba7e146c171aee8a98630205b65b1603e1ed39b161bb288cd76a0875ea977725a30bf8914adb4a60232d71be6882e7c865239c364931af2
+  data.tar.gz: bb1e311ee5dabda3fa4c1bd141467caf1c7469ba1c1873189e5f3c165ad8c7387c930ccdb94122fcce6d54359a7ae84dea58d3f200b1ce14a51616030589fb9f

data/README.md

@@ -1,7 +1,7 @@
 # health-monitor-rails
 
 [![Gem Version](https://badge.fury.io/rb/health-monitor-rails.svg)](http://badge.fury.io/rb/health-monitor-rails)
-[![Build Status](https://travis-ci.com/lbeder/health-monitor-rails.svg?branch=master)](https://travis-ci.com/lbeder/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.).
@@ -214,7 +214,7 @@ HealthMonitor.configure do |config|
   end
 end
 
-# To configure specific queues
+# Sidekiq with specific queues
 HealthMonitor.configure do |config|
   config.sidekiq.configure do |sidekiq_config|
     sidekiq_config.add_queue_configuration('critical', latency: 10.seconds, queue_size: 20)
@@ -224,7 +224,7 @@ end
 ```
 
 ```ruby
-# Redis
+# Redis with existing connection
 HealthMonitor.configure do |config|
   config.redis.configure do |redis_config|
     redis_config.connection = Redis.current # Use your custom redis connection
@@ -236,7 +236,7 @@ end
 Additionally, you can configure an explicit URL:
 
 ```ruby
-# Redis
+# Redis with a URL configuration
 HealthMonitor.configure do |config|
   config.redis.configure do |redis_config|
     redis_config.url = 'redis://user:pass@example.redis.com:90210/'
@@ -245,12 +245,25 @@ HealthMonitor.configure do |config|
 end
 ```
 
+Or via a connection pool:
+
+```ruby
+# Redis using Connection Pools
+HealthMonitor.configure do |config|
+  config.redis.configure do |redis_config|
+    redis_config.connection = ConnectionPool.new(size: 5) { Redis.new } # Use your custom connection pool
+  end
+end
+```
+
 The currently supported settings are:
 
 #### Sidekiq
 
 * `latency`: the latency (in seconds) of a queue (now - when the oldest job was enqueued) which is considered unhealthy (the default is 30 seconds, but larger processing queue should have a larger latency value).
 * `queue_size`: the size (maximum) of a queue which is considered unhealthy (the default is 100).
+* `default_queue`: the default queue to check.
+* `add_queue_configuration`: add specific configuration per queue.
 
 #### Redis
 

data/app/controllers/health_monitor/health_controller.rb

@@ -12,6 +12,7 @@ module HealthMonitor
 
     def check
       @statuses = statuses
+      @hide_footer = HealthMonitor.configuration.hide_footer
 
       respond_to do |format|
         format.html

data/app/views/health_monitor/health/check.html.erb

@@ -69,10 +69,12 @@
         </div>
       </div>
     </main>
-    <footer>
-      <div class="font-light text-center text-slate-500 text-xs px-5">
-        Powered by <a href="https://github.com/lbeder/health-monitor-rails" target="_blank">health-monitor-rails</a>
-      </div>
-    </footer>
+    <% if !@hide_footer %>
+      <footer>
+        <div class="font-light text-center text-slate-500 text-xs px-5">
+          Powered by <a href="https://github.com/lbeder/health-monitor-rails" target="_blank">health-monitor-rails</a>
+        </div>
+      </footer>
+    <% end %>
   </body>
 </html>

data/lib/health_monitor/configuration.rb

@@ -7,6 +7,7 @@ module HealthMonitor
     attr_accessor :basic_auth_credentials,
                   :environment_variables,
                   :error_callback,
+                  :hide_footer,
                   :path
     attr_reader :providers
 
@@ -21,7 +22,11 @@ module HealthMonitor
     PROVIDERS.each do |provider_name|
       define_method provider_name do |&_block|
         require "health_monitor/providers/#{provider_name}"
-        add_provider("HealthMonitor::Providers::#{provider_name.to_s.titleize.delete(' ')}".constantize)
+
+        add_provider(
+          "HealthMonitor::Providers::#{provider_name.to_s.titleize.delete(' ')}"
+            .constantize
+        )
       end
     end
 

data/lib/health_monitor/providers/base.rb

@@ -3,6 +3,8 @@
 module HealthMonitor
   module Providers
     class Base
+      @global_configuration = nil
+
       attr_reader :request
       attr_accessor :configuration
 
@@ -10,10 +12,14 @@ module HealthMonitor
         @provider_name ||= name.demodulize
       end
 
+      def self.global_configuration
+        @global_configuration ||= configuration_class.new
+      end
+
       def self.configure
         return unless configurable?
 
-        @global_configuration = configuration_class.new
+        @global_configuration ||= configuration_class.new
 
         yield @global_configuration if block_given?
       end
@@ -23,7 +29,7 @@ module HealthMonitor
 
         return unless self.class.configurable?
 
-        self.configuration = self.class.instance_variable_get('@global_configuration')
+        self.configuration = self.class.global_configuration
       end
 
       # @abstract

data/lib/health_monitor/providers/database.rb

@@ -8,8 +8,15 @@ module HealthMonitor
 
     class Database < Base
       def check!
-        # Check connection to the DB:
-        ActiveRecord::Migrator.current_version
+        failed_databases = []
+
+        ActiveRecord::Base.connection_handler.all_connection_pools.each do |cp|
+          cp.connection.check_version
+        rescue Exception
+          failed_databases << cp.db_config.name
+        end
+
+        raise "unable to connect to: #{failed_databases.uniq.join(',')}" unless failed_databases.empty?
       rescue Exception => e
         raise DatabaseException.new(e.message)
       end

data/lib/health_monitor/providers/redis.rb

@@ -4,6 +4,8 @@ require 'health_monitor/providers/base'
 
 module HealthMonitor
   module Providers
+    CONNECTION_POOL_SIZE = 1
+
     class RedisException < StandardError; end
 
     class Redis < Base
@@ -23,6 +25,10 @@ module HealthMonitor
         def configuration_class
           ::HealthMonitor::Providers::Redis::Configuration
         end
+
+        def as_connection_pool(connection)
+          ConnectionPool.new(size: CONNECTION_POOL_SIZE) { connection }
+        end
       end
 
       def check!
@@ -30,8 +36,6 @@ module HealthMonitor
         check_max_used_memory!
       rescue Exception => e
         raise RedisException.new(e.message)
-      ensure
-        redis.close
       end
 
       private
@@ -39,8 +43,8 @@ module HealthMonitor
       def check_values!
         time = Time.now.to_formatted_s(:rfc2822)
 
-        redis.set(key, time)
-        fetched = redis.get(key)
+        redis.with { |conn| conn.set(key, time) }
+        fetched = redis.with { |conn| conn.get(key) }
 
         raise "different values (now: #{time}, fetched: #{fetched})" if fetched != time
       end
@@ -59,11 +63,15 @@ module HealthMonitor
       def redis
         @redis =
           if configuration.connection
-            configuration.connection
+            if configuration.connection.is_a?(ConnectionPool)
+              configuration.connection
+            else
+              ConnectionPool.new(size: CONNECTION_POOL_SIZE) { configuration.connection }
+            end
           elsif configuration.url
-            ::Redis.new(url: configuration.url)
+            ConnectionPool.new(size: CONNECTION_POOL_SIZE) { ::Redis.new(url: configuration.url) }
           else
-            ::Redis.new
+            ConnectionPool.new(size: CONNECTION_POOL_SIZE) { ::Redis.new }
           end
       end
 
@@ -72,7 +80,7 @@ module HealthMonitor
       end
 
       def used_memory_mb
-        bytes_to_megabytes(redis.info['used_memory'])
+        bytes_to_megabytes(redis.with { |conn| conn.info['used_memory'] })
       end
     end
   end

data/lib/health_monitor/providers/sidekiq.rb

@@ -73,6 +73,7 @@ module HealthMonitor
 
       def check_processes!
         sidekiq_stats = ::Sidekiq::Stats.new
+
         return unless sidekiq_stats.processes_size.zero?
 
         raise 'Sidekiq alive processes number is 0!'
@@ -89,6 +90,7 @@ module HealthMonitor
       def check_queue_size!
         configuration.queues.each do |queue, config|
           size = queue(queue).size
+
           raise "queue '#{queue}': size #{size} is greater than #{config[:queue_size]}" if size > config[:queue_size]
         end
       end

data/lib/health_monitor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health-monitor-rails
 version: !ruby/object:Gem::Version
-  version: 9.3.0
+  version: 10.0.0
 platform: ruby
 authors:
 - Leonid Beder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-15 00:00:00.000000000 Z
+date: 2023-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: mock_redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,19 +137,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rediska
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +184,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        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.5'
+        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