health-monitor-rails 7.0.1 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 638ebb5182d38187748d38c7a35b4b42c0ebcec0
-  data.tar.gz: 4a3b4b8b63ee3a75f269b89344f98a092196aa37
+  metadata.gz: 5c8cfa2355d53ebd52b3fcfca54155d487327ca9
+  data.tar.gz: d2ebfea5cce81c6873e2238c9c5a1118b1a3bda4
 SHA512:
-  metadata.gz: d5c1670fba58e56615e639b841107ae2c810244e3fcfd0bbe09ed1506daf73db01baf55586b24ee0a20697c8cc931b5cfcb4f5bfc078491e6872821ea69b1973
-  data.tar.gz: 94c51cd8a0b2ea1990867a92c7eed43ec14cfb6fa6b294dadca3350f42d237fcb2ead3c30595ec565776225b285664a8a1ef2a11716b30cb088cb5569156c68e
+  metadata.gz: 4d545e866dd23e34b6461f8c6d2b5f4750322dfce9e0915d510b45d62b092dcd14f69dd5ed8fc5c95683ccd6275a3878c0c6762ccf97df1277b82ed0b23ee8fe
+  data.tar.gz: aab2f11832003e6329e916a3ae6b4a01502cab105f16463b6c4bedf39e53ace458ae414bda30b103f370581d65051bda88419c4630683f608ffab4200bdea367

data/README.md

@@ -155,12 +155,25 @@ HealthMonitor.configure do |config|
 end
 ```
 
+```ruby
+HealthMonitor.configure do |config|
+  config.redis.configure do |redis_config|
+    redis_config.url = 'redis://user:pass@example.redis.com:90210/'
+  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).
 
+#### 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
+
+
 ### 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).
 
@@ -220,11 +233,57 @@ HealthMonitor.configure do |config|
 end
 ```
 
+### Monitoring script
+
+A Nagios/Shinken/Icinga/Icinga2 plugin is available in `extra` directory.
+
+It takes one argument : `-u` or `--uri`
+
+```sh
+nicolas@desktop:$ ./check_rails.rb
+missing argument: uri
+
+Usage: check_rails.rb -u uri
+    -u, --uri URI                    The URI to check (https://nagios:nagios@example.com/check.json)
+
+Common options:
+    -v, --version                    Displays Version
+    -h, --help                       Displays Help
+```
+
+And 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
+Rails application : OK
+
+Database : OK
+Cache : OK
+Redis : OK
+Sidekiq : OK
+
+nicolas@desktop:$ echo $?
+0
+```
+
+```sh
+nicolas@desktop:$ ./check_rails.rb -u http://admin:admin@localhost:5000/check.json
+Rails application : ERROR
+
+Database : OK
+Cache : OK
+Redis : ERROR (Error connecting to Redis on 127.0.0.1:6379 (Errno::ECONNREFUSED))
+Sidekiq : ERROR (Error connecting to Redis on 127.0.0.1:6379 (Errno::ECONNREFUSED))
+
+nicolas@desktop:$ echo $?
+2
+```
+
 ## License
 
 The MIT License (MIT)
 
-Copyright (c) 2014
+Copyright (c) 2017
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/lib/health_monitor/providers/redis.rb

@@ -5,10 +5,28 @@ module HealthMonitor
     class RedisException < StandardError; end
 
     class Redis < Base
+      class Configuration
+        DEFAULT_URL = nil
+
+        attr_accessor :url
+
+        def initialize
+          @url = DEFAULT_URL
+        end
+      end
+
+      class << self
+        private
+
+        def configuration_class
+          ::HealthMonitor::Providers::Redis::Configuration
+        end
+      end
+
       def check!
         time = Time.now.to_s(:rfc2822)
 
-        redis = ::Redis.new
+        redis = configuration.url ? ::Redis.new(url: configuration.url) : ::Redis.new
         redis.set(key, time)
         fetched = redis.get(key)
 

data/lib/health_monitor/providers/sidekiq.rb

@@ -30,7 +30,7 @@ module HealthMonitor
         private
 
         def configuration_class
-          Configuration
+          ::HealthMonitor::Providers::Sidekiq::Configuration
         end
       end
 

data/lib/health_monitor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health-monitor-rails
 version: !ruby/object:Gem::Version
-  version: 7.0.1
+  version: 7.1.0
 platform: ruby
 authors:
 - Leonid Beder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 2017-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails