health-monitor-rails 0.0.1

data/README.md

@@ -0,0 +1,98 @@
+# health-monitor-rails
+
+[![Gem Version](https://badge.fury.io/rb/health-monitor-rails.png)](http://badge.fury.io/rb/health-monitor-rails)
+[![Build Status](https://travis-ci.org/lbeder/health-monitor-rails.png)](https://travis-ci.org/lbeder/health-monitor-rails)
+[![Dependency Status](https://gemnasium.com/lbeder/health-monitor-rails.png)](https://gemnasium.com/lbeder/health-monitor-rails)
+[![Coverage Status](https://coveralls.io/repos/lbeder/health-monitor-rails/badge.png)](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.).
+
+Mounting this gem will add a '/check' route to your application, which can be used for health monitoring the application and its various services.
+
+## Setup
+
+If you are using bundler add health-monitor-rails to your Gemfile:
+
+```ruby
+gem 'health-monitor-rails'
+```
+
+Then run:
+
+```bash
+$ bundle install
+```
+
+Otherwise install the gem:
+
+```bash
+$ gem install health-monitor-rails
+```
+
+## Usage
+You can mount this inside your app routes by adding this to config/routes.rb:
+
+```ruby
+mount HealthMonitor::Engine => '/health'
+```
+
+## Supported service providers
+The following services are currently supported:
+* DB
+* Cache
+* Redis
+* Sidekiq
+
+## Configuration
+
+### Adding providers
+By default, only the database check is enabled. You can add more service providers from an initializer:
+
+```ruby
+HealthMonitor.configure do |config|
+  config.providers += [:cache, :redis, :sidekiq]
+end
+```
+
+You can also override the list with a custom set of providers:
+```ruby
+HealthMonitor.configure do |config|
+  config.providers = [:sidekiq]
+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
+HealthMonitor.configure do |config|
+  config.error_callback = proc do |e|
+    logger.error "Health check failed with: #{e.message}"
+
+    Raven.capture_exception(e)
+  end
+end
+```
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2014
+
+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
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/health_controller.rb

@@ -0,0 +1,22 @@
+class HealthController < ActionController::Base
+  layout nil
+
+   # GET /health/check
+  def check
+    HealthMonitor.check!
+
+    render text: "Healh check has passed: #{Time.now.to_s(:db)}\n"
+  rescue Exception => e
+    render text: "Healh check has failed: #{Time.now.to_s(:db)}, error: #{e.message}\n",
+      :status => :service_unavailable
+  end
+
+  private
+  def process_with_silence(*args)
+    logger.quietly do
+      process_without_silence(*args)
+    end
+  end
+
+  alias_method_chain :process, :silence
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+HealthMonitor::Engine.routes.draw do
+  controller :health do
+    get :check
+  end
+end

data/lib/health-monitor-rails.rb

@@ -0,0 +1,4 @@
+require 'health_monitor/version'
+require 'health_monitor/engine'
+require 'health_monitor/configuration'
+require 'health_monitor/monitor'

data/lib/health_monitor/configuration.rb

@@ -0,0 +1,9 @@
+module HealthMonitor
+  class Configuration
+    attr_accessor :providers, :error_callback
+
+    def initialize
+      @providers = [:database]
+    end
+  end
+end

data/lib/health_monitor/engine.rb

@@ -0,0 +1,5 @@
+module HealthMonitor
+  class Engine < ::Rails::Engine
+    isolate_namespace HealthMonitor
+  end
+end

data/lib/health_monitor/monitor.rb

@@ -0,0 +1,27 @@
+require 'health_monitor/configuration'
+
+module HealthMonitor
+  extend self
+
+  attr_accessor :configuration
+
+  def configure
+    self.configuration ||= Configuration.new
+
+    yield configuration if block_given?
+  end
+
+  def check!
+    configuration.providers.each do |provider|
+      require "health_monitor/providers/#{provider}"
+
+      monitor = "HealthMonitor::Providers::#{provider.capitalize}".constantize.new
+      monitor.check!
+    end
+  rescue Exception => e
+    configuration.error_callback.call(e) if configuration.error_callback
+    raise
+  end
+end
+
+HealthMonitor.configure

data/lib/health_monitor/providers/cache.rb

@@ -0,0 +1,14 @@
+module HealthMonitor
+  module Providers
+    class Cache
+      def check!
+        time = Time.now.to_s
+
+        Rails.cache.write(:health, time)
+        fetched = Rails.cache.read(:health)
+
+        raise "different values (now: #{time}, fetched: #{fetched}" if fetched != time
+      end
+    end
+  end
+end

data/lib/health_monitor/providers/database.rb

@@ -0,0 +1,15 @@
+module HealthMonitor
+  module Providers
+    class DBException < StandardError; end
+
+    class Database
+      def check!
+        # Check connection to the DB:
+        query = 'SELECT version FROM schema_migrations'
+        ActiveRecord::Base.connection.select_value(query).to_i
+      rescue => e
+        raise DBException.new(e.message)
+      end
+    end
+  end
+end

data/lib/health_monitor/providers/redis.rb

@@ -0,0 +1,21 @@
+require 'redis/namespace'
+
+module HealthMonitor
+  module Providers
+    class RedisException < StandardError; end
+
+    class Redis
+      def check!
+        time = Time.now.to_s(:db)
+
+        r = ::Redis.new
+        r.set(:health, time)
+        fetched = r.get(:health)
+
+        raise "different values (now: #{time}, fetched: #{fetched}" if fetched != time
+      rescue => e
+        raise RedisException.new(e.message)
+      end
+    end
+  end
+end

data/lib/health_monitor/providers/sidekiq.rb

@@ -0,0 +1,15 @@
+require 'sidekiq'
+
+module HealthMonitor
+  module Providers
+    class SidekiqException < StandardError; end
+
+    class Sidekiq
+      def check!
+        ::Sidekiq::Workers.new.size
+      rescue => e
+        raise SidekiqException.new(e.message)
+      end
+    end
+  end
+end

data/lib/health_monitor/version.rb

@@ -0,0 +1,3 @@
+module HealthMonitor
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: health-monitor-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Leonid Beder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spork
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rediska
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Health monitoring Rails plug-in, which checks various services (db, cache,
+  sidekiq, redis, etc.).
+email:
+- leonid.beder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/health_controller.rb
+- config/routes.rb
+- lib/health-monitor-rails.rb
+- lib/health_monitor/configuration.rb
+- lib/health_monitor/engine.rb
+- lib/health_monitor/monitor.rb
+- lib/health_monitor/providers/cache.rb
+- lib/health_monitor/providers/database.rb
+- lib/health_monitor/providers/redis.rb
+- lib/health_monitor/providers/sidekiq.rb
+- lib/health_monitor/version.rb
+- Rakefile
+- README.md
+homepage: https://github.com/lbeder/health-monitor-rails
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2918892546612586905
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2918892546612586905
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Health monitoring Rails plug-in, which checks various services (db, cache,
+  sidekiq, redis, etc.)
+test_files: []