heartcheck 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a0385acab4ad534fe832cce7bf5c71f57b47198
-  data.tar.gz: fa2682576abb2682ac60a4b340f1d8b6973f2f51
+  metadata.gz: b17fc88fd50dfea485ff96d9f9d314375ff664b0
+  data.tar.gz: 46db26bfe137aa053541db83898851eb2c185c54
 SHA512:
-  metadata.gz: 7a4f9319a3f089204cca1b0366bce4a56b5393bca77ee03210c20f66cf2c5b311fc053f05261453bc0df26ca8471bf556e2c858efa455b7993fc8470ad5928d9
-  data.tar.gz: 9f4099e88f9ea59a7be59290dc4e421beeff4a96e342a4dea35b20368fc6d21b2d5dedc5a5149fb451b60ab966891fb5fd4a0e8350cf85df7390fabfbedcbd5c
+  metadata.gz: d2324c1926ddd007de9a191ad376292103f0d60c7a96b36c9e9bc745640ff21e595466cb9f3438faf8b7d4a6126bc8ca2a02d7cc426de8346ef0a4e44b1f05de
+  data.tar.gz: 77074aa4e162a259b22f840637562ba392af6a4a4b6c54dd567cadf5fc1dfab6252f2e01780a48740b09294a91ba593596a7288d2005c1f923725b9738a76ea6

data/.travis.yml

@@ -16,3 +16,5 @@ matrix:
       gemfile: Gemfile-old-ruby
     - rvm: "2.2.2"
     - rvm: "2.3.0"
+    - rvm: "2.3.3"
+    - rvm: "2.4.1"

data/CHANGELOG

@@ -1,5 +1,9 @@
 = Heart Check - Changelog
 
+== Version 1.2.0 :: 2017-03-30
+
+  * Adds a caching plug
+
 == Version 1.0.0 :: 2015-02-02
 
   * Inital release.

data/LICENSE.txt

@@ -1,20 +1,19 @@
-Copyright 2015 Locaweb
+Copyright (c) 2015-2016 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:
+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 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.
+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

@@ -1,90 +1,89 @@
-Heartcheck
-==============
-
+# Heartcheck
+
+Heartcheck is a monitoring tool for Rack applications. It provides a DSL to
+declare service checks and an URI that returns the status for each service.
+With this gem you can monitor if your app has access to the database, a cache
+service, an API, etc.
+
 [![Build Status](https://travis-ci.org/locaweb/heartcheck.svg)](https://travis-ci.org/locaweb/heartcheck)
-[![Code Climate](https://codeclimate.com/github/locaweb/heartcheck/badges/gpa.svg)](https://codeclimate.com/github/locaweb/heartcheck)
-
-Check your applications' heart.
-
-About
------
-
-### Endpoint JSON 
-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](https://github.com/locaweb/heartcheck/blob/master/lib/heartcheck/generators/templates/config.rb) that is generated when install:
+[![Code Climate](https://codeclimate.com/github/locaweb/heartcheck/badges/gpa.svg)](https://codeclimate.com/github/locaweb/heartcheck)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'heartcheck'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install heartcheck
+
+## Usage
+
+First generate the config file for the framework you are using:
+
+    $ heartcheck rails
+    $ heartcheck padrino
+    $ heartcheck sinatra
+
+Then edit the generated file by adding your checks on it and restart your
+server. Now you should be able to make a HTTP request for `/monitoring` and
+get a JSON response that contains the status for each monitored service.
+
+## HTTP Routes
+
+#### Basic health check
+
+To get the status for all services, make a HTTP request for the following URI:
 
+    /monitoring
+
+It will return a JSON response and a status for each service.
+
+#### Functional status
+
+Functional services are services essential for your application. You can get
+their status using the following route:
+
+    /monitoring/functional
+
+#### Info route
+
+This route returns custom information about your app. You can configure it to
+return whatever information you want:
+
+    /monitoring/info
+
+#### Dev status
+
+Returns some debugging information:
+
+    /monitoring/dev
+
+#### Very basic health check
+
+Returns a simple `ok` if the app is running. It does not execute any configured
+checks:
+
+    /monitoring/health_check
 
 ## Plugins
+
 * [ActiveRecord](https://github.com/locaweb/heartcheck-activerecord)
 * [Cache](https://github.com/locaweb/heartcheck-cache)
 * [Cas](https://github.com/locaweb/heartcheck-cas)
 * [Redis](https://github.com/locaweb/heartcheck-redis)
 * [Resque](https://github.com/locaweb/heartcheck-resque)
 * [Sidekiq](https://github.com/locaweb/heartcheck-sidekiq)
-* [Webservice](https://github.com/locaweb/heartcheck-webservice)
-
-## 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
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+* [Webservice](https://github.com/locaweb/heartcheck-webservice)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/locaweb/heartcheck.

data/heartcheck.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.version = Heartcheck::VERSION
   spec.authors = ['Locaweb']
   spec.email = ['desenvolvedores@locaweb.com.br']
-  spec.homepage = 'http://developer.locaweb.com.br'
+  spec.homepage = 'http://github.com/locaweb/heartcheck/'
   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'

data/lib/heartcheck.rb

@@ -1,6 +1,7 @@
 module Heartcheck
   require 'logger'
   require 'heartcheck/app'
+  require 'heartcheck/caching_app'
   require 'heartcheck/checks'
   require 'heartcheck/executors'
   require 'heartcheck/errors'
@@ -102,11 +103,10 @@ module Heartcheck
       @executor ||= Heartcheck::Executors::Base.new
     end
 
-
     # change current executor to a threaded implementation
     # requires 'concurrent-ruby'
     #
-    # @return [Hearcheck::Executors::Threaded]
+    # @return [Heartcheck::Executors::Threaded]
     def use_threaded_executor!
       require "concurrent"
       require "heartcheck/executors/threaded"

data/lib/heartcheck/caching_app.rb

@@ -0,0 +1,48 @@
+require 'heartcheck/caching_app/cache'
+
+# A rack middleware to wrap around {Heartcheck::App} in a cache
+#   Mount an instance of this class passing an app or `use` this in Rack.
+#   This accepts an optional ttl for the cache that defaults to 300 seconds.
+module Heartcheck
+  class CachingApp
+    # Creates an instance of the middleware
+    #
+    # @param app [Heartcheck:App] the Rack app to wrap around
+    # @param ttl [Integer] the time to cache the results in seconds
+    # @param cache [Heartcheck::CachingApp::Cache] the cache instance to use
+    #   The cache will be created on first use if not supplied
+    #
+    # @return [#call] rack compatible middleware
+    def initialize(app, ttl = 300, cache = nil)
+      @app = app
+      @ttl = ttl
+      @cache = cache
+    end
+
+    # Invokes the middleware
+    #
+    # @param env [Hash] the rack request/environment
+    # @return [Array] a rack compatible response
+    def call(env)
+      req = Rack::Request.new(env)
+      controller = Heartcheck::App::ROUTE_TO_CONTROLLER[req.path_info]
+
+      if controller && (result = cache.result(controller))
+        [200, { 'Content-type' => 'application/json' }, [result]]
+      else
+        @app.call(env)
+      end
+    end
+
+    protected
+
+    def cache
+      @cache ||= start_cache(@ttl)
+    end
+
+    def start_cache(ttl)
+      Heartcheck::CachingApp::Cache.new(Heartcheck::App::ROUTE_TO_CONTROLLER
+        .values.uniq, ttl).tap(&:start)
+    end
+  end
+end

data/lib/heartcheck/caching_app/cache.rb

@@ -0,0 +1,65 @@
+require 'concurrent'
+
+module Heartcheck
+  class CachingApp
+    # This cache performs the given controllers in background threads.
+    #   The public interface always queries the results from the cache.
+    #
+    # @param executor [Array<Class>] the collection controllers classes to cache
+    # @param ttl [Integer] the cache ttl in seconds
+    #
+    # @return [Heartcheck::CachingApp::Cache]
+    class Cache
+      attr_accessor :concurrent_opts
+
+      def initialize(controllers, ttl)
+        @results = Concurrent::Map.new
+        @controllers = controllers
+        @ttl = ttl
+        @concurrent_opts = {}
+      end
+
+      # Fetches the current result for the given controller
+      #
+      # @param controller [Class] the controller to fetch the current result of
+      #
+      # @return [String] the result of the index action
+      def result(controller)
+        @results[controller]
+      end
+
+      def start
+        schedule(@ttl, &perform_all_controllers)
+      end
+
+      protected
+
+      def perform_controller(controller)
+        proc do
+          Logger.info("Start [#{controller}] for caching at #{Time.now}")
+          @results[controller] = controller.new.index
+          Logger.info("End [#{controller}]\n")
+        end
+      end
+
+      def perform_all_controllers
+        proc do
+          Logger.info("performing all #{@controllers.length} checks")
+
+          tasks = @controllers.map do |controller|
+            schedule(0, &perform_controller(controller))
+          end
+
+          # wait for all tasks to complete before scheduling next run
+          tasks.map(&:value)
+
+          schedule(@ttl, &perform_all_controllers)
+        end
+      end
+
+      def schedule(ttl, &block)
+        Concurrent::ScheduledTask.execute(ttl, concurrent_opts, &block)
+      end
+    end
+  end
+end

data/lib/heartcheck/checks/base.rb

@@ -119,6 +119,14 @@ module Heartcheck
         end
       end
 
+      # Returns a human-readable representation of the check
+      #
+      # @return [String]
+      def inspect
+        "#<#{self.class.name} name: #{name}, functional: #{functional?}, dev: #{dev?}>"
+      end
+
+
       def informations
         info
       rescue => e

data/lib/heartcheck/generators/generator.rb

@@ -25,15 +25,29 @@ module Heartcheck
       when 'rails'
         instructions(
           'config/routes.rb',
-          'mount Heartcheck::App.new, at: "/monitoring"'
+          [
+            'mount Heartcheck::App.new, at: "/monitoring"',
+            '',
+            '# to mount a caching instance:',
+            '# mount Heartcheck::CachingApp.new(HeartCheck::App.new, 300),',
+            '#   at: "/cached-monitoring" # 300 is the optional cache TTL'
+          ].join("\n")
         )
       when 'padrino', 'sinatra'
         instructions(
-          'config.ru', %(require "heartcheck"
-map "/monitoring" do
-  use Heartcheck::App
-end)
-        )
+          'config.ru', [
+            'require "heartcheck"',
+            '',
+            'map "/monitoring" do',
+            '  use Heartcheck::App',
+            'end',
+            '',
+            '# or a cached instance:',
+            '# map "/cached/monitoring" do',
+            '#   use Heartcheck::CachingApp, 300 # 300 is the optional ttl',
+            '#   use Heartcheck::App',
+            '# end',
+          ].join("\n"))
       end
     end
 

data/lib/heartcheck/version.rb

@@ -1,3 +1,3 @@
 module Heartcheck
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heartcheck
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Locaweb
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-22 00:00:00.000000000 Z
+date: 2017-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -194,6 +194,8 @@ files:
 - heartcheck.gemspec
 - lib/heartcheck.rb
 - lib/heartcheck/app.rb
+- lib/heartcheck/caching_app.rb
+- lib/heartcheck/caching_app/cache.rb
 - lib/heartcheck/checks.rb
 - lib/heartcheck/checks/base.rb
 - lib/heartcheck/checks/firewall.rb
@@ -218,7 +220,7 @@ files:
 - lib/heartcheck/services.rb
 - lib/heartcheck/services/firewall.rb
 - lib/heartcheck/version.rb
-homepage: http://developer.locaweb.com.br
+homepage: http://github.com/locaweb/heartcheck/
 licenses:
 - MIT
 metadata: {}
@@ -238,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A simple way to check if your app is runnig like as expected.