health-monitor-rails 8.1.0 → 8.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45a2acf586e0293d542d08a5747ba0a824341726
-  data.tar.gz: 9fa6652ef77b8d2c1c330f57f3e4d85a7fe14867
+  metadata.gz: 4d71ec5ebaa809a23436eae3e97ab65b13f6a9ce
+  data.tar.gz: 5babeadd3fd6ee6c39cefe18057082a0f119bbfe
 SHA512:
-  metadata.gz: b0807e93a9b5582879d988e798408f8cdd66f94ae83fca0529e2e3ecae6fbf6c7c19d87e28849a9e5e211eab486515f00267ac1e7a005995ec548d1000913e85
-  data.tar.gz: fb0dcdab32f5854c6ae2b3e647b0c5010dc1a4f0ba349449b825cd6a54a946df5c647fd395e057c68d649f039feb227753f2af12ed169b21c8b849b68d625efd
+  metadata.gz: 57d6d72d415c2922eb1108a4a037a160d24b229be501915ccabe0f7550ac30cd34bac899efc964802e5c188c989d955bc60a0f9961ebbcafe918fa7ccf6b34aa
+  data.tar.gz: 76d9aa1af004e01451e7730052570e476faf75aca9e27ced22e0a0785c564c11ba5437f6bda4393d1a1f4399035c7443bec579e129fa5d3a953ce943f8066013

data/README.md

@@ -9,6 +9,8 @@ This is a health monitoring Rails mountable plug-in, which checks various servic
 
 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 an HTML/JSON/XML response representing the state of each provider.
 
+You can filter which checks to run by passing a parameter called ```providers```.
+
 ## Examples
 
 ### HTML Status Page
@@ -50,6 +52,31 @@ Mounting this gem will add a '/check' route to your application, which can be us
 }
 ```
 
+### Filtered JSON Response
+
+```bash
+>> curl -s http://localhost:3000/check.json?providers[]=database&providers[]=redis | json_pp
+```
+
+```json
+{
+   "timestamp" : "2017-03-10 17:07:52 +0200",
+   "status" : "ok",
+   "results" : [
+      {
+         "name" : "Database",
+         "message" : "",
+         "status" : "OK"
+      },
+      {
+         "status" : "OK",
+         "message" : "",
+         "name" : "Redis"
+      },
+   ]
+}
+```
+
 ### XML Response
 
 ```bash
@@ -86,6 +113,32 @@ Mounting this gem will add a '/check' route to your application, which can be us
 </hash>
 ```
 
+### Filtered XML Response
+
+```bash
+>> curl -s http://localhost:3000/check.xml?providers[]=database&providers[]=redis
+```
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <results type="array">
+    <result>
+      <name>Database</name>
+      <message></message>
+      <status>OK</status>
+    </result>
+    <result>
+      <name>Redis</name>
+      <message></message>
+      <status>OK</status>
+    </result>
+  </results>
+  <status type="symbol">ok</status>
+  <timestamp>2017-03-10 17:08:50 +0200</timestamp>
+</hash>
+```
+
 ## Setup
 
 If you are using bundler add health-monitor-rails to your Gemfile:
@@ -157,6 +210,14 @@ HealthMonitor.configure do |config|
     sidekiq_config.queue_size = 50
   end
 end
+
+# To configure specific queues
+HealthMonitor.configure do |config|
+  config.sidekiq.configure do |sidekiq_config|
+    sidekiq_config.add_queue_configuration("critical", latency: 10.seconds, size: 20)
+  end
+end
+
 ```
 
 ```ruby

data/app/controllers/health_monitor/health_controller.rb

@@ -25,7 +25,7 @@ module HealthMonitor
     private
 
     def statuses
-      res = HealthMonitor.check(request: request)
+      res = HealthMonitor.check(request: request, params: providers_params)
       res.merge(env_vars)
     end
 
@@ -42,5 +42,9 @@ module HealthMonitor
         name == credentials[:username] && password == credentials[:password]
       end
     end
+
+    def providers_params
+      params.permit(providers: [])
+    end
   end
 end

data/lib/health-monitor-rails.rb

@@ -1,8 +1,4 @@
-# rubocop:disable Naming/FileName
-
 require 'health_monitor/version'
 require 'health_monitor/engine'
 require 'health_monitor/configuration'
 require 'health_monitor/monitor'
-
-# rubocop:enable Naming/FileName

data/lib/health_monitor/monitor.rb

@@ -16,8 +16,13 @@ module HealthMonitor
     yield configuration if block_given?
   end
 
-  def check(request: nil)
-    results = configuration.providers.map { |provider| provider_result(provider, request) }
+  def check(request: nil, params: {})
+    providers = configuration.providers
+    if params[:providers].present?
+      providers = providers.select { |provider| params[:providers].include?(provider.provider_name.downcase) }
+    end
+
+    results = providers.map { |provider| provider_result(provider, request) }
 
     {
       results: results,

data/lib/health_monitor/providers/delayed_job.rb

@@ -40,7 +40,7 @@ module HealthMonitor
         raise "queue size #{size} is greater than #{configuration.queue_size}"
       end
 
-      private def job_class
+      def job_class
         @job_class ||= ::Delayed::Job
       end
     end

data/lib/health_monitor/providers/sidekiq.rb

@@ -7,14 +7,25 @@ module HealthMonitor
 
     class Sidekiq < Base
       class Configuration
+        DEFAULT_QUEUE_NAME = 'default'.freeze
         DEFAULT_LATENCY_TIMEOUT = 30
         DEFAULT_QUEUES_SIZE = 100
 
-        attr_accessor :latency, :queue_size
+        attr_accessor :latency, :queue_size, :queue_name
+        attr_reader :queues
 
         def initialize
+          @queue_name = DEFAULT_QUEUE_NAME
           @latency = DEFAULT_LATENCY_TIMEOUT
           @queue_size = DEFAULT_QUEUES_SIZE
+          @queues = {}
+          @queues[queue_name] = { latency: latency, queue_size: queue_size }
+        end
+
+        def add_queue_configuration(queue_name, latency: DEFAULT_LATENCY_TIMEOUT, queue_size: DEFAULT_QUEUES_SIZE)
+          raise SidekiqException.new('Queue name is mandatory') if queue_name.blank?
+
+          queues[queue_name] = { latency: latency, queue_size: queue_size }
         end
       end
 
@@ -25,7 +36,7 @@ module HealthMonitor
         check_queue_size!
         check_redis!
       rescue Exception => e
-        raise SidekiqException.new(e.message)
+        raise SidekiqException.new(e)
       end
 
       private
@@ -50,19 +61,18 @@ module HealthMonitor
       end
 
       def check_latency!
-        latency = queue.latency
-
-        return unless latency > configuration.latency
+        configuration.queues.each do |queue, config|
+          latency = queue(queue).latency
 
-        raise "latency #{latency} is greater than #{configuration.latency}"
+          raise "queue '#{queue}': latency #{latency} is greater than #{config[:latency]}" if latency > config[:latency]
+        end
       end
 
       def check_queue_size!
-        size = queue.size
-
-        return unless size > configuration.queue_size
-
-        raise "queue size #{size} is greater than #{configuration.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
 
       def check_redis!
@@ -73,8 +83,9 @@ module HealthMonitor
         end
       end
 
-      private def queue
-        @queue ||= ::Sidekiq::Queue.new
+      def queue(queue_name)
+        @queue ||= {}
+        @queue[queue_name] ||= ::Sidekiq::Queue.new(queue_name)
       end
     end
   end

data/lib/health_monitor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HealthMonitor
-  VERSION = '8.1.0'.freeze
+  VERSION = '8.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health-monitor-rails
 version: !ruby/object:Gem::Version
-  version: 8.1.0
+  version: 8.3.0
 platform: ruby
 authors:
 - Leonid Beder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails