rt_health_monitor 0.8.0.pre.rc1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13cb464b9e81668abf4c5dc72a0f48c6e1834e0ebb4e19dcbe51a73ee5a1cb5e
-  data.tar.gz: 66d0c9256a656bbf89ffa4abb59ba4bb5ee81cb38be3281effc4899fb44bac3b
+  metadata.gz: 29ef2a8b6dbcb15e9907509cd8492093223ea64936b8defaf70c0d23da579303
+  data.tar.gz: 3cc46a14eb1eff4d33a21ee5577c11fc47bd92d2992aa6bb3f48bc0494861715
 SHA512:
-  metadata.gz: 6f26b2584e91dfd22b718412fcbbb7d970e074e78b844cd494628b0f0a322f308297840440aac31fbc1cbea32a89598a5023e063722d8d3a0a46dd987188d2b4
-  data.tar.gz: '092792193524f8f4f553299cbed038f4371daf1bba63ec6d42d4d2ec807891aa6e2bdcf9152c69e41b15c813f5024ef020efc77886584d05ac65e405b282af80'
+  metadata.gz: 1fdd9ce1c136b4b0c94919922c701e8de13f24c8369ba9fe8c90c5c36642a9963f7f0c5a0e0dd78ea28dc0261a7be3d1696578868e24002146e9330e0cf6bd8d
+  data.tar.gz: c2c78c6dc7bec506708f6473bff73b8f064dfc6944790a6b626bcc81c7c3af4f7d0ccfbc085a7e242e9d35817463e99968bdcd7c5798ca66e989a148bc81992d

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/Changelog.md

@@ -2,6 +2,15 @@ Changelog
 ===
 
 master
+---
+
+v0.8.0
+---
+
+- Renamed gem to `rt_health_monitor`.  The directory names are still the same,
+  so you don't have to change your `require`s yet.
+- Refactored HealthMonitor middleware
+- The middleware now returns 503 instead of 200 if one of the checks failed.
 
 v0.7.2
 ---

data/README.md

@@ -1,14 +1,26 @@
-Purpose
-=======
+# rt_health_monitor
 
-* Get information about your applications health status easily
+[![Gem Version](https://badge.fury.io/rb/rt_health_monitor.svg)](https://badge.fury.io/rb/rt_health_monitor)
 
-Usage
-=====
+Get information about your applications health status easily.
 
-Add the gem to your Gemfile
+## Installation
 
-    gem 'rt_health_monitor', require: 'health_monitor'
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rt_health_monitor', require: 'health_monitor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rt_health_monitor
+
+## Usage
 
 Add the middleware to your config.
 
@@ -16,101 +28,118 @@ Add the middleware to your config.
 
 Add to you Rails configuration (config/application.rb)
 
-    module <ApplicationName>
-      class Application < Rails::Application
-        config.middleware.use ::HealthMonitorMiddleware, "your_application_name"
-      end
-    end
+```ruby
+module <ApplicationName>
+  class Application < Rails::Application
+    config.middleware.use ::HealthMonitorMiddleware, "your_application_name"
+  end
+end
+```
 
 ### Sinatra
 
 Add to config.ru
 
-    use HealthMonitorMiddleware, "your_application_name"
+```ruby
+use HealthMonitorMiddleware, "your_application_name"
+```
 
 ### Padrino
 
 Add to config/apps.rb
 
-    Padrino.use(HealthMonitorMiddleware, "your_application_name")
-
+```ruby
+Padrino.use(HealthMonitorMiddleware, "your_application_name")
+```
 
 ## Configure your dependencies
 
-Put into some place which is loaded on startup, like config/initializer/health_monitor_initializer.rb
+Put into some place which is loaded on startup, like
+`config/initializer/health_monitor_initializer.rb`
+
+```ruby
+HealthMonitorMiddleware.add("simple", name: "MySQL") { User.where{id > 0}.limit(1) }
 
-    HealthMonitorMiddleware.add("simple", name: "MySQL") { User.where{id > 0}.limit(1) }
-  
-    HealthMonitorMiddleware.add("service", name: 'some_service_name') { RestClient.get(File.join(service-url, 'healthmonitor')) }
+HealthMonitorMiddleware.add("service", name: 'some_service_name') { RestClient.get(File.join(service-url, 'healthmonitor')) }
+```
 
-Simple-Monitor needs some block which returns true or false for up an down state. Service-Monitor needs an block which returns a complete status response in JSON format. This may be just the health-monitor used by a service.
+Simple-Monitor needs some block which returns true or false for up an down
+state. Service-Monitor needs an block which returns a complete status response
+in JSON format. This may be just the health-monitor used by a service.
 
 ## Outcome
 
-As soon as the middleware is configured and your application is running, you can acess the health monitor status page adding 'healthmonitor' to your url. It does not depend on the given path.
+As soon as the middleware is configured and your application is running, you can
+acess the health monitor status page adding 'health_monitor' to your url. It does
+not depend on the given path.
 
-    http://your_application_url_with_some_path/healthmonitor
+    http://your_application_url_with_some_path/health_monitor
 
-This would lead to the following output f.e.:
+This would lead to the following output:
 
+```json
+{
+  "status": "down",
+  "name": "my app",
+  "simple": [
     {
-      status: "down",
-      name: "my app",
-      simple: [
-      {
-        status: "up",
-        name: "MySQL",
-        time: 0.2758502960205078
-      },
-      {
-        status: "up",
-        name: "Memcached",
-        time: 1.4078617095947266
-      },
-      {
-        status: "up",
-        name: "Resque",
-        time: 3.2737255096435547
-      }
-      ],
-      service: [
-      {
-        status: "down",
-        name: "routes",
-        time: 1295.3431606292725
-      },
-      {
-        status: "up",
-        name: "appendix",
-        info: {
-          simple: [
-            {
-              status: "up",
-              name: "MongoDB",
-              time: 6.000041961669922
-            },
-            {
-              status: "up",
-              name: "MySQL",
-              time: 0
-            }
-          ]
-        },
-        time: 23.989439010620117
+      "status": "up",
+      "name": "MySQL",
+      "time": 0.2758502960205078
+    },
+    {
+      "status": "up",
+      "name": "Memcached",
+      "time": 1.4078617095947266
+    },
+    {
+      "status": "up",
+      "name": "Resque",
+      "time": 3.2737255096435547
+    }
+  ],
+  "service": [
+    {
+      "status": "down",
+      "name": "routes",
+      "time": 1295.3431606292725
+    },
+    {
+      "status": "up",
+      "name": "appendix",
+      "info": {
+        "simple": [
+          {
+            "status": "up",
+            "name": "MongoDB",
+            "time": 6.000041961669922
+          },
+          {
+            "status": "up",
+            "name": "MySQL",
+            "time": 0
+          }
+        ]
       },
+      "time": 23.989439010620117
+    },
     ...
-    }
+  ]
+}
+```
 
 
 ## Sidekiq Health Check Task
 
-A task for performing a Sidekiq health check is also included. To use that, just add the following line to your `Rakefile`
+A task for performing a Sidekiq health check is also included. To use that, just
+add the following line to your `Rakefile`
 
 ```ruby
 require "health_monitor/rake_task"
 ```
 
-You must have a `environment` task in your `Rakefile` which loads the environment.  Rails already provides such a task.
+You must have a `environment` task in your `Rakefile` which loads the
+environment.  Rails already provides such a task.
 
 A simple environment task looks like this:
 

data/lib/health_monitor/version.rb

@@ -1,3 +1,3 @@
 class HealthMonitor
-  VERSION = "0.8.0.pre.rc1"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rt_health_monitor
 version: !ruby/object:Gem::Version
-  version: 0.8.0.pre.rc1
+  version: 0.8.0
 platform: ruby
 authors:
 - Martin Fuehrlinger
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-16 00:00:00.000000000 Z
+date: 2018-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -107,9 +107,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.3