heartcheck 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30402737433dacfa08875ade181a6fb9570b6b0a
+  data.tar.gz: d6747a981694289118544f929e70cb254153bdf4
+SHA512:
+  metadata.gz: 3be0e45e564098d82e130030a69aaaca7c9858de1021629178745afd803db934f4ed439d9b9c580d67454519b950db42c082220b919992f8e08ae7336a6f73e7
+  data.tar.gz: d4129a1cf932d1ae0e3d724231dc03a0f7a02f158632318d372ee1c29f27cdc581c15983e1fdeafbe209711118769e29301b6a1ae131d9850b81a24991a319ab

data/bin/heartcheck

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+require 'heartcheck'
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: heartcheck (rails|padrino|sinatra)\n\nYou can use flags as such:"
+
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+
+  if ARGV.size != 1 || !%w(rails sinatra padrino).include?(ARGV[0])
+    puts opts
+    exit
+  end
+end
+
+begin
+  optparse.parse!
+rescue OptionParser::InvalidOption => e
+  puts e
+  exit
+end
+
+Heartcheck::Generator.new(ARGV).invoke_all

data/lib/generators/generator.rb

@@ -0,0 +1,63 @@
+require 'thor/group'
+
+module Heartcheck
+  class Generator < Thor::Group
+    include Thor::Actions
+
+    desc 'generate default files and instructions to use the Heartcheck'
+
+    argument :framework
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def show_framework
+      box framework.capitalize, :green
+    end
+
+    def generate_initializer
+      template('config.rb', initializer_path)
+    end
+
+    def generate_route
+      case framework
+      when 'rails'
+        instructions(
+          'config/routes.rb',
+          'mount Heartcheck::App.new, at: "/monitoring"'
+        )
+      when 'padrino', 'sinatra'
+        instructions(
+          'config.ru', %(require "heartcheck"
+map "/monitoring" do
+  use Heartcheck::App
+end)
+        )
+      end
+    end
+
+    def include_empty_lines
+      puts "\n\n"
+    end
+
+    private
+
+    def instructions(file_name, file_content)
+      box "Include the following content to file #{file_name}"
+      say file_content, :blue
+    end
+
+    def box(content, color = :red)
+      size = content.size
+      say "#{'=' * (size + 2)}\n #{content}\n#{'=' * (size + 2)}\n", color
+    end
+
+    def initializer_path
+      case framework
+      when 'rails'              then 'config/initializers/heartcheck.rb'
+      when 'padrino', 'sinatra' then 'app/app.rb'
+      end
+    end
+  end
+end

data/lib/generators/templates/config.rb

@@ -0,0 +1,67 @@
+Heartcheck.setup do |monitor|
+  # monitor has a default logger but you can use yours
+  # default value: Logger.new(STDOUT)
+  # monitor.logger = Rails.logger
+
+  # Services
+  # For each service 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)
+  #    on_error: Block   => to customize the errors (default: nil)
+  # to_validate: Block   => to validate the sevices (default: nil)
+  #
+  # See the exemple bellow to undertand how you can configure it.
+  #
+  # monitor.add :base do |c|
+  #   c.name       = "filesystem"
+  #   c.functional = true
+  #   c.add_service(name: "my_file", path: "/var/www/my_project/my_file")
+  #
+  #   c.on_error do |sevices|
+  #     errors << "Custom error message for #{service[:name]}"
+  #   end
+  #
+  #   c.to_validate do |services, errors|
+  #     services.each do |service|
+  #       errors << "erro message" unless if File.exists?(service[:path])
+  #     end
+  #   end
+  # end
+
+  # Firewall
+  # check with telnet if the firewall is open to conect to the service
+  monitor.add :firewall do |c|
+    # you can add service wth (host and port) or (url)
+    c.add_service(host: 'lala.com', port: 80)
+    c.add_service(url: 'http://lalal.com')
+
+    # add dynamic services when you need it run after initializer
+    c.register_dynamic_services do
+      Pmta.all.map { |p| { host: p.host, port: 25 } }
+    end
+
+    # to customize default error message, the default is:
+    # "connection refused on: #{service.host}:#{service.port}"
+    # params
+    # errors:  Array           => errors to show on page
+    # service: FirewallService => object that respond to :host and :port
+    c.on_error do |_errors, service|
+      erros << "Custom error message for #{service.host}"
+    end
+  end
+
+  # Redis
+  # check if you redis conection is working
+  # you need to send a redis conection as a service
+  monitor.add :redis do |c|
+    c.add_service(name: 'Redis', connection: Resque.redis)
+  end
+
+  # Cache
+  # check if your cache is working
+  # you can pass any kind of cache, but this need to respond to
+  # set, get and delete
+  monitor.add :cache do |c|
+    c.add_service(name: 'memcached', connection: Rails.cache.instance_variable_get('@data'))
+  end
+end

data/lib/heartcheck.rb

@@ -0,0 +1,111 @@
+module Heartcheck
+  require 'logger'
+  require 'heartcheck/app'
+  require 'heartcheck/checks'
+  require 'heartcheck/errors'
+  require 'heartcheck/services'
+  require 'heartcheck/logger'
+
+  @checks = []
+
+  class << self
+    # @attr [Array<Checks>] the checks to use when checking
+    attr_accessor :checks
+    # @attr_writer [Object] change the default logger
+    attr_writer :logger
+
+    # Is used to log some messages when checking if the logger
+    # is not set it's returns de default_logger.
+    #
+    # @return [Object] the logger object
+    def logger
+      @logger ||= default_logger
+    end
+
+    # @abstract
+    # 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)
+    end
+
+    # It's used to add an instance of a check
+    # to the check list
+    #
+    # @param [String] name to identify in the result page
+    # @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) }
+      instance = Checks.const_get(class_name).new
+
+      if block_given?
+        checks << instance.tap(&block)
+      else
+        checks << instance
+      end
+    end
+
+    # filter checks that are essential
+    #
+    # @return [Array<Check>] checks that are essential
+    def essential_checks
+      checks.select { |ctx| !ctx.functional? && !ctx.dev? }
+    end
+
+    # filter checks that are functional
+    #
+    # @return [Array<Check>] checks that are functional
+    def functional_checks
+      checks.select(&:functional?)
+    end
+
+    # filter checks that are not functional
+    #
+    # @return [Array<Check>] checks that are not functional
+    def dev_checks
+      checks.select { |ctx| !ctx.functional? }
+    end
+
+    # filter checks that has some information
+    #
+    # @return [Array<Check>] checks that respond to :info
+    def info_checks
+      checks.select { |ctx| ctx.respond_to?(:info) }
+    end
+
+    private
+
+    # if no logger is setted we create an instance
+    # of ruby logger with STDOUT
+    #
+    # @return [Logger] a ruby logger to STDOUT and info level
+    def default_logger
+      log = ::Logger.new(STDOUT)
+      log.level = ::Logger::INFO
+      log
+    end
+
+    # helper method to get a constant
+    #
+    # @example
+    #   contantize('my_check') => 'MyCheck'
+    # @param [String] name of class
+    # @return [String]
+    def constantize(name)
+      name.to_s.split('_').map(&:capitalize).join
+    end
+  end
+end

data/lib/heartcheck/app.rb

@@ -0,0 +1,65 @@
+require 'rack'
+require 'heartcheck/controllers/base'
+
+Dir.glob(File.expand_path('../controllers/*.rb', __FILE__))
+  .each { |x| require x }
+
+# A web app that's use rack
+module Heartcheck
+  class App
+    # A hash with paths as keys and controllers
+    # as values we use it in #dispath_action
+    # to routes the requests
+    ROUTE_TO_CONTROLLER = {
+      '/' => Controllers::Essential,
+      '' => Controllers::Essential,
+      '/functional' => Controllers::Functional,
+      '/dev' => Controllers::Dev,
+      '/info' => Controllers::Info,
+      '/health_check' => Controllers::HealthCheck
+    }
+
+    # Sets up the rack application.
+    #
+    # @param app [RackApp] is a rack app where
+    #   heartcheck is included.
+    # @return [void]
+    def initialize(app = nil)
+      @app = app
+    end
+
+    # Sets up the rack application.
+    #
+    # @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
+    #   - The response body, which must respond to each
+    def call(env)
+      req = Rack::Request.new(env)
+
+      [200, { 'Content-Type' => 'application/json' }, [dispatch_action(req)]]
+    rescue Heartcheck::Errors::RoutingError
+      [404, { 'Content-Type' => 'application/json' }, ['Not found']]
+    end
+
+    private
+
+    # Find a controller to espefic path
+    #   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]
+      fail Heartcheck::Errors::RoutingError if controller.nil?
+
+      Logger.info "Start [#{controller}] from #{req.ip} at #{Time.now}"
+
+      controller.new.index.tap do |_|
+        Logger.info "End [#{controller}]\n"
+      end
+    end
+  end
+end

data/lib/heartcheck/checks.rb

@@ -0,0 +1,3 @@
+require 'heartcheck/checks/base'
+require 'heartcheck/checks/firewall'
+require 'heartcheck/checks/process'

data/lib/heartcheck/checks/base.rb

@@ -0,0 +1,101 @@
+module Heartcheck
+  module Checks
+    class Base
+      attr_accessor :functional, :dev, :name, :timeout
+
+      alias_method :functional?, :functional
+      alias_method :dev?, :dev
+
+      # call in Heartcheck.set
+      def initialize
+        @dynamic_services = nil
+        @error_proc       = nil
+        @errors           = []
+        @functional       = false
+        @dev              = false
+        @name             = self.class.name.split('::').last.downcase
+        @services         = []
+        @timeout          = 0
+        @validate_proc    = nil
+      end
+
+      def on_error(&block)
+        @error_proc = block if block_given?
+      end
+
+      def to_validate(&block)
+        @validate_proc = block if block_given?
+      end
+
+      def register_dynamic_services(&block)
+        @dynamic_services = block if block_given?
+      end
+
+      def add_service(service)
+        @services << service
+      end
+
+      def services
+        if @dynamic_services
+          @services + @dynamic_services.call
+        else
+          @services
+        end
+      end
+
+      def check
+        validation
+        hash = { name => { 'status' => (@errors.empty? ? 'ok' : 'error') } }
+        hash[name]['message'] = error_message unless @errors.empty?
+
+        Logger.info Oj.dump(hash)
+        hash
+      end
+
+      def informations
+        info
+      rescue => e
+        { 'error' => e.message }
+      end
+
+      private
+
+      def append_error(*args)
+        if @error_proc
+          @error_proc.call(@errors, *args)
+        else
+          custom_error(*args)
+        end
+      end
+
+      def validation
+        @errors = []
+        begin
+          Timeout.timeout(timeout, Heartcheck::Errors::Warning) do
+            if @validate_proc
+              @validate_proc.call(services, @errors)
+            else
+              validate
+            end
+          end
+        rescue Heartcheck::Errors::Warning => w
+          @errors = [{ type: 'warning', message: w.message }]
+        rescue => e
+          @errors = [e.message]
+        end
+        @errors
+      end
+
+      def error_message
+        @errors.map(&format_error)
+      end
+
+      def format_error
+        lambda do |error|
+          error.is_a?(Hash) ? error : { type: 'error', message: error }
+        end
+      end
+
+    end
+  end
+end

data/lib/heartcheck/checks/firewall.rb

@@ -0,0 +1,26 @@
+module Heartcheck
+  module Checks
+    class Firewall < Base
+      def services
+        super.map { |opts| Services::Firewall.new(opts) }
+      end
+
+      def validate
+        services.each do |service|
+          begin
+            Net::Telnet.new(service.params)
+          rescue Errno::ECONNREFUSED; nil
+          rescue
+            append_error(service)
+          end
+        end
+      end
+
+      private
+
+      def custom_error(service)
+        @errors << "connection refused on: #{service.host}:#{service.port}"
+      end
+    end
+  end
+end

data/lib/heartcheck/checks/process.rb

@@ -0,0 +1,30 @@
+module Heartcheck
+  module Checks
+    class Process < Base
+      def validate
+        services.each do |service|
+          begin
+            pid = get_pid(service)
+            ::Process.kill(0, pid)
+          rescue Errno::ESRCH
+            append_error(service, pid)
+          end
+        end
+      end
+
+      private
+
+      def custom_error(service, pid)
+        @errors << "The process of #{service[:name]} is not run with pid #{pid}"
+      end
+
+      def get_pid(service)
+        if service[:pid]
+          service[:pid]
+        else
+          File.read(service[:file]).to_i
+        end
+      end
+    end
+  end
+end

data/lib/heartcheck/controllers/base.rb

@@ -0,0 +1,22 @@
+require 'rack'
+require 'oj'
+
+Oj.default_options = { mode: :compat }
+
+module Heartcheck
+  module Controllers
+    class Base
+      def index
+        fail NotImplementError
+      end
+
+      protected
+
+      def check(who)
+        Oj.dump(Heartcheck
+                .send("#{who}_checks")
+                .map(&:check))
+      end
+    end
+  end
+end

data/lib/heartcheck/controllers/dev.rb

@@ -0,0 +1,34 @@
+module Heartcheck
+  module Controllers
+    class Dev < Base
+      def index
+        results = []
+
+        total_execution_time = time_diff do
+          checks = Heartcheck.dev_checks
+
+          results += checks.reduce([]) do |acc, elem|
+            context_result = {}
+
+            context_result['execution_time'] = time_diff do
+              context_result.merge!(elem.check)
+            end
+
+            acc << context_result
+          end
+        end
+
+        results << { 'total_execution_time' => total_execution_time }
+        Oj.dump(results)
+      end
+
+      private
+
+      def time_diff
+        start_time = Time.now
+        yield
+        '%.2f ms' % ((Time.now - start_time) * 1_000)
+      end
+    end
+  end
+end

data/lib/heartcheck/controllers/essential.rb

@@ -0,0 +1,9 @@
+module Heartcheck
+  module Controllers
+    class Essential < Base
+      def index
+        check(:essential)
+      end
+    end
+  end
+end

data/lib/heartcheck/controllers/functional.rb

@@ -0,0 +1,9 @@
+module Heartcheck
+  module Controllers
+    class Functional < Base
+      def index
+        check(:functional)
+      end
+    end
+  end
+end

data/lib/heartcheck/controllers/health_check.rb

@@ -0,0 +1,9 @@
+module Heartcheck
+  module Controllers
+    class HealthCheck < Base
+      def index
+        Oj.dump({ status: 'ok' })
+      end
+    end
+  end
+end

data/lib/heartcheck/controllers/info.rb

@@ -0,0 +1,11 @@
+module Heartcheck
+  module Controllers
+    class Info < Base
+      def index
+        Oj.dump(Heartcheck
+                .info_checks
+                .map(&:informations))
+      end
+    end
+  end
+end

data/lib/heartcheck/errors.rb

@@ -0,0 +1,2 @@
+require 'heartcheck/errors/routing_error'
+require 'heartcheck/errors/warning'

data/lib/heartcheck/errors/routing_error.rb

@@ -0,0 +1,6 @@
+module Heartcheck
+  module Errors
+    class RoutingError < RuntimeError
+    end
+  end
+end

data/lib/heartcheck/errors/warning.rb

@@ -0,0 +1,6 @@
+module Heartcheck
+  module Errors
+    class Warning < RuntimeError
+    end
+  end
+end

data/lib/heartcheck/logger.rb

@@ -0,0 +1,53 @@
+module Heartcheck
+  # A simple Interface to log messages
+  class Logger
+    # log message with debug level
+    #
+    # @param message [String] message to log
+    # @return [void]
+    def self.debug(message)
+      logger(:debug, message)
+    end
+
+    # log message with info level
+    #
+    # @param message [String] message to log
+    #
+    # @return [void]
+    def self.info(message)
+      logger(:info, message)
+    end
+
+    # log message with warn level
+    #
+    # @param message [String] message to log
+    #
+    # @return [void]
+    def self.warn(message)
+      logger(:warn, message)
+    end
+
+    # log message with error level
+    #
+    # @param message [String] message to log
+    #
+    # @return [void]
+    def self.error(message)
+      logger(:error, message)
+    end
+
+    private
+
+    # Sent the message to Heartcheck logger
+    # that you can configure
+    #
+    # @see Heartcheck.logger
+    # @param level [Symbol] the level log
+    # @param message [String] message to log
+    #
+    # @return [void]
+    def self.logger(level, message)
+      Heartcheck.logger.send(level, "[Heartcheck] #{message}")
+    end
+  end
+end

data/lib/heartcheck/services.rb

@@ -0,0 +1 @@
+require 'heartcheck/services/firewall'

data/lib/heartcheck/services/firewall.rb

@@ -0,0 +1,72 @@
+require 'net/telnet'
+
+module Heartcheck
+  module Services
+    # A service to check with a simple telnet
+    # if the route to a host is working.
+    class Firewall
+      attr_reader :uri, :proxy
+
+      # Sets up the options to firewall.
+      #
+      # @param params [Hash] a hash with the configurations.
+      # @option params [String] :host The domain/Ip
+      # @option params [Integer] :port Number of port to check
+      # @option params [String] :proxy The uri of your proxy if is required
+      # @option params [integer] :timeout (defaults to: 2) Number in seconds
+      # @option params [string] :uri You can pass a URI instead a host and port
+      #
+      # @example
+      #   Firewall.new(host: 'domain.com', port: 80)
+      #   Firewall.new(host: 'domain.com', port: 80, timeout: 5)
+      #   Firewall.new(uri: 'https://domain.com')
+      #   Firewall.new(uri: 'https://domain.com', proxy: 'http://proxy.domain.com')
+      #
+      # @return [void]
+      def initialize(params)
+        @host    = params[:host]
+        @port    = params[:port]
+        @proxy   = params[:proxy]
+        @timeout = params[:timeout] || 2
+        @uri     = URI(params[:url].to_s)
+      end
+
+      # format params to use in Telnet
+      #
+      # @return [Hash] with the config
+      #   - Host
+      #   - Port
+      #   - Timeout
+      #   - Proxy - if is seted return a Net::Telnet object
+      def params
+        params = { 'Host' => host, 'Port' => port, 'Timeout' => @timeout }
+        params['Proxy'] = proxy_uri if proxy
+        params
+      end
+
+      # to get the host or stract from @uri
+      #
+      # @return [String] the host that is configured
+      def host
+        @host || uri.host
+      end
+
+      # to get the port or stract from @uri
+      #
+      # @return [Integre] the port that is configured
+      def port
+        @port || uri.port
+      end
+
+      private
+
+      # to get the configured proxy
+      #
+      # @return [Net::Telnet] an instance with configured proxy
+      def proxy_uri
+        uri_proxy = URI(proxy)
+        ::Net::Telnet.new('Host' => uri_proxy.host, 'Port' => uri_proxy.port, 'Timeout' => @timeout)
+      end
+    end
+  end
+end

data/lib/heartcheck/version.rb

@@ -0,0 +1,3 @@
+module Heartcheck
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,248 @@
+--- !ruby/object:Gem::Specification
+name: heartcheck
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Locaweb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.11.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.11.4
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.27.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.27.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.27.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.27.1
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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
+description: A simple way to check your app heart.
+email:
+- desenvolvedores@locaweb.com.br
+executables:
+- heartcheck
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/heartcheck
+- lib/generators/generator.rb
+- lib/generators/templates/config.rb
+- lib/heartcheck.rb
+- lib/heartcheck/app.rb
+- lib/heartcheck/checks.rb
+- lib/heartcheck/checks/base.rb
+- lib/heartcheck/checks/firewall.rb
+- lib/heartcheck/checks/process.rb
+- lib/heartcheck/controllers/base.rb
+- lib/heartcheck/controllers/dev.rb
+- lib/heartcheck/controllers/essential.rb
+- lib/heartcheck/controllers/functional.rb
+- lib/heartcheck/controllers/health_check.rb
+- lib/heartcheck/controllers/info.rb
+- lib/heartcheck/errors.rb
+- lib/heartcheck/errors/routing_error.rb
+- lib/heartcheck/errors/warning.rb
+- lib/heartcheck/logger.rb
+- lib/heartcheck/services.rb
+- lib/heartcheck/services/firewall.rb
+- lib/heartcheck/version.rb
+homepage: http://developer.locaweb.com.br
+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
+signing_key: 
+specification_version: 4
+summary: A simple way to check if your app is runnig like as expected.
+test_files: []
+has_rdoc: