health-monitor-rails 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dd284083597e8564ff0ebb0b5f22e7f8ecd0bbd
-  data.tar.gz: 941c1740e843d4cb151b7165ce9bb78279e7bc7c
+  metadata.gz: 202a4502ef0b79a948915e6511a598166b3399ed
+  data.tar.gz: a7901956e05d4dd6a56e675f84e2f5eb9e027c65
 SHA512:
-  metadata.gz: ef8bd0be46c38901593884fb28ed5f50c994df8c32298565afda225436b453e9970ba0ba833d71e211698c65b8f363f580f25e93643d958f7a0032e177fbfd6c
-  data.tar.gz: 4a9a270da4c1d11e6c14dcbac488d0078a202fc4d8496efee86a7a4d098bac09cf75a296af662ae6f806a852cb493246afb03fd1f7dcf0e3a35516fc5c859b3f
+  metadata.gz: e9e374e7f8f4b40a945dbe94b9cc2b0d970124d5bd8d03d5ac3ad683f4f96fb12ec0e4b4833fe3be35be0d950d77c9add29f264af460f1d4d508f33489131d5c
+  data.tar.gz: c4743ec2a9839f826db25622825ccdd823c03b93859f0f391fd820f92fe20a8e2345837d4ef07f3ccbd57de6b3f07ae3beb5b922a6535ccdcff61affa7a2e5b8

data/README.md

@@ -47,21 +47,34 @@ The following services are currently supported:
 ## Configuration
 
 ### Adding providers
-By default, only the database check is enabled. You can add more service providers via an initializer:
+By default, only the database check is enabled. You can add more service providers by explicitly enabling them via an initializer:
 
 ```ruby
 HealthMonitor.configure do |config|
-  config.providers += [:cache, :redis, :sidekiq]
+  config.cache
+  config.redis
+  config.sidekiq
 end
 ```
 
-You can also override the list with a custom set of providers:
+### Providers configuration
+
+Some of the providers can also accept additional configuration:
+
 ```ruby
 HealthMonitor.configure do |config|
-  config.providers = [:sidekiq]
+  config.sidekiq.configure do |sidekiq_config|
+    sidekiq_config.latency = 3.hours
+  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).
+
 ### 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

@@ -1,9 +1,20 @@
 module HealthMonitor
   class Configuration
-    attr_accessor :providers, :error_callback, :basic_auth_credentials
+    PROVIDERS = [:cache, :database, :redis, :resque, :sidekiq].freeze
+
+    attr_accessor :error_callback, :basic_auth_credentials
+    attr_reader :providers
 
     def initialize
-      @providers = [:database]
+      @providers = Set.new([:database])
+    end
+
+    PROVIDERS.each do |provider|
+      define_method provider do |&block|
+        @providers << provider
+
+        "HealthMonitor::Providers::#{provider.capitalize}".constantize
+      end
     end
   end
 end

data/lib/health_monitor/providers/base.rb

@@ -2,15 +2,36 @@ module HealthMonitor
   module Providers
     class Base
       attr_reader :request
+      cattr_accessor :configuration
+
+      def self.configure
+        return unless configurable?
+
+        self.configuration ||= configuration_class.new
+
+        yield self.configuration if block_given?
+      end
 
       def initialize(request: nil)
         @request = request
+
+        self.class.configure
       end
 
       # @abstract
       def check!
         raise NotImplementedError
       end
+
+      private
+
+      def self.configurable?
+        configuration_class
+      end
+
+      # @abstract
+      def self.configuration_class
+      end
     end
   end
 end

data/lib/health_monitor/providers/sidekiq.rb

@@ -3,11 +3,19 @@ require 'sidekiq/api'
 
 module HealthMonitor
   module Providers
-    LATENCY_TIMEOUT = 30.freeze
-
     class SidekiqException < StandardError; end
 
     class Sidekiq < Base
+      class Configuration
+        DEFAULT_LATENCY_TIMEOUT = 30.freeze
+
+        attr_accessor :latency
+
+        def initialize
+          @latency = DEFAULT_LATENCY_TIMEOUT
+        end
+      end
+
       def check!
         check_workers!
         check_latency!
@@ -18,6 +26,10 @@ module HealthMonitor
 
       private
 
+      def self.configuration_class
+        Configuration
+      end
+
       def check_workers!
         ::Sidekiq::Workers.new.size
       end
@@ -25,7 +37,9 @@ module HealthMonitor
       def check_latency!
         latency = ::Sidekiq::Queue.new.latency
 
-        raise "latency #{latency} is greater than #{LATENCY_TIMEOUT}" if latency > LATENCY_TIMEOUT
+        if latency > self.configuration.latency
+          raise "latency #{latency} is greater than #{self.configuration.latency}"
+        end
       end
 
       def check_redis!

data/lib/health_monitor/version.rb

@@ -1,3 +1,3 @@
 module HealthMonitor
-  VERSION = '1.1.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health-monitor-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Leonid Beder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-13 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -213,3 +213,4 @@ specification_version: 4
 summary: Health monitoring Rails plug-in, which checks various services (db, cache,
   sidekiq, redis, etc.)
 test_files: []
+has_rdoc: