system_health 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96a950da89a77567a3adbde6e62909067be4f278
+  data.tar.gz: fd3e339d39b4d856d53146082098332936499b77
+SHA512:
+  metadata.gz: 3ba4232c8569ff43d3744a1eabba6d1e5e8057dbf6823dd9f279a28164fd1c64e4e502bbf85534c5a9b84530d4e900883e2279ebaad41aacaf3a08f850dd1d78
+  data.tar.gz: 225c639c4bb66d66ef166255657dd637c65c0721c6ac3a745df0280f4ad89634e4223df46da6fe8a376cc9144bfae9b175409d270b6897957ac4210cc95a6637

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-gemset

@@ -0,0 +1 @@
+system_health

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in system_health.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Stirling Olson
+
+MIT License
+
+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
+NONINFRINGEMENT. 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/README.md

@@ -0,0 +1,117 @@
+# System Health
+
+The System Health gem can be added to your Rails application to provide
+a convenient way to regularly look for bad data or other system health
+indicators.  It provides a single endpoint that will generate and error
+count and enumerate error messages.  This count and the messages can be
+collected by external monitoring tools the look for the HTTP status code
+(200 when there are no errors or 500 when there is at least one error)
+and/or inspect the JSON payload that is returned.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'system_health'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install system_health
+
+and then...
+
+1. create an initializer in config/initializers/system_health.rb
+
+  ```ruby
+  SystemHealth.configure do |config|
+    config.monitor_classes = [
+      SystemHealth::Monitors::BadData
+    ]
+  end
+  ```
+
+  This should define the SYSTEM_HEALTH_MONITOR_CLASSES array with all
+  your monitor classes.  There can be as many monitor classes as you wish.
+
+2. Create your monitor classes
+
+  In lib/system_health/monitors/bad_data.rb create:
+
+  ```ruby
+  module SystemHealth
+    module Monitors
+      class BadData < Base
+        def error_messages
+          ['some error message here'] if bad_data?
+        end
+
+        private
+
+        def bad_data?
+          # logic here
+        end
+      end
+    end
+  end
+  ```
+
+  Each monitor should define a public instance method for `error_messages`
+  as an array.  If that array is empty then the data is good.  When the
+  data is bad, one or more error messages can be placed in that array.
+  That is it!
+
+3. Define the environment variables
+
+  For applications hosted on Heroku, this might be something like:
+
+  ```bash
+  heroku config:add SYSTEM_HEALTH_MONITOR_USERNAME=somenamehere
+  heroku config:add SYSTEM_HEALTH_MONITOR_PASSWORD=somesecrethere
+  ```
+
+  on other environments, you'll need to define these elsewhere.
+
+## Usage
+
+The System Health gem exposes a single controller endpoint at:
+/system_health/monitor
+
+It will return a 200 HTTP status code if there are no errors and a 500
+HTTP status code if there are any errors.  It also returns a JSON
+payload with data like this:
+
+```json
+{
+  "error_count": 2,
+  "messages": ["some error message here", "another error message"]
+}
+```
+
+## To do?
+
+1. Consider how to deal with long running monitors that may fail with
+   page load limits (e.g. Heroku's 30 second timeout)
+2. Add ability to run different health monitors at different times or
+   possibly call monitors individually
+3. Add the ability to generate error notifications directly from System
+   Health instead of relying on external monitoring tools to send these
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/system_health/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## About Foraker Labs
+
+[![Foraker Logo](http://assets.foraker.com/attribution_logo.png)](https://www.foraker.com/)
+
+[Foraker Labs](https://www.foraker.com/) builds exciting web and mobile apps in Boulder, CO. Our work powers a wide variety of businesses with many different needs. We love open source software, and we're proud to contribute where we can. Interested to learn more? [Contact us today](https://www.foraker.com/contact-us).
+
+This project is maintained by Foraker Labs. The names and logos of Foraker Labs are fully owned and copyright Foraker Design, LLC.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/controllers/system_health/monitors_controller.rb

@@ -0,0 +1,21 @@
+module SystemHealth
+  class MonitorsController < ApplicationController
+    http_basic_authenticate_with \
+      name: ENV['SYSTEM_HEALTH_USERNAME'],
+      password: ENV['SYSTEM_HEALTH_PASSWORD']
+
+    def show
+      render json: monitor.as_json, status: monitor.http_status
+    end
+
+    private
+
+    def monitor
+      @monitor ||= SystemHealth::Monitor.new(monitor_classes)
+    end
+
+    def monitor_classes
+      SystemHealth.configuration.monitor_classes
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  namespace :system_health do
+    resource :monitor, :only => :show
+  end
+end

data/lib/system_health.rb

@@ -0,0 +1,19 @@
+require 'system_health/configuration'
+require 'system_health/engine'
+require 'system_health/monitor'
+require 'system_health/version'
+require 'system_health/monitors/base'
+
+module SystemHealth
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/system_health/configuration.rb

@@ -0,0 +1,5 @@
+module SystemHealth
+  class Configuration
+    attr_accessor :monitor_classes
+  end
+end

data/lib/system_health/engine.rb

@@ -0,0 +1,3 @@
+module SystemHealth
+  class Engine < Rails::Engine; end
+end

data/lib/system_health/monitor.rb

@@ -0,0 +1,33 @@
+module SystemHealth
+  class Monitor
+    def initialize(monitor_classes)
+      @monitor_classes = monitor_classes
+    end
+
+    def as_json(options = nil)
+      {
+        error_count: error_count,
+        messages: messages
+      }
+    end
+
+    def http_status
+      error_count > 0 ? 500 : 200
+    end
+
+    private
+    attr_reader :monitor_classes
+
+    def error_count
+      monitors.sum(&:error_count)
+    end
+
+    def messages
+      monitors.flat_map(&:error_messages)
+    end
+
+    def monitors
+      @monitors ||= monitor_classes.map(&:new)
+    end
+  end
+end

data/lib/system_health/monitors/base.rb

@@ -0,0 +1,9 @@
+module SystemHealth
+  module Monitors
+    class Base
+      def error_count
+        error_messages.count
+      end
+    end
+  end
+end

data/lib/system_health/version.rb

@@ -0,0 +1,3 @@
+module SystemHealth
+  VERSION = "0.0.1"
+end

data/spec/lib/system_health/monitor_spec.rb

@@ -0,0 +1,57 @@
+require 'active_support/all'
+require_relative '../../../lib/system_health/monitor'
+require_relative '../../../lib/system_health/monitors/base'
+
+module SystemHealth
+  describe Monitor do
+
+    class MonitorDouble < Monitors::Base
+      def error_messages
+        []
+      end
+    end
+
+    let(:monitor_classes) { [MonitorDouble] }
+    let(:monitor) { described_class.new(monitor_classes) }
+
+    context 'when errors' do
+      before do
+        allow_any_instance_of(MonitorDouble).
+          to receive(:error_messages).
+          and_return(['something broke'])
+      end
+
+      describe '#as_json' do
+        it 'returns error_count and messages' do
+          expect(monitor.as_json).to eq({
+            error_count: 1,
+            messages: ['something broke']
+          })
+        end
+      end
+
+      describe '#http_status' do
+        it 'returns 500' do
+          expect(monitor.http_status).to eq 500
+        end
+      end
+    end
+
+    context 'when no errors' do
+      describe '#as_json' do
+        it 'returns error_count and messages' do
+          expect(monitor.as_json).to eq({
+            error_count: 0,
+            messages: []
+          })
+        end
+      end
+
+      describe '#http_status' do
+        it 'returns 200 when no errors' do
+          expect(monitor.http_status).to eq 200
+        end
+      end
+    end
+  end
+end

data/system_health.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'system_health/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "system_health"
+  spec.version       = SystemHealth::VERSION
+  spec.authors       = ["Stirling Olson"]
+  spec.email         = ["seo@foraker.com"]
+  spec.summary       = %q{System health monitor for Rails apps}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: system_health
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stirling Olson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: ''
+email:
+- seo@foraker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/system_health/monitors_controller.rb
+- config/routes.rb
+- lib/system_health.rb
+- lib/system_health/configuration.rb
+- lib/system_health/engine.rb
+- lib/system_health/monitor.rb
+- lib/system_health/monitors/base.rb
+- lib/system_health/version.rb
+- spec/lib/system_health/monitor_spec.rb
+- system_health.gemspec
+homepage: ''
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: System health monitor for Rails apps
+test_files:
+- spec/lib/system_health/monitor_spec.rb