wellness 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40af274c19cbb00938818ef0631110dacb17ab42
+  data.tar.gz: 5ba2fb05f9af7596a65c53abe0e8736d3e9618df
+SHA512:
+  metadata.gz: d142661b49a6691d62decd0ff70bcd21fa7743ded4402a2ddcf4e626d27029ab41f2c9d8e677bd4f023cfc2af7e12336c53e6bd093d2290a2791ac33f0650739
+  data.tar.gz: f7e046d436b3181a7f2e5b29714d6d731f4f6e1dcf10408699c5bc85a9dff9fb8ca9f6b1aca9644885de5503633d64230e2d0cb0a369a7f423fde9e02c253d42

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+wellness

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matthew Johnston
+
+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,106 @@
+# Wellness
+
+A rack middleware library that adds a health check to your service. It comes
+with pre made services and has the option and flexibility for you to make your
+own.
+
+## Usage - Rails
+
+There are some pre configured services that are provided with this gem.
+However, you must require them when you need them. This is because they have
+external dependencies that need to be loaded, that your application may not
+necessarily have.
+
+```rb
+# app/config/application.rb
+
+# Add this to the top just below the bundler requires
+require 'wellness/services/postgres_service'
+require 'wellness/services/redis_service'
+
+# Within the configuration block
+system = Wellness::System.new('my-uber-duber-app')
+pg = Wellness::Services::PostgresService.new({
+  host: ENV['POSTGRESQL_HOST'],
+  port: ENV['POSTGRESQL_PORT'],
+  database: ENV['POSTGRESQL_DATABASE'],
+  user: ENV['POSTGRESQL_USERNAME'],
+  password: ENV['POSTGRESQL_PASSWORD']
+})
+redis = Wellness::Services::RedisService.new({
+  host: ENV['REDIS_HOST']
+})
+system.add_service('database', pg)
+system.add_service('redis', redis)
+config.middleware.insert_before('::ActiveRecord::QueryCache', 'Wellness::Checker', system)
+```
+
+## Usage - Sinatra
+
+```ruby
+require 'wellness'
+require 'wellness/services/postgres_service'
+require 'wellness/services/redis_service'
+
+system = Wellness::System.new('my-uber-duber-app')
+pg = Wellness::Services::PostgresService.new({
+  host: ENV['POSTGRESQL_HOST'],
+  port: ENV['POSTGRESQL_PORT'],
+  database: ENV['POSTGRESQL_DATABASE'],
+  user: ENV['POSTGRESQL_USERNAME'],
+  password: ENV['POSTGRESQL_PASSWORD']
+})
+redis = Wellness::Services::RedisService.new({
+  host: ENV['REDIS_HOST']
+})
+system.add_service('database', pg)
+system.add_service('redis', redis)
+
+use(Wellness::Checker, system)
+```
+
+## Custom Services
+
+Creating custom services is really easy. Always extend
+`Wellness::Services::Base`.
+
+Once that is done, you must implement the `#check` method.
+
+The parameters passed into the service at creation are stored under `#params`.
+Under no circumstances, should you ever modify the original parameters list at
+run time. It can lead to unintended consequences, and weird bugs.
+
+```ruby
+# Your custom service
+class MyCustomService < Wellness::Services::Base
+  def check
+    if params[:foo]
+      passed_check
+      {
+        'status': 'HEALTHY'
+      }
+    else
+      failed_check
+      {
+        'status': 'UNHEALTHY'
+      }
+    end
+  end
+end
+
+# Initialize the wellness system
+system = Wellness::System.new('my-app')
+service = MyCustomService.new({foo: 'bar'})
+system.add_service('some service', service)
+
+# Load it into your rack
+use(Wellness::Checker, system)
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/wellness.rb

@@ -0,0 +1,7 @@
+module Wellness
+end
+
+require 'wellness/version'
+require 'wellness/services/base'
+require 'wellness/system'
+require 'wellness/checker'

data/lib/wellness/checker.rb

@@ -0,0 +1,42 @@
+module Wellness
+
+  class Checker
+    def initialize(app, system, options={})
+      @app = app
+      @system = system
+
+      # Optional arguments
+      @health_status_path  = options[:status_path]  || '/health/status'
+      @health_details_path = options[:details_path] || '/health/details'
+    end
+
+    def call(env)
+      case env['PATH_INFO']
+        when @health_status_path
+          health_status(env)
+        when @health_details_path
+          health_details(env)
+        else
+          @app.call(env)
+      end
+    end
+
+    def health_status(env)
+      if @system.check
+        [200, {'Content-Type' => 'text/json'}, [{status: 'HEALTHY'}.to_json]]
+      else
+        [500, {'Content-Type' => 'text/json'}, [{status: 'UNHEALTHY'}.to_json]]
+      end
+
+    end
+
+    def health_details(env)
+      if @system.check
+        [200, {'Content-Type' => 'text/json'}, [@system.to_json]]
+      else
+        [500, {'Content-Type' => 'text/json'}, [@system.to_json]]
+      end
+    end
+  end
+
+end

data/lib/wellness/services/base.rb

@@ -0,0 +1,48 @@
+module Wellness
+  module Services
+
+    # @author Matthew A. Johnston
+    class Base
+      def initialize(params={})
+        @params = params
+        @health = false
+      end
+
+      # Flags the check as failed
+      def failed_check
+        @health = false
+      end
+
+      # Flags the check as passed
+      def passed_check
+        @health = true
+      end
+
+      def params
+        @params.dup
+      end
+
+      # Returns true if the service is healthy, otherwise false
+      # @return [Boolean]
+      def healthy?
+        !!@health
+      end
+
+      # @return [Hash]
+      def call
+        @last_check = self.check
+      end
+
+      # @return [Hash]
+      def check
+        {}
+      end
+
+      # @return [Hash]
+      def last_check
+        @last_check || {}
+      end
+    end
+
+  end
+end

data/lib/wellness/services/postgres_service.rb

@@ -0,0 +1,63 @@
+require 'pg'
+require 'wellness/services/base'
+
+module Wellness
+  module Services
+
+    # @author Matthew A. Johnston
+    class PostgresService < Wellness::Services::Base
+      def check
+        case ping
+          when PG::Constants::PQPING_NO_ATTEMPT
+            ping_failed('no attempt made to ping')
+          when PG::Constants::PQPING_NO_RESPONSE
+            ping_failed('no response from ping')
+          when PG::Constants::PQPING_REJECT
+            ping_failed('ping was rejected')
+          else
+            ping_successful
+        end
+      end
+
+      private
+
+      def ping
+        PG::Connection.ping(connection_options)
+      end
+
+      # @return [Hash]
+      def connection_options
+        {
+          host: self.params[:host],
+          port: self.params[:port],
+          dbname: self.params[:database],
+          user: self.params[:user],
+          password: self.params[:password]
+        }
+      end
+
+      # @param message [String] the reason it failed
+      # @return [Hash]
+      def ping_failed(message)
+        failed_check
+        {
+          status: 'UNHEALTHY',
+          details: {
+            error: message
+          }
+        }
+      end
+
+      # @return [Hash]
+      def ping_successful
+        passed_check
+        {
+          status: 'HEALTHY',
+          details: {
+          }
+        }
+      end
+    end
+
+  end
+end

data/lib/wellness/services/redis_service.rb

@@ -0,0 +1,46 @@
+require 'redis'
+require 'wellness/services/base'
+
+module Wellness
+  module Services
+
+    class RedisService < Wellness::Services::Base
+      KEYS = [
+        'used_memory_human',
+        'connected_clients',
+        'keyspace_misses',
+        'keyspace_hits',
+        'evicted_keys',
+        'expired_keys',
+        'sync_partial_err',
+        'sync_partial_ok',
+        'sync_full',
+        'rejected_connections',
+        'total_commands_processed',
+        'total_connections_received',
+        'uptime_in_seconds',
+        'uptime_in_days'
+      ]
+
+      def check
+        client  = Redis.new(self.params)
+        details = client.info.select { |k,_| KEYS.include?(k) }
+
+        passed_check
+        {
+          status: 'HEALTHY',
+          details: details
+        }
+      rescue Redis::BaseError => error
+        failed_check
+        {
+          status: 'UNHEALTHY',
+          details: {
+            error: error.message
+          }
+        }
+      end
+    end
+
+  end
+end

data/lib/wellness/services/sidekiq_service.rb

@@ -0,0 +1,39 @@
+module Wellness
+  module Services
+
+    # @author Matthew A. Johnston
+    class SidekiqService < Wellness::Services::Base
+      KEYS = %w(redis_stats uptime_in_days connected_clients used_memory_human used_memory_peak_human)
+
+      def check
+        sidekiq_stats = Sidekiq::Stats.new
+        queue = Sidekiq::Queue.new
+        redis = Redis.new(host: params[:redis_host])
+        redis_stats = redis.info.select { |k, _| KEYS.include?(k) }
+        workers_size = redis.scard("workers").to_i
+
+        {
+          status: 'HEALTHY',
+          details: {
+            processed: sidekiq_stats.processed,
+            failed: sidekiq_stats.failed,
+            busy: workers_size,
+            enqueued: sidekiq_stats.enqueued,
+            scheduled: sidekiq_stats.scheduled_size,
+            retries: sidekiq_stats.retry_size,
+            default_latency: queue.latency,
+            redis: redis_stats
+          }
+        }
+      rescue => error
+        {
+          status: 'UNHEALTHY',
+          details: {
+            error: error.message
+          }
+        }
+      end
+    end
+
+  end
+end

data/lib/wellness/system.rb

@@ -0,0 +1,63 @@
+module Wellness
+
+  # @author Matthew A. Johnston
+  class System
+    attr_reader :name, :services
+
+    attr_accessor :details
+
+    # @param name [String] the name of the system
+    def initialize(name)
+      @name = name
+      @services = Hash.new
+      @details = Hash.new
+    end
+
+    # Add a service to this system
+    #
+    # @param name [String, Symbol] the name of the service
+    # @param service [Wellness::Service] the service you wish to add
+    def add_service(name, service)
+      @services[name] = service
+    end
+
+    # Remove a service from this system
+    #
+    # @param name [String, Symbol]
+    # @return [Wellness::Service] the service removed, else nil
+    def remove_service(name)
+      @services.delete(name)
+    end
+
+    # Checks all of the services
+    # @return
+    def check
+      @services.values.each { |service| service.call }
+      healthy?
+    end
+
+    # Returns true if the system is healthy, false otherwise
+    #
+    # @return [Boolean]
+    def healthy?
+      @services.values.all? { |service| service.healthy? }
+    end
+
+    def to_json(*)
+      dependencies = Hash.new
+
+      @services.each do |name, service|
+        dependencies[name] = service.last_check
+      end
+
+      data = {
+        status: (healthy? ? 'HEALTHY' : 'UNHEALTHY'),
+        details: @details,
+        dependencies: dependencies
+      }
+
+      data.to_json
+    end
+  end
+
+end

data/lib/wellness/version.rb

@@ -0,0 +1,3 @@
+module Wellness
+  VERSION = '0.1.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'wellness'

data/spec/wellness/checker_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Wellness::Checker do
+  pending
+end

data/spec/wellness/system_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Wellness::System do
+  let(:name) { 'testing-app' }
+  let(:system) { described_class.new(name) }
+
+  describe '#name' do
+    subject { system.name }
+    it 'equals "testing-app"' do
+      expect(subject).to eq(name)
+    end
+  end
+
+  describe '#add_service' do
+    let(:service) { double('Service')  }
+    subject { system.add_service('foo', service) }
+
+    it 'adds the service to the system' do
+      expect { subject }.to change(system.services, :length).to(1)
+    end
+  end
+
+  describe '#remove_service' do
+    let(:service) { double('Service')  }
+    subject { system.remove_service('foo') }
+    before { system.add_service('foo', service) }
+    it 'removes the service from the system' do
+      expect { subject }.to change(system.services, :length).to(0)
+    end
+  end
+
+end

data/wellness.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wellness/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wellness'
+  spec.version       = Wellness::VERSION
+  spec.authors       = ['Matthew Johnston']
+  spec.email         = ['warmwaffles@gmail.com']
+  spec.description   = 'A rack middleware health check'
+  spec.summary       = 'A rack middleware health check'
+  spec.homepage      = 'https://github.com/warmwaffles/wellness'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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('rack', '~> 1.5')
+
+  spec.add_development_dependency('bundler', '~> 1.3')
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec')
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: wellness
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Johnston
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: A rack middleware health check
+email:
+- warmwaffles@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wellness.rb
+- lib/wellness/checker.rb
+- lib/wellness/services/base.rb
+- lib/wellness/services/postgres_service.rb
+- lib/wellness/services/redis_service.rb
+- lib/wellness/services/sidekiq_service.rb
+- lib/wellness/system.rb
+- lib/wellness/version.rb
+- spec/spec_helper.rb
+- spec/wellness/checker_spec.rb
+- spec/wellness/system_spec.rb
+- wellness.gemspec
+homepage: https://github.com/warmwaffles/wellness
+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.1.11
+signing_key: 
+specification_version: 4
+summary: A rack middleware health check
+test_files:
+- spec/spec_helper.rb
+- spec/wellness/checker_spec.rb
+- spec/wellness/system_spec.rb