health-monitor-rails 8.4.0 → 8.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27a31a1555078820d1c0fa7ee3612ae60f4dfd43b0ce88501647cffc308e2626
-  data.tar.gz: 297a29de2083f06dc81223d7945c467c4df69a4abeb5fbdb31cef7d8291be481
+  metadata.gz: 54a0e9ca8f2f1fcb6f6d1d4ffd1db0be2f1d62fa712314b7d87960fe1ad10afb
+  data.tar.gz: cc2752aa4c9328401c81cf283a8a7b47f34fe06013abe08b6c8bd9225c8435d8
 SHA512:
-  metadata.gz: 2688e2f2713963db1a7f1fd79d37626c3ffe07a6a7b8abcdba6233fec43770732cb37ef49d39f38f631da70584d17f2286a5235f8d8fbeefc86bf238f1323284
-  data.tar.gz: 9c964066578783c8c82ea2244fd904c2426ca7d7a9fea822054643d5fe8675dc88c0ee10c77cac16935eb27bade34be3beadc14460f780bc5d4e5ac38023b4da
+  metadata.gz: 202a5a3d0bc1fbc2f7acd00e6f2e7ab0426705faf818c8b488fa623d3f6160329a7da5c8826958e8f53774e12d19e07bba025840eb665186b4db7c77f0bb918e
+  data.tar.gz: 34b10f0e4ec669e9f1299720c37e387a8e3480b6f19b242a6d4266d387da78a1768026eeda1aaecea3c6b89aa429952e17c6eef6d7e5e10f7fa9722cbcd77c22

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/health-monitor-rails.svg)](http://badge.fury.io/rb/health-monitor-rails)
 [![Build Status](https://travis-ci.org/lbeder/health-monitor-rails.svg)](https://travis-ci.org/lbeder/health-monitor-rails)
-[![Dependency Status](https://gemnasium.com/lbeder/health-monitor-rails.svg)](https://gemnasium.com/lbeder/health-monitor-rails)
 [![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.).
@@ -150,16 +149,17 @@ gem 'health-monitor-rails'
 Then run:
 
 ```bash
-$ bundle install
+bundle install
 ```
 
-Otherwise install the gem:
+Otherwise, install the gem:
 
 ```bash
-$ gem install health-monitor-rails
+gem install health-monitor-rails
 ```
 
 ## Usage
+
 You can mount this inside your app routes by adding this to config/routes.rb:
 
 ```ruby
@@ -167,7 +167,9 @@ mount HealthMonitor::Engine, at: '/'
 ```
 
 ## Supported Service Providers
+
 The following services are currently supported:
+
 * DB
 * Cache
 * Redis
@@ -178,6 +180,7 @@ The following services are currently supported:
 ## Configuration
 
 ### Adding Providers
+
 By default, only the database check is enabled. You can add more service providers by explicitly enabling them via an initializer:
 
 ```ruby
@@ -214,7 +217,7 @@ 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)
+    sidekiq_config.add_queue_configuration('critical', latency: 10.seconds, queue_size: 20)
   end
 end
 
@@ -236,22 +239,23 @@ 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 (maximim) of a queue which is considered unhealthy (the default is 100).
+* `queue_size`: the size (maximum) of a queue which is considered unhealthy (the default is 100).
 
 #### Redis
 
-* `url`: the url used to connect to your Redis instance - note, this is an optional configuration and will use the default connection if not specified
-* `connection`: Use custom redis connection (e.g., `Redis.current`).
+* `url`: the URL used to connect to your Redis instance - note, this is an optional configuration and will use the default connection if not specified
+* `connection`: Use custom Redis connection (e.g., `Redis.current`).
 * `max_used_memory`: Set maximum expected memory usage of Redis in megabytes. Prevent memory leaks and keys overstore.
 
 #### Delayed Job
 
-* `queue_size`: the size (maximim) of a queue which is considered unhealthy (the default is 100).
+* `queue_size`: the size (maximum) of a queue which is considered unhealthy (the default is 100).
 
 ### 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:
+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):
 
@@ -262,6 +266,7 @@ class CustomProvider < HealthMonitor::Providers::Base
   end
 end
 ```
+
 * Add its class to the configuration:
 
 ```ruby
@@ -271,6 +276,7 @@ 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:
 
 ```ruby
@@ -284,6 +290,7 @@ end
 ```
 
 ### Adding Authentication Credentials
+
 By default, the `/check` endpoint is not authenticated and is available to any user. You can authenticate using HTTP Basic Auth by providing authentication credentials:
 
 ```ruby
@@ -296,7 +303,8 @@ end
 ```
 
 ### Adding Environment Variables
-By default, environment variables is `nil`, so if you'd want to include additional parameters in the results JSON, all you need is to provide a `Hash` with your custom environment variables:
+
+By default, environment variables are `nil`, so if you'd want to include additional parameters in the results JSON, all you need is to provide a `Hash` with your custom environment variables:
 
 ```ruby
 HealthMonitor.configure do |config|
@@ -311,7 +319,7 @@ end
 
 A Nagios/Shinken/Icinga/Icinga2 plugin is available in `extra` directory.
 
-It takes one argument : `-u` or `--uri`
+It takes one argument: `-u` or `--uri`
 
 ```sh
 nicolas@desktop:$ ./check_rails.rb
@@ -325,7 +333,7 @@ Common options:
     -h, --help                       Displays Help
 ```
 
-And it generates an output with the right status code for your monitoring system :
+Also, it generates an output with the right status code for your monitoring system:
 
 ```sh
 nicolas@desktop:$ ./check_rails.rb -u http://admin:admin@localhost:5000/check.json

data/lib/health_monitor/providers/base.rb

@@ -20,6 +20,7 @@ module HealthMonitor
         @request = request
 
         return unless self.class.configurable?
+
         self.configuration = self.class.instance_variable_get('@global_configuration')
       end
 

data/lib/health_monitor/providers/sidekiq.rb

@@ -11,15 +11,31 @@ module HealthMonitor
         DEFAULT_LATENCY_TIMEOUT = 30
         DEFAULT_QUEUES_SIZE = 100
 
-        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 }
+          @queues[DEFAULT_QUEUE_NAME] = { latency: DEFAULT_LATENCY_TIMEOUT, queue_size: DEFAULT_QUEUES_SIZE }
+        end
+
+        def latency=(value)
+          default_queue[:latency] = value
+        end
+
+        def latency
+          default_queue[:latency]
+        end
+
+        def queue_size=(value)
+          default_queue[:queue_size] = value
+        end
+
+        def queue_size
+          default_queue[:queue_size]
+        end
+
+        def default_queue
+          queues[DEFAULT_QUEUE_NAME]
         end
 
         def add_queue_configuration(queue_name, latency: DEFAULT_LATENCY_TIMEOUT, queue_size: DEFAULT_QUEUES_SIZE)

data/lib/health_monitor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health-monitor-rails
 version: !ruby/object:Gem::Version
-  version: 8.4.0
+  version: 8.5.0
 platform: ruby
 authors:
 - Leonid Beder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-17 00:00:00.000000000 Z
+date: 2019-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -224,16 +224,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -261,7 +261,6 @@ files:
 - app/controllers/health_monitor/health_controller.rb
 - app/views/health_monitor/health/check.html.erb
 - config/routes.rb
-- lib/health-monitor-rails.rb
 - lib/health_monitor/configuration.rb
 - lib/health_monitor/engine.rb
 - lib/health_monitor/monitor.rb
@@ -273,6 +272,7 @@ files:
 - lib/health_monitor/providers/resque.rb
 - lib/health_monitor/providers/sidekiq.rb
 - lib/health_monitor/version.rb
+- lib/health_monitor_rails.rb
 homepage: https://github.com/lbeder/health-monitor-rails
 licenses:
 - MIT
@@ -293,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Health monitoring Rails plug-in, which checks various services (db, cache,