health-monitor-rails 3.0.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5ca7cbb4392ffa1363a87b40c2816d4de722ae0
-  data.tar.gz: 59b5e9e6d382fa61e2e11f065e09c993da777fd0
+  metadata.gz: 43cd56ba93149b6cd9603a232f6d42e733244997
+  data.tar.gz: 53f5306701a6e8a9318aa27c65c1553f2ba39f97
 SHA512:
-  metadata.gz: 07f4c55dde7f10f8019df3c3177d34e44104ccf259334060f7747d843c09e82c62779998f46b600a442f859b68135c60fdaa9e93157c1b103e9d62d7bdce24a2
-  data.tar.gz: 703925424ed0d6aa9450140616f92052fbf1cc11d1002a01e26e48d886f36e73dcab4c2ef46fa294df224ecc67b9cb90de61bedd82cb90d4c59d12afcb4a80b0
+  metadata.gz: f2906eff933ec100b18abf659ac3e9143328f9f13d1460ef903b3ebac53c4964a32ea3a69d847c54fdea84d1b3d63622df504ce2d6973722aae1d7dc16116e42
+  data.tar.gz: 76f14766d0c328686449107a7e3532af95e1c058ba363b81f484e17fd8c16fd2f341560b00ecaa9acc70b850805ec272bc1488b02a7733f0118d3c61efa52d7d

data/README.md

@@ -7,7 +7,7 @@
 
 This is a health monitoring Rails mountable plug-in, which checks various services (db, cache, sidekiq, redis, etc.).
 
-Mounting this gem will add a '/check' route to your application, which can be used for health monitoring the application and its various services.
+Mounting this gem will add a '/check' route to your application, which can be used for health monitoring the application and its various services. The method will return an appropriate HTTP status as well as a JSON array representing the state of each provider.
 
 ## Setup
 

data/app/controllers/health_monitor/health_controller.rb

@@ -8,13 +8,11 @@ module HealthMonitor
 
     # GET /health/check
     def check
-      HealthMonitor.check!(request: request)
+      res = HealthMonitor.check(request: request)
 
-      self.status = :ok
-      self.response_body = "Health check has passed: r#{Time.now.to_s(:db)}\n"
-    rescue => e
-      self.status = :service_unavailable
-      self.response_body = "Health check has failed: #{Time.now.to_s(:db)}, error: #{e.message}\n"
+      self.content_type = Mime::JSON
+      self.status = res[:status]
+      self.response_body = ActiveSupport::JSON.encode(res[:results])
     end
 
     private

data/lib/health_monitor/monitor.rb

@@ -1,6 +1,11 @@
 require 'health_monitor/configuration'
 
 module HealthMonitor
+  STATUSES = {
+    ok: 'OK',
+    error: 'ERROR'
+  }.freeze
+
   extend self
 
   attr_accessor :configuration
@@ -11,15 +16,38 @@ module HealthMonitor
     yield configuration if block_given?
   end
 
-  def check!(request: nil)
-    configuration.providers.each do |provider|
-      monitor = provider.new(request: request)
-      monitor.check!
-    end
+  def check(request: nil)
+    results = configuration.providers.map { |provider| provider_result(provider, request) }
+
+    {
+      results: results,
+      status: results.all? { |res| res.values.first[:status] == STATUSES[:ok] } ? :ok : :service_unavailable
+    }
+  end
+
+  private
+
+  def provider_result(provider, request)
+    monitor = provider.new(request: request)
+    monitor.check!
+
+    {
+      provider.provider_name => {
+        message: '',
+        status: STATUSES[:ok],
+        timestamp: Time.now.to_s(:db)
+      }
+    }
   rescue => e
     configuration.error_callback.call(e) if configuration.error_callback
 
-    raise
+    {
+      provider.provider_name => {
+        message: e.message,
+        status: STATUSES[:error],
+        timestamp: Time.now.to_s(:db)
+      }
+    }
   end
 end
 

data/lib/health_monitor/providers/base.rb

@@ -4,6 +4,10 @@ module HealthMonitor
       attr_reader :request
       cattr_accessor :configuration
 
+      def self.provider_name
+        @name ||= name.demodulize.downcase
+      end
+
       def self.configure
         return unless configurable?
 

data/lib/health_monitor/providers/cache.rb

@@ -11,7 +11,7 @@ module HealthMonitor
         Rails.cache.write(key, time)
         fetched = Rails.cache.read(key)
 
-        raise "different values (now: #{time}, fetched: #{fetched}" if fetched != time
+        raise "different values (now: #{time}, fetched: #{fetched})" if fetched != time
       rescue Exception => e
         raise CacheException.new(e.message)
       end

data/lib/health_monitor/providers/redis.rb

@@ -13,7 +13,7 @@ module HealthMonitor
         redis.set(key, time)
         fetched = redis.get(key)
 
-        raise "different values (now: #{time}, fetched: #{fetched}" if fetched != time
+        raise "different values (now: #{time}, fetched: #{fetched})" if fetched != time
       rescue Exception => e
         raise RedisException.new(e.message)
       ensure

data/lib/health_monitor/version.rb

@@ -1,3 +1,3 @@
 module HealthMonitor
-  VERSION = '3.0.2'.freeze
+  VERSION = '4.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health-monitor-rails
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 4.0.0
 platform: ruby
 authors:
 - Leonid Beder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-31 00:00:00.000000000 Z
+date: 2015-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !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'
 - !ruby/object:Gem::Dependency
   name: rediska
   requirement: !ruby/object:Gem::Requirement
@@ -221,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Health monitoring Rails plug-in, which checks various services (db, cache,