heartcheck 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e39de52c0e3369ba3f24cacb17f7e94bb3c9b7db
-  data.tar.gz: dbbcb953fee4a354df8076ae6793e18f9c0f0ca0
+  metadata.gz: 9a438aab551507bb1d4e8ec150534d5555ee6de5
+  data.tar.gz: 50536531483c713aa998d859ddeba43fe3723a2e
 SHA512:
-  metadata.gz: 9e1d759f37c904a90a1504925af260c5360ab24353fe643633b66fa0ef1bccf4b2d0dd52283f1dd6d655b983a2ee30515ce38c48deed615a1457adccb00b267b
-  data.tar.gz: eecbb54ce967716e78ee7912ba96e90616ea1960641809cbe39a7afc65184b148dade6564d7179f106bfe5d68630a4f8d6bcc391da3185599d6f4bf72c6de93b
+  metadata.gz: 6f7a5808ea6b8f8de2eafa651e07daf4dfdaa4f8b1c2192a37893b1c1c087f3ae238235079493c3f0fdbee1e572b234cf058ed962e7473acb503861f0cb7a4aa
+  data.tar.gz: 430f2303f3c4386d32ef5aed5c6f77a82bd977b462b2daf19ab31f4151d686c4a9c99a8ff1f598beb0726e49da8e92d8d197f6c9dcd73e8add39c2ca797846c8

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+*.rbc
+.bundle
+.DS_Store
+.rbenv-gemsets
+.ruby-gemset
+.ruby-version
+.rvmrc
+.yardoc
+doc

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Documentation:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false
+
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - '**/*.gemspec'
+    - '**/Rakefile'

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+  - "2.1.5"
+  - "2.2.1"
+  - "2.2.2"
+install: bundle install -j 4 --retry 3
+script:
+  - bin/rspec

data/CHANGELOG

@@ -0,0 +1,6 @@
+= Heart Check - Changelog
+
+== Version 1.0.0 :: 2015-02-02
+
+  * Inital release.
+

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    heartcheck (1.0.5)
+      oj
+      rack (~> 1, >= 1.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.0.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    oj (2.12.10)
+    parser (2.2.2.6)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.0.9)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rainbow (2.0.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    rubocop (0.27.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.7, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    slop (3.6.0)
+    thor (0.19.1)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  heartcheck!
+  pry-nav (~> 0.2.0, >= 0.2.4)
+  rack-test (~> 0.6.0, >= 0.6.3)
+  rspec (~> 3.1.0, >= 3.1.0)
+  rubocop (~> 0.27.0, >= 0.27.1)
+  thor (~> 0.19.0, >= 0.19.1)
+  yard (~> 0.8.0, >= 0.8.7.6)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright 2015 Locaweb
+
+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,73 @@
+Heartcheck
+==============
+
+[![Build Status](https://travis-ci.org/locaweb/heartcheck.svg)](https://travis-ci.org/locaweb/heartcheck)
+
+Check your applications' heart.
+
+About
+-----
+
+### Endpoint JSON documentation:
+
+https://github.com/locaweb/heartcheck/wiki/Endpoint-Json
+
+## How to setup
+
+1. Include the gem in your Gemfile:
+
+    ```
+    gem 'heartcheck'
+    ```
+
+2. Install the gem:
+
+    ```
+    bundle install
+    ```
+
+3. Generate some required files according to the framework you are using:
+
+    ```
+    heartcheck rails
+    heartcheck padrino
+    heartcheck sinatra
+    ```
+
+4. After that, follow the instructions, edit the generated files and restart your server.
+
+5. Done! Now you are able to access `[host]/monitoring` and check the monitoring JSON!
+
+## Routes
+* `[host]/monitoring`
+    * To check if the app and its integrations are avaiable;
+    * Directed for verifying the app SLA;
+* `[host]/monitoring/info`
+    * To view some informations that you can configure;
+    * Directed for availability check from load balanced and get info about the installed app;
+* `[host]/monitoring/functional`
+    * To check if the app is healty (no async job failed and other checks that aren't related to app availability);
+    * Directed for verifying consistency problems within the app;
+* `[host]/monitoring/dev`
+    * Directed for the development team;
+    * It's run the essential and functional checks;
+* `[host]/monitoring/health_check`
+    * To check if the app is up and running
+
+## How to use
+
+You can see how to use in template that is generated when install:
+https://github.com/locaweb/heartcheck/blob/master/lib/heartcheck/generators/templates/config.rb
+
+## Git tags
+
+Don't forget to tag your work! After a merge request being accepted, run:
+
+1 - (git tag -a "x.x.x" -m "") to create the new tag.
+2 - (git push origin "x.x.x") to push the new tag to remote.
+
+Follow the RubyGems conventions at http://docs.rubygems.org/read/chapter/7 to know how to increment the version number. Covered in more detail in http://semver.org/
+
+## Merge requests acceptance
+
+Don't forget to write tests to all your code. It's very important to maintain the codebase's sanity. Any merge request that doesn't have enough test coverage will be asked a revision

data/Rakefile

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

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+require 'lib/heartcheck'
+
+require "pry"
+Pry.start

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/heartcheck.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heartcheck/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'heartcheck'
+  spec.version = Heartcheck::VERSION
+  spec.authors = ['Locaweb']
+  spec.email = ['desenvolvedores@locaweb.com.br']
+  spec.homepage = 'http://developer.locaweb.com.br'
+  spec.summary = 'A simple way to check if your app is runnig like as expected.'
+  spec.description = 'A simple way to check your app heart.'
+  spec.license =  'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'rack', '~> 1', '>= 1.4.0'
+  spec.add_runtime_dependency 'oj'
+
+  spec.add_development_dependency 'pry-nav', '~> 0.2.0', '>= 0.2.4'
+  spec.add_development_dependency 'rspec', '~> 3.1.0', '>= 3.1.0'
+  spec.add_development_dependency 'rubocop', '~> 0.27.0', '>= 0.27.1'
+  spec.add_development_dependency 'thor', '~> 0.19.0', '>= 0.19.1'
+  spec.add_development_dependency 'rack-test', '~> 0.6.0', '>= 0.6.3'
+  # for documentation
+  spec.add_development_dependency 'yard', '~> 0.8.0', '>= 0.8.7.6'
+end

data/lib/heartcheck.rb

@@ -2,6 +2,7 @@ module Heartcheck
   require 'logger'
   require 'heartcheck/app'
   require 'heartcheck/checks'
+  require 'heartcheck/executors'
   require 'heartcheck/errors'
   require 'heartcheck/services'
   require 'heartcheck/logger'
@@ -11,6 +12,7 @@ module Heartcheck
   class << self
     # @attr [Array<Checks>] the checks to use when checking
     attr_accessor :checks
+
     # @attr_writer [Object] change the default logger
     attr_writer :logger
 
@@ -26,10 +28,12 @@ module Heartcheck
     # Is used to configure.
     #
     # @yield A bock that recieve the class
+    #
     # @example
     #   Heartcheck.setup do |c|
     #     puts c
     #   end
+    #
     # @return [void]
     def setup
       yield(self)
@@ -42,10 +46,12 @@ module Heartcheck
     # @param [Hash] options the options to create an instance of a check.
     # @option options [String] :class The class name to get an instance
     # @yield a block to config the instance
+    #
     # @example
     #   Heartcheck.add(:base) do |c|
     #     c.name = 'Base check'
     #   end
+    #
     # @return [void]
     def add(name, options = {}, &block)
       class_name = options.fetch(:class) { constantize(name) }
@@ -100,9 +106,11 @@ module Heartcheck
 
     # helper method to get a constant
     #
+    # @param [String] name of class
+    #
     # @example
     #   contantize('my_check') => 'MyCheck'
-    # @param [String] name of class
+    #
     # @return [String]
     def constantize(name)
       name.to_s.split('_').map(&:capitalize).join

data/lib/heartcheck/app.rb

@@ -23,6 +23,7 @@ module Heartcheck
     #
     # @param app [RackApp] is a rack app where
     #   heartcheck is included.
+    #
     # @return [void]
     def initialize(app = nil)
       @app = app
@@ -32,6 +33,7 @@ module Heartcheck
     #
     # @param env [Hash] is an instance of Hash
     #   that includes CGI-like headers.
+    #
     # @return [Array] must be an array that contains
     #   - The HTTP response code
     #   - A Hash of headers
@@ -50,6 +52,7 @@ module Heartcheck
     #   and call the index method
     #
     # @param req [Rack::Request] an instance of request
+    #
     # @return [String] a response body
     def dispatch_action(req)
       controller = ROUTE_TO_CONTROLLER[req.path_info]

data/lib/heartcheck/checks/base.rb

@@ -1,12 +1,39 @@
 module Heartcheck
   module Checks
+    # Base check that contains the common functionality for chechs
     class Base
-      attr_accessor :functional, :dev, :name, :timeout
-
+      # When it is true the check will work just for `/functional` route.
+      #   It should be used to add warning messages that need to verify,
+      #   but doesn't break your application.
+      #   For example when your async process has more than 3 jobs.
+      #
+      # @return [Boolean] (default: false)
+      attr_accessor :functional
       alias_method :functional?, :functional
+
+      # When it is true the check will work just for `/dev` route.
+      #   you can use it to create some check is not essential/functional for you app.
+      #   For example you can execute some performance check.
+      #
+      # @return [Boolean] (default: false)
+      attr_accessor :dev
       alias_method :dev?, :dev
 
-      # call in Heartcheck.set
+      # The name for identify the check in the result page
+      #
+      # @return [String]
+      attr_accessor :name
+
+      # Time that the check has to execute.
+      #   If it is 0 the timeout will be disable
+      #
+      # @return [Integer] (default: 0)
+      attr_accessor :timeout
+
+
+      # Create a new instance and set the default values.
+      #
+      # @return [Check]
       def initialize
         @dynamic_services = nil
         @error_proc       = nil
@@ -19,22 +46,61 @@ module Heartcheck
         @validate_proc    = nil
       end
 
+      # Seter to add a proc to execute when some check fail.
+      #
+      # @return [void]
       def on_error(&block)
         @error_proc = block if block_given?
       end
 
+      # Seter to add a proc to execute to check.
+      #
+      # @yieldparam services [Array<Hash>] services to check
+      # @yieldparam errors [Array<String>] to add error message when check fails
+      #
+      # @example
+      #   c.to_validate do |services, errors|
+      #     services.each do |service|
+      #       errors << "erro message" unless if service[:connection].connected?
+      #     end
+      #   end
+      #
+      # @return [void]
       def to_validate(&block)
         @validate_proc = block if block_given?
       end
 
+      # It is used to register dynamic services thats need to be evaluate when the checker is running.
+      #  This proc need to return an Array.
+      #
+      # @example
+      #   register_dynamic_services do
+      #     [
+      #       { name: 'service name', connection: MyConnection }
+      #     ]
+      #   end
+      #
+      # @return [void]
       def register_dynamic_services(&block)
         @dynamic_services = block if block_given?
       end
 
+      # It is used to add a service that will use when check run.
+      #
+      # @param service [Hash]
+      #
+      # @example
+      #   add_service(name: 'service name', connection: MyConnection)
+      #
+      # @return [void]
       def add_service(service)
         @services << service
       end
 
+
+      # It is used to add a service that will use when check run.
+      #
+      # @return [Array<Hash>]
       def services
         if @dynamic_services
           @services + @dynamic_services.call
@@ -43,13 +109,14 @@ module Heartcheck
         end
       end
 
+      # run the check and return formated erros
+      #
+      # @return [Hash]
       def check
         validation
-        hash = { name => { 'status' => (@errors.empty? ? 'ok' : 'error') } }
-        hash[name]['message'] = error_message unless @errors.empty?
-
-        Logger.info Oj.dump(hash)
-        hash
+        { name => { 'status' => (@errors.empty? ? 'ok' : 'error') } }.tap do |response|
+          response[name]['message'] = error_message unless @errors.empty?
+        end
       end
 
       def informations
@@ -60,6 +127,9 @@ module Heartcheck
 
       private
 
+      # Used to add an error to @erros.
+      #
+      # @return [void]
       def append_error(*args)
         if @error_proc
           @error_proc.call(@errors, *args)
@@ -68,6 +138,9 @@ module Heartcheck
         end
       end
 
+      # run the check
+      #
+      # @return [Array<String>]
       def validation
         @errors = []
         begin
@@ -86,16 +159,30 @@ module Heartcheck
         @errors
       end
 
+      # Get formated error messages for each service after run the check
+      #
+      # @example
+      #   @erros = ['some string']
+      #   error_message
+      #   # => [{type: 'error', message: 'some string'}]
+      #
+      # @return [Array<Hash>]
       def error_message
         @errors.map(&format_error)
       end
 
+      # format the an error message with a format the check need.
+      #
+      # @example
+      #   "some string".format_error
+      #   # => {type: 'error', message: 'some string'}
+      #
+      # @return [Hash]
       def format_error
         lambda do |error|
           error.is_a?(Hash) ? error : { type: 'error', message: error }
         end
       end
-
     end
   end
 end

data/lib/heartcheck/checks/watch_file.rb

@@ -10,7 +10,7 @@ module Heartcheck
       def validate
         services.each do |service|
           if not service[:runtime].eql? installed(service[:file])
-            @errors << "App outdated, check info for the diff"
+            @errors << "App outdated, check /monitoring/info for more details!"
           end
         end
       end

data/lib/heartcheck/controllers/base.rb

@@ -13,9 +13,13 @@ module Heartcheck
       protected
 
       def check(who)
-        Oj.dump(Heartcheck
-                .send("#{who}_checks")
-                .map(&:check))
+        Oj.dump(executor.dispatch(Heartcheck.send("#{who}_checks")))
+      end
+
+      private
+
+      def executor
+        Heartcheck::Executors::Base.new
       end
     end
   end

data/lib/heartcheck/executors.rb

@@ -0,0 +1 @@
+require 'heartcheck/executors/base'

data/lib/heartcheck/executors/base.rb

@@ -0,0 +1,15 @@
+module Heartcheck
+  module Executors
+    class Base
+      def dispatch(checkers)
+        checkers.map do |checker|
+          started = Time.now
+          checker.check.tap do |checked|
+            checked[:time] = ((Time.now - started) * 1_000.0)
+            Logger.info Oj.dump(checked)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/heartcheck/generators/templates/config.rb

@@ -3,10 +3,10 @@ Heartcheck.setup do |monitor|
   # default value: Logger.new(STDOUT)
   # monitor.logger = Rails.logger
 
-  # Services
-  # For each service you can set the folling options
+  # Checks
+  # For each check you can set the folling options
   #        name: String  => root name to show in report page (default: class.name)
-  #  functional: Boolean => options to set if this service is optional (default: false)
+  #  functional: Boolean => When is false your check is essential to your application (default: false)
   #    on_error: Block   => to customize the errors (default: nil)
   # to_validate: Block   => to validate the sevices (default: nil)
   #
@@ -27,6 +27,30 @@ Heartcheck.setup do |monitor|
   #     end
   #   end
   # end
+  #
+  # Services
+  # All check can receive a service to check.
+  # For example you can add 2 diferent hosts to check the firewall in the same checker.
+  #
+  # monitor.add :firewall do |c|
+  #   c.add_service(host: 'lala.com', port: 80)
+  #   c.add_service(host: 'popo.com', port: 80)
+  # end
+  #
+  # Take atention because we evaluate the services when ruby load the configuration file.
+  # But there's a way to send a service that will evaluate when the test will run. To use with thats way
+  # you need to register a service with `register_dynamic_services`.
+  # http://www.rubydoc.info/github/locaweb/heartcheck/Heartcheck/Checks/Base#register_dynamic_services-instance_method
+  #
+  # monitor.add :firewall do |c|
+  #   c.register_dynamic_services do
+  #     [
+  #       { host: 'lala.com', port: 80 },
+  #       { host: 'popo.com', port: 80 }
+  #     ]
+  #   end
+  # end
+
 
   # Firewall
   # check with telnet if the firewall is open to conect to the service

data/lib/heartcheck/logger.rb

@@ -4,6 +4,7 @@ module Heartcheck
     # log message with debug level
     #
     # @param message [String] message to log
+    #
     # @return [void]
     def self.debug(message)
       logger(:debug, message)

data/lib/heartcheck/version.rb

@@ -1,3 +1,3 @@
 module Heartcheck
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heartcheck
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Locaweb
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2015-07-22 00:00:00.000000000 Z
+date: 2015-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -153,7 +153,7 @@ dependencies:
         version: 0.8.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.8.7.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -163,27 +163,7 @@ dependencies:
         version: 0.8.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.2.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.2.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.2
+        version: 0.8.7.6
 description: A simple way to check your app heart.
 email:
 - desenvolvedores@locaweb.com.br
@@ -192,7 +172,20 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/heartcheck
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- exe/heartcheck
+- heartcheck.gemspec
 - lib/heartcheck.rb
 - lib/heartcheck/app.rb
 - lib/heartcheck/checks.rb
@@ -209,6 +202,8 @@ files:
 - lib/heartcheck/errors.rb
 - lib/heartcheck/errors/routing_error.rb
 - lib/heartcheck/errors/warning.rb
+- lib/heartcheck/executors.rb
+- lib/heartcheck/executors/base.rb
 - lib/heartcheck/generators.rb
 - lib/heartcheck/generators/generator.rb
 - lib/heartcheck/generators/templates/config.rb