health-monitor-rails 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec92d63c0e305e0db39997e07711a0a24471baf7
-  data.tar.gz: 7af36ecdf6f4f876c55e6c9141e149041dab3017
+  metadata.gz: a3f053420e3858137ef87df2691280d2318b2891
+  data.tar.gz: 8818c385be1a0824c8c16c777b4749fbbc0c408e
 SHA512:
-  metadata.gz: 59abe49e4f5ee482268a85d76f3d636b5fe1e74a395da89485bf2e23ac68df4aea8713759a10b0305b4647616feb49e972750920f2f3f6267f0d68103705becc
-  data.tar.gz: fd84788912d20dbae1ba18b59310d003b602194649ae406ff688f0ac3565e9c3c834b271b571b9fe9af4d2e9faef43f00afd93bbc62b2dcabf0742eb5090812e
+  metadata.gz: fd85c584edd784d4281c9d7aebc96d55bb442250f7eb284f1f8b5f495d381fd6ec8edbac4a6fb853409262e897cd3fad05b2570703817c180bac1707dd375609
+  data.tar.gz: 8ae3e62d1ee63dd849453f5799279b48f9b8f06fe8c69d7080bef9cdd9d3bc70b445e2b1bba93b2befa660270005d2a377f32213d8702b21716f9f79329acec1

data/README.md

@@ -75,6 +75,28 @@ The currently supported settings are:
 
 * `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).
 
+### 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).
+
+In order to add a custom provider, you'd need to:
+
+* Implement the `HealthMonitor::Providers::Base` class and its `check!` method (a check is considered as failed if it raises an exception):
+
+```ruby
+class CustomProvider < HealthMonitor::Providers::Base
+  def check!
+    raise 'Oh oh!'
+  end
+end
+```
+* Add its class to the configuration:
+
+```ruby
+HealthMonitor.configure do |config|
+  config.add_custom_provider(CustomProvider)
+end
+```
+
 ### Adding a custom error callback
 If you need to perform any additional error handling (for example, for additional error reporting), you can configure a custom error callback:
 

data/lib/health_monitor/configuration.rb

@@ -9,14 +9,28 @@ module HealthMonitor
       database
     end
 
-    PROVIDERS.each do |provider|
-      define_method provider do |&block|
-        require "health_monitor/providers/#{provider}"
+    PROVIDERS.each do |provider_name|
+      define_method provider_name do |&block|
+        require "health_monitor/providers/#{provider_name}"
 
-        (@providers ||= Set.new) << provider
+        add_provider("HealthMonitor::Providers::#{provider_name.capitalize}".constantize)
+      end
+    end
 
-        "HealthMonitor::Providers::#{provider.capitalize}".constantize
+    def add_custom_provider(custom_provider_class)
+      unless custom_provider_class < HealthMonitor::Providers::Base
+        raise ArgumentError.new('custom provider class must implement HealthMonitor::Providers::Base')
       end
+
+      add_provider(custom_provider_class)
+    end
+
+    private
+
+    def add_provider(provider_class)
+      (@providers ||= Set.new) << provider_class
+
+      provider_class
     end
   end
 end

data/lib/health_monitor/monitor.rb

@@ -13,7 +13,7 @@ module HealthMonitor
 
   def check!(request: nil)
     configuration.providers.each do |provider|
-      monitor = "HealthMonitor::Providers::#{provider.capitalize}".constantize.new(request: request)
+      monitor = provider.new(request: request)
       monitor.check!
     end
   rescue Exception => e

data/lib/health_monitor/version.rb

@@ -1,3 +1,3 @@
 module HealthMonitor
-  VERSION = '2.0.2'.freeze
+  VERSION = '2.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health-monitor-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Leonid Beder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-10 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails