health-monitor-rails 6.0.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80b8977ef32f20d4a2147ac94c20a47cefc71dc2
-  data.tar.gz: 7470f8ddefba24b30177f3ac09121713472bf248
+  metadata.gz: f4686976a383f5c4b5e85369cfc0c752e4caddc8
+  data.tar.gz: 15031a662f7188298f468ef51bb6c63dc862884d
 SHA512:
-  metadata.gz: 07c9439fb3c3d0c3e4da625a871c88574944a5d0dd6725b7ed991fd5ed4041040d97e2b8a4b43dec866fd9132239f878e0cc0bec59f3a12501e50cc0205082ce
-  data.tar.gz: e4a2ee7273afcd46506689930e92204428937ed96f0048a2f04028d5eb182d3a88fa5093a7fde7461f9a9bfca97c5e90e3445ccdd0502fe83fa6fad44ed3ec09
+  metadata.gz: fdf0b7c905ee120037d83b864b163b6da1c80b27c859a24efa24e5ed5acde6386cbacfe539cc7b917a2ec56888584b8c8b14080c81350320ac206fe923685986
+  data.tar.gz: 1d74eed9701d6c17d112564d5526783ce6026c5757396181ea0caa7a820f4d604e6168061dfbb52dd89e8769b3e71c3e52c87ff35109ec67c54e5df45d3f9178

data/README.md

@@ -7,7 +7,84 @@
 
 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. The method will return an appropriate HTTP status as well as a JSON array representing the state of each provider.
+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.
+
+## Examples
+
+### HTML Status Page
+
+![alt example](/docs/screenshots/example.png "HTML Status Page")
+
+### JSON response
+
+```bash
+>> curl -s http://localhost:3000/check.json | json_pp
+```
+
+```json
+{
+   "timestamp" : "2017-03-10 17:07:52 +0200",
+   "status" : "ok",
+   "results" : [
+      {
+         "name" : "Database",
+         "message" : "",
+         "status" : "OK"
+      },
+      {
+         "status" : "OK",
+         "message" : "",
+         "name" : "Cache"
+      },
+      {
+         "status" : "OK",
+         "message" : "",
+         "name" : "Redis"
+      },
+      {
+         "status" : "OK",
+         "message" : "",
+         "name" : "Sidekiq"
+      }
+   ]
+}
+```
+
+### XML response
+
+```bash
+>> curl -s http://localhost:3000/check.xml
+```
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <results type="array">
+    <result>
+      <name>Database</name>
+      <message></message>
+      <status>OK</status>
+    </result>
+    <result>
+      <name>Cache</name>
+      <message></message>
+      <status>OK</status>
+    </result>
+    <result>
+      <name>Redis</name>
+      <message></message>
+      <status>OK</status>
+    </result>
+    <result>
+      <name>Sidekiq</name>
+      <message></message>
+      <status>OK</status>
+    </result>
+  </results>
+  <status type="symbol">ok</status>
+  <timestamp>2017-03-10 17:08:50 +0200</timestamp>
+</hash>
+```
 
 ## Setup
 

data/app/controllers/health_monitor/health_controller.rb

@@ -6,22 +6,32 @@ module HealthMonitor
       before_action :authenticate_with_basic_auth
     end
 
-    # GET /health/check
     def check
-      res = HealthMonitor.check(request: request)
-
-      HealthMonitor.configuration.environment_variables ||= {}
-      v = HealthMonitor.configuration.environment_variables.merge(time: Time.now.to_s(:db))
-      env_vars = [environment_variables: v]
-      res[:results] = env_vars + res[:results]
+      @statuses = statuses
 
-      self.content_type = Mime[:json]
-      self.status = res[:status]
-      self.response_body = ActiveSupport::JSON.encode(res[:results])
+      respond_to do |format|
+        format.html
+        format.json do
+          render json: statuses
+        end
+        format.xml do
+          render xml: statuses
+        end
+      end
     end
 
     private
 
+    def statuses
+      res = HealthMonitor.check(request: request)
+      res.merge(env_vars)
+    end
+
+    def env_vars
+      v = HealthMonitor.configuration.environment_variables || {}
+      v.empty? ? {} : { environment_variables: v }
+    end
+
     def authenticate_with_basic_auth
       return true unless HealthMonitor.configuration.basic_auth_credentials
 

data/app/views/health_monitor/health/check.html.erb

@@ -0,0 +1,79 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Status</title>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width">
+  <style type="text/css" media="screen">
+  body {
+    line-height: 2rem;
+    font-family: sans;
+    font-size: 14px;
+    background-color: #f0f0f0;
+    margin: 0;
+    padding: 0;
+    color: #000;
+    text-align: center;
+  }
+
+  a { color: #333; }
+
+  .container {
+    width: 960px;
+    margin: 20px auto;
+    text-align: left;
+  }
+
+  h1 {
+    font-weight: normal;
+    line-height: 2.8rem;
+    font-size: 30px;
+    letter-spacing: -1px;
+    text-align: center;
+    color: #333;
+  }
+
+  .container {
+    width: 960px;
+    margin:40px auto;
+    overflow: hidden;
+  }
+
+  .statuses {
+    background: #FFF;
+    width: 100%;
+    border-radius: 5px;
+  }
+  .statuses h1 { border-radius: 5px 5px 0 0; background: #f9f9f9; padding: 10px; border-bottom: 1px solid #eee;}
+  .statuses .status { font-size: 14px; border-bottom: 1px solid #eee; padding: 15px; }
+  .statuses .status:last-child { border-bottom: 0px; }
+  .statuses .name { font-size: 20px; margin-right: 20px; min-width: 100px; font-weight: bold; color: #555; }
+  .statuses .state { font-size: 14px; float: right; width: 80px; color: #45b81d; }
+  .statuses .message { color: #666; }
+  .statuses .timestamp { width: 130px; color: #999; }
+  .statuses .status-error .state { color: red; }
+
+  .powered { text-align: center; margin-top: 10px; color: #aaa; }
+  .powered a { color: #666; }
+  </style>
+</head>
+
+<body>
+  <div class="container">
+    <div class="statuses">
+      <h1>Status Page</h1>
+      <% @statuses[:results].each do |status| %>
+      <div class="status status-<%= status[:status].downcase %>">
+        <div class="status-heading">
+          <span class="name"><%= status[:name]  %></span>
+          <span class="state"><%= status[:status] %></span>
+        </div>
+        <div class="message"><%= status[:message] %></div>
+      </div>
+      <% end %>
+    </div>
+    <div class="powered">
+      Powered by <a href="https://github.com/lbeder/health-monitor-rails" target="_blank">health-monitor-rails</a>
+    </div>
+  </div>
+</body>

data/lib/health_monitor/monitor.rb

@@ -21,7 +21,8 @@ module HealthMonitor
 
     {
       results: results,
-      status: results.all? { |res| res.values.first[:status] == STATUSES[:ok] } ? :ok : :service_unavailable
+      status: results.all? { |res| res[:status] == STATUSES[:ok] } ? :ok : :service_unavailable,
+      timestamp: Time.now.to_s(:rfc2822)
     }
   end
 
@@ -32,21 +33,17 @@ module HealthMonitor
     monitor.check!
 
     {
-      provider.provider_name => {
-        message: '',
-        status: STATUSES[:ok],
-        timestamp: Time.now.to_s(:db)
-      }
+      name: provider.provider_name,
+      message: '',
+      status: STATUSES[:ok]
     }
   rescue => e
     configuration.error_callback.call(e) if configuration.error_callback
 
     {
-      provider.provider_name => {
-        message: e.message,
-        status: STATUSES[:error],
-        timestamp: Time.now.to_s(:db)
-      }
+      name: provider.provider_name,
+      message: e.message,
+      status: STATUSES[:error]
     }
   end
 end

data/lib/health_monitor/providers/base.rb

@@ -5,7 +5,7 @@ module HealthMonitor
       cattr_accessor :configuration
 
       def self.provider_name
-        @name ||= name.demodulize.downcase
+        @name ||= name.demodulize
       end
 
       def self.configure

data/lib/health_monitor/providers/redis.rb

@@ -6,7 +6,7 @@ module HealthMonitor
 
     class Redis < Base
       def check!
-        time = Time.now.to_s(:db)
+        time = Time.now.to_s(:rfc2822)
 
         redis = ::Redis.new
         redis.set(key, time)

data/lib/health_monitor/providers/sidekiq.rb

@@ -47,7 +47,11 @@ module HealthMonitor
       end
 
       def check_redis!
-        ::Sidekiq.redis(&:info)
+        if ::Sidekiq.respond_to?(:redis_info)
+          ::Sidekiq.redis_info
+        else
+          ::Sidekiq.redis(&:info)
+        end
       end
     end
   end

data/lib/health_monitor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health-monitor-rails
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Leonid Beder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-26 00:00:00.000000000 Z
+date: 2017-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -220,6 +220,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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: capybara-screenshot
+  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'
 description: Health monitoring Rails plug-in, which checks various services (db, cache,
   sidekiq, redis, etc.).
 email:
@@ -231,6 +259,7 @@ files:
 - README.md
 - Rakefile
 - 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