healthchecker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a9bc0e1293988838cf32b3091464c1467328fac
+  data.tar.gz: 41dd4ca7acec8aaca9b41d73188ad9d5c51306f2
+SHA512:
+  metadata.gz: 9dd66042574acd282da4d529ac0dd396210e503e157c1e2fc47222437eef57e284c1c4eb4f7852e4942b358f8641d4a982537197f91ab5d3a6088358f184d3b3
+  data.tar.gz: bef459651989aeb1a6ccef0af5f04ecd40ac89c985da363e78da9ea864ec380269a5a59684e16f147fbead9a84af16cbb0a4c77c59117f9b1e20aa1a29262088

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Healthchecker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/healthchecker/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/healthchecker/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/healthchecker/application_controller.rb

@@ -0,0 +1,4 @@
+module Healthchecker
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/healthchecker/health_controller.rb

@@ -0,0 +1,10 @@
+module Healthchecker
+  class HealthController < ActionController::Base
+
+    def show
+      checks = Healthchecker.perform_checks
+      render status: 500, json: {status: checks} and return unless checks.empty?
+      render json: {status: 'ok'}
+    end
+  end
+end

data/app/controllers/healthchecker/metrics_controller.rb

@@ -0,0 +1,24 @@
+module Healthchecker
+  class MetricsController < ActionController::Base
+
+    def show
+      render json: current_status
+    end
+
+    def current_status
+      {
+        redis: {
+          ok: (Redis.current.ping == 'PONG'),
+          config: Redis.current.client.options,
+        },
+        resque_redis:  {
+          ok: (Resque.redis.ping == 'PONG'),
+          config: Resque.redis.client.options,
+        },
+        uptime: (Time.now - Healthchecker::APPLICATION_STARTED_AT),
+      }
+    end
+
+
+  end
+end

data/app/helpers/healthchecker/application_helper.rb

@@ -0,0 +1,4 @@
+module Healthchecker
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/healthchecker/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Healthchecker</title>
+  <%= stylesheet_link_tag    "healthchecker/application", media: "all" %>
+  <%= javascript_include_tag "healthchecker/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Healthchecker::Engine.routes.draw do
+
+  get '/status' => 'health#show'
+  get '/metrics' => 'metrics#show'
+end

data/lib/healthchecker.rb

@@ -0,0 +1,29 @@
+require "healthchecker/engine"
+require 'healthchecker/base_check'
+require 'healthchecker/redis_check'
+require 'healthchecker/migration_check'
+require 'healthchecker/database_check'
+require 'healthchecker/cache_check'
+require 'healthchecker/s3_check'
+require 'healthchecker/solr_check'
+require 'healthchecker/dynamodb_check'
+
+module Healthchecker
+  APPLICATION_STARTED_AT = Time.now
+
+  mattr_accessor :checks
+  self.checks = []
+
+  def self.add_check(name_or_class, options={})
+    self.checks << lookup_class(name_or_class).new(options.merge(check: name_or_class))
+  end
+
+  def self.perform_checks
+    self.checks.map(&:perform_check).compact
+  end
+
+  def self.lookup_class(name_or_class)
+    return name_or_class if name_or_class.respond_to?(:new)
+    "Healthchecker::#{name_or_class.to_s.capitalize}Check".constantize
+  end
+end

data/lib/healthchecker/base_check.rb

@@ -0,0 +1,17 @@
+module Healthchecker
+  class BaseCheck
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def check!; raise NotImplementedError; end
+
+    def perform_check
+      check!
+    rescue RuntimeError => e
+      [e.class, e.message, options]
+    end
+  end
+end

data/lib/healthchecker/cache_check.rb

@@ -0,0 +1,15 @@
+require 'healthchecker/base_check'
+
+module Healthchecker
+  class CacheCheck < Healthchecker::BaseCheck
+
+    def check!
+      return if Rails.cache.write(cache_key, 'ok', :expires_in => 1.second)
+      raise 'Unable to write to rails cache.'
+    end
+
+    def cache_key
+      options[:cache_key] || SecureRandom.hex
+    end
+  end
+end

data/lib/healthchecker/database_check.rb

@@ -0,0 +1,10 @@
+require 'healthchecker/base_check'
+
+module Healthchecker
+  class DatabaseCheck < Healthchecker::BaseCheck
+
+    def check!
+      return if ActiveRecord::Migrator.current_version
+    end
+  end
+end

data/lib/healthchecker/dynamodb_check.rb

@@ -0,0 +1,15 @@
+require 'healthchecker/base_check'
+
+module Healthchecker
+  class DynamodbCheck < BaseCheck
+
+    def client
+      options[:client] || Aws::Dynamodb::Client.new
+    end
+
+    def check!
+      client.list_tables
+      nil
+    end
+  end
+end

data/lib/healthchecker/engine.rb

@@ -0,0 +1,7 @@
+require 'rails'
+
+module Healthchecker
+  class Engine < ::Rails::Engine
+    isolate_namespace Healthchecker
+  end
+end

data/lib/healthchecker/migration_check.rb

@@ -0,0 +1,10 @@
+require 'healthchecker/base_check'
+
+module Healthchecker
+  class MigrationCheck < Healthchecker::BaseCheck
+
+    def check!
+      ActiveRecord::Migration.check_pending!
+    end
+  end
+end

data/lib/healthchecker/redis_check.rb

@@ -0,0 +1,13 @@
+require 'healthchecker/base_check'
+
+module Healthchecker
+  class RedisCheck < Healthchecker::BaseCheck
+
+    def check!
+      client = options[:client] || Redis.new
+      result = client.ping
+      return if result == 'PONG'
+      raise "Redis returned #{result.inspect} instead of PONG"
+    end
+  end
+end

data/lib/healthchecker/s3_check.rb

@@ -0,0 +1,27 @@
+require 'healthchecker/base_check'
+
+module Healthchecker
+  class S3Check < Healthchecker::BaseCheck
+
+    def check!
+      options[:buckets].each {|bucket| check_bucket_access(bucket)}
+      nil
+    end
+
+    def client
+      options[:client] || Aws::S3::Client.new
+    end
+
+    def check_bucket_access(bucket)
+      object_key = options[:object_key] || "healthchecker/#{Time.now.to_i}.json"
+      client.put_object(body: 'ok', bucket: bucket, key: object_key)
+      raise "Could not read object from bucket '#{bucket}'" unless client.get_object(
+        bucket: bucket,
+        key: object_key,
+      ).body.read == 'ok'
+      client.delete_object(bucket: bucket, key: object_key)
+    end
+
+
+  end
+end

data/lib/healthchecker/solr_check.rb

@@ -0,0 +1,15 @@
+require 'healthchecker/base_check'
+
+module Healthchecker
+  class SolrCheck < BaseCheck
+
+    def client
+      options[:rsolr_client] || Sunspot::Session.new.send(:connection)
+    end
+
+    def check!
+      ping_success = client.head("admin/ping", :headers => {"Cache-Control" => "If-None-Match"}).response[:status] == 200
+      raise "Could not connect to solr" unless ping_success
+    end
+  end
+end

data/lib/healthchecker/version.rb

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

data/lib/tasks/healthchecker_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :healthchecker do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: healthchecker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Will Bryant
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: redis
+  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: aws-sdk
+  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: simplecov
+  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: sunspot_rails
+  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: Standardized, healthcheck end-point for rails apps
+email:
+- william@tout.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/assets/javascripts/healthchecker/application.js
+- app/assets/stylesheets/healthchecker/application.css
+- app/controllers/healthchecker/application_controller.rb
+- app/controllers/healthchecker/health_controller.rb
+- app/controllers/healthchecker/metrics_controller.rb
+- app/helpers/healthchecker/application_helper.rb
+- app/views/layouts/healthchecker/application.html.erb
+- config/routes.rb
+- lib/healthchecker.rb
+- lib/healthchecker/base_check.rb
+- lib/healthchecker/cache_check.rb
+- lib/healthchecker/database_check.rb
+- lib/healthchecker/dynamodb_check.rb
+- lib/healthchecker/engine.rb
+- lib/healthchecker/migration_check.rb
+- lib/healthchecker/redis_check.rb
+- lib/healthchecker/s3_check.rb
+- lib/healthchecker/solr_check.rb
+- lib/healthchecker/version.rb
+- lib/tasks/healthchecker_tasks.rake
+homepage: http://github.com/Tout/healthchecker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Standardized, healthcheck end-point for rails apps
+test_files: []