status-page 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5af2f060a08cd8558560479bcc2f1e051751c99d
+  data.tar.gz: 6eec97daa50456360a14693c331485b42cb69c40
+SHA512:
+  metadata.gz: a505245fe787bd9c95f98e80d79f2ccefb84ed4a4d2502789a73b7c8c8a4962d6d4dc6f0873de37550959d197b65fa86734bdbc3bbabd3ccc74582a01434533e
+  data.tar.gz: ef15709301c85a6f58362bd7428ddd7ffa3cb8e0d3683434c1f6a8805c5da0e1c581c7cedcc2fc9e535c3d98a2dc56c69c1ca48f80a0563ecc7da8b5ddc94705

data/README.md

@@ -0,0 +1,111 @@
+# status-page
+
+[![Gem Version](https://badge.fury.io/rb/status-page.svg)](http://badge.fury.io/rb/status-page) [![Build Status](https://travis-ci.org/rails-engine/status-page.svg)](https://travis-ci.org/rails-engine/status-page) [![Dependency Status](https://gemnasium.com/rails-engine/status-page.svg)](https://gemnasium.com/rails-engine/status-page) [![Coverage Status](https://coveralls.io/repos/rails-engine/status-page/badge.svg)](https://coveralls.io/r/rails-engine/status-page)
+
+Mountable status page for your Rails application, to check (DB, Cache, Sidekiq, Redis, etc.).
+
+Mounting this gem will add a '/status' 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 service.
+
+## Example
+
+<img src="https://cloud.githubusercontent.com/assets/5518/14341727/c12ccdee-fcc6-11e5-8c25-00324d0e9baa.png" />
+
+## Install
+
+```ruby
+# Gemfile
+gem 'status-page'
+```
+
+Then run:
+
+```bash
+$ bundle install
+```
+
+```ruby
+# config/routes.rb
+mount StatusPage::Engine, at: '/'
+```
+
+## Supported service services
+
+The following services are currently supported:
+
+* DB
+* Cache
+* Redis
+* Sidekiq
+* Resque
+
+## Configuration
+
+### Adding services
+
+By default, only the database check is enabled. You can add more service services by explicitly enabling them via an initializer:
+
+```ruby
+StatusPage.configure do
+  # Cache check status result 10 seconds
+  self.interval = 10
+  # Use service
+  self.use :database
+  self.use :cache
+  self.use :redis
+  self.use :sidekiq
+end
+```
+
+### Adding a custom service
+
+It's also possible to add custom health check services suited for your needs (of course, it's highly appreciated and encouraged if you'd contribute useful services to the project).
+
+In order to add a custom service, you'd need to:
+
+* Implement the `StatusPage::Services::Base` class and its `check!` method (a check is considered as failed if it raises an exception):
+
+```ruby
+class CustomService < StatusPage::Services::Base
+  def check!
+    raise 'Oh oh!'
+  end
+end
+```
+* Add its class to the config:
+
+```ruby
+StatusPage.configure do
+  self.add_custom_service(CustomProvider)
+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
+StatusPage.configure do
+  self.error_callback = proc do |e|
+    logger.error "Health check failed with: #{e.message}"
+
+    Raven.capture_exception(e)
+  end
+end
+```
+
+### Adding authentication credentials
+
+By default, the `/status` endpoint is not authenticated and is available to any user. You can authenticate using HTTP Basic Auth by providing authentication credentials:
+
+```ruby
+StatusPage.configure do
+  self.basic_auth_credentials = {
+    username: 'SECRET_NAME',
+    password: 'Shhhhh!!!'
+  }
+end
+```
+
+## License
+
+The MIT License (MIT)

data/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+RuboCop::RakeTask.new

data/app/controllers/status_page/status_controller.rb

@@ -0,0 +1,35 @@
+module StatusPage
+  class StatusController < ActionController::Base
+    before_action :authenticate_with_basic_auth
+
+    def index
+      @statuses = statuses
+
+      respond_to do |format|
+        format.html
+        format.json {
+          render json: statuses
+        }
+        format.xml {
+          render xml: statuses
+        }
+      end
+    end
+
+    private
+
+    def statuses
+      return @statuses if defined? @statuses
+      @statuses = StatusPage.check(request: request)
+    end
+
+    def authenticate_with_basic_auth
+      return true unless StatusPage.config.basic_auth_credentials
+
+      credentials = StatusPage.config.basic_auth_credentials
+      authenticate_or_request_with_http_basic do |name, password|
+        name == credentials[:username] && password == credentials[:password]
+      end
+    end
+  end
+end

data/app/views/status_page/status/index.html.erb

@@ -0,0 +1,71 @@
+
+<!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-size: 14px;
+    background-color: #f0f0f0;
+    margin: 0;
+    padding: 0;
+    color: #000;
+    text-align: center;
+  }
+
+  .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; }
+  </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>
+</body>

data/config/routes.rb

@@ -0,0 +1,3 @@
+StatusPage::Engine.routes.draw do
+  resources :status
+end

data/lib/status-page.rb

@@ -0,0 +1,9 @@
+# rubocop:disable Style/FileName
+
+require 'status-page/version'
+require 'status-page/engine'
+require 'status-page/configuration'
+require 'status-page/monitor'
+require 'status-page/services/base'
+
+# rubocop:enable Style/FileName

data/lib/status-page/configuration.rb

@@ -0,0 +1,33 @@
+module StatusPage
+  class Configuration
+    attr_accessor :error_callback, :basic_auth_credentials, :interval
+    attr_reader :providers
+
+    def initialize
+      @providers = Set.new
+      @interval = 10
+    end
+
+    def use(service_name)
+      require "status-page/services/#{service_name}"
+      add_service("StatusPage::Services::#{service_name.capitalize}".constantize)
+    end
+
+    def add_custom_service(custom_service_class)
+      unless custom_service_class < StatusPage::Services::Base
+        raise ArgumentError.new 'custom provider class must implement '\
+          'StatusPage::Services::Base'
+      end
+
+      add_service(custom_service_class)
+    end
+
+    private
+
+    def add_service(provider_class)
+      (@providers ||= Set.new) << provider_class
+
+      provider_class
+    end
+  end
+end

data/lib/status-page/engine.rb

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

data/lib/status-page/monitor.rb

@@ -0,0 +1,57 @@
+module StatusPage
+  STATUSES = {
+    ok: 'OK',
+    error: 'ERROR'
+  }.freeze
+
+  class << self
+    def config
+      return @config if defined?(@config)
+      @config = Configuration.new
+      @config
+    end
+
+    def configure(&block)
+      config.instance_exec(&block)
+    end
+
+    def check(request: nil)
+      if config.interval > 0
+        if @cached_status && @cached_status[:timestamp] >= (config.interval || 5).seconds.ago
+          return @cached_status
+        end
+      end
+
+      providers = config.providers || []
+      results = providers.map { |provider| provider_result(provider, request) }
+
+      @cached_status = {
+        results: results,
+        status: results.all? { |result| result[:status] == STATUSES[:ok] } ? :ok : :service_unavailable,
+        timestamp: Time.now
+      }
+      @cached_status
+    end
+
+    private
+
+    def provider_result(provider, request)
+      monitor = provider.new(request: request)
+      monitor.check!
+
+      {
+        name: provider.service_name,
+        message: '',
+        status: STATUSES[:ok]
+      }
+    rescue => e
+      config.error_callback.call(e) if config.error_callback
+
+      {
+        name: provider.service_name,
+        message: e.message,
+        status: STATUSES[:error]
+      }
+    end
+  end
+end

data/lib/status-page/services/base.rb

@@ -0,0 +1,39 @@
+module StatusPage
+  module Services
+    class Base
+      attr_reader :request
+      cattr_accessor :config
+
+      def self.service_name
+        @name ||= name.demodulize
+      end
+
+      def self.configure
+        return unless configurable?
+
+        self.config ||= config_class.new
+
+        yield self.config if block_given?
+      end
+
+      def initialize(request: nil)
+        @request = request
+
+        self.class.configure
+      end
+
+      # @abstract
+      def check!
+        raise NotImplementedError
+      end
+
+      def self.configurable?
+        config_class
+      end
+
+      # @abstract
+      def self.config_class
+      end
+    end
+  end
+end

data/lib/status-page/services/cache.rb

@@ -0,0 +1,24 @@
+module StatusPage
+  module Services
+    class CacheException < StandardError; end
+
+    class Cache < Base
+      def check!
+        time = Time.now.to_s
+
+        Rails.cache.write(key, time)
+        fetched = Rails.cache.read(key)
+
+        raise "different values (now: #{time}, fetched: #{fetched})" if fetched != time
+      rescue Exception => e
+        raise CacheException.new(e.message)
+      end
+
+      private
+
+      def key
+        @key ||= ['status-cache', request.try(:remote_ip)].join(':')
+      end
+    end
+  end
+end

data/lib/status-page/services/database.rb

@@ -0,0 +1,14 @@
+module StatusPage
+  module Services
+    class DatabaseException < StandardError; end
+
+    class Database < Base
+      def check!
+        # Check connection to the DB:
+        ActiveRecord::Migrator.current_version
+      rescue Exception => e
+        raise DatabaseException.new(e.message)
+      end
+    end
+  end
+end

data/lib/status-page/services/redis.rb

@@ -0,0 +1,29 @@
+require 'redis/namespace'
+
+module StatusPage
+  module Services
+    class RedisException < StandardError; end
+
+    class Redis < Base
+      def check!
+        time = Time.now.to_s(:db)
+
+        redis = ::Redis.new
+        redis.set(key, time)
+        fetched = redis.get(key)
+
+        raise "different values (now: #{time}, fetched: #{fetched})" if fetched != time
+      rescue Exception => e
+        raise RedisException.new(e.message)
+      ensure
+        redis.client.disconnect
+      end
+
+      private
+
+      def key
+        @key ||= ['status-redis', request.try(:remote_ip)].join(':')
+      end
+    end
+  end
+end

data/lib/status-page/services/resque.rb

@@ -0,0 +1,15 @@
+require 'resque'
+
+module StatusPage
+  module Services
+    class ResqueException < StandardError; end
+
+    class Resque < Base
+      def check!
+        ::Resque.info
+      rescue Exception => e
+        raise ResqueException.new(e.message)
+      end
+    end
+  end
+end

data/lib/status-page/services/sidekiq.rb

@@ -0,0 +1,56 @@
+require 'sidekiq/api'
+
+module StatusPage
+  module Services
+    class SidekiqException < StandardError; end
+
+    class Sidekiq < Base
+      class Configuration
+        DEFAULT_LATENCY_TIMEOUT = 30
+
+        attr_accessor :latency
+
+        def initialize
+          @latency = DEFAULT_LATENCY_TIMEOUT
+        end
+      end
+
+      def check!
+        check_workers!
+        check_latency!
+        check_redis!
+      rescue Exception => e
+        raise SidekiqException.new(e.message)
+      end
+
+      private
+
+      class << self
+        private
+
+        def config_class
+          Configuration
+        end
+      end
+
+      def check_workers!
+        sidekiq_stats = ::Sidekiq::Stats.new
+        if sidekiq_stats.processes_size == 0
+          raise "Sidekiq alive processes is 0."
+        end
+      end
+
+      def check_latency!
+        latency = ::Sidekiq::Queue.new.latency
+
+        return unless latency > config.latency
+
+        raise "latency #{latency} is greater than #{config.latency}"
+      end
+
+      def check_redis!
+        ::Sidekiq.redis(&:info)
+      end
+    end
+  end
+end

data/lib/status-page/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module StatusPage
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: status-page
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Leonid Beder
+- Jason Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Health monitoring Rails plug-in, which checks various services (db, cache,
+  sidekiq, redis, etc.).
+email:
+- leonid.beder@gmail.com
+- huacnlee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/controllers/status_page/status_controller.rb
+- app/views/status_page/status/index.html.erb
+- config/routes.rb
+- lib/status-page.rb
+- lib/status-page/configuration.rb
+- lib/status-page/engine.rb
+- lib/status-page/monitor.rb
+- lib/status-page/services/base.rb
+- lib/status-page/services/cache.rb
+- lib/status-page/services/database.rb
+- lib/status-page/services/redis.rb
+- lib/status-page/services/resque.rb
+- lib/status-page/services/sidekiq.rb
+- lib/status-page/version.rb
+homepage: https://github.com/rails-engine/status-page
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.2
+signing_key: 
+specification_version: 4
+summary: Health monitoring Rails plug-in, which checks various services (db, cache,
+  sidekiq, redis, etc.)
+test_files: []