heartcheck 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 45a358d7f3a8864deb797ecb5639d0e4df274c66
-  data.tar.gz: 530d7ecd987f302e38b41395abe67bc9a4ffced3
+SHA256:
+  metadata.gz: 6dfd09304fc0ad36774293f2e0e04a3d3ea542acf6ac86bb4415fb558815f109
+  data.tar.gz: d6ef9bcee013849cf771c2e14c3699bc53bd664fc5be70a091dc63c5d54c63fd
 SHA512:
-  metadata.gz: 55db326b56112e68f33b488d27bab4dd1d0442aae29f88a2c8f3dfe28e96fdfaadd0dd9e4b01dbaf9f915495cf7fcbe6b7133af1d73c4b662344d9507f1e1c71
-  data.tar.gz: 2d54d671c2944e925d935e7cc3bd6f7db53c0c1d3f2d10b4bc013dd03fbcc100ad60de6b8789a136449ebc4b1a032ca36e5af5718cce2bfd84b49d67f1dd7a46
+  metadata.gz: 63907f0c4b890db4b3466160bb2fe2707058f3fd3f25ef3e33380fca89f04fa9c0a16d74f929fadc686641b2ce43016021272f9436e40635aed83369d3ad56ca
+  data.tar.gz: f56971cdc1ad9d83dc1a0dbc62ca3da7de40bb536f0fd79116346c5055b5c1dc8491fc6857046ab83fce439131c154ba6941084ddcd88e378ecdb0ca26fdcef1

data/CHANGELOG

@@ -1,5 +1,9 @@
 = Heart Check - Changelog
 
+== Version 1.5.0 :: 2018-11-29
+
+ * Adds the '/monitoring/inspect' endpoint to get general info and dependencies
+
 == Version 1.4.0 :: 2017-12-27
 
  * Adds property `doc_url` to Checks::Base to provide more details about the

data/README.md

@@ -37,6 +37,26 @@ 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.
 
+The following environment variables are needed by heartcheck:
+
+    HEARTCHECK_APP_NAME=MyApplicationName
+
+
+### Using built-in checks
+
+#### Firewall check
+
+```ruby
+Heartcheck.setup do |config|
+  config.add :firewall do |c|
+    c.add_service(host: 'domain.com', port: 80)
+    c.add_service(host: 'domain.com', port: 80, timeout: 5) # Default timeout is 2 seconds
+    c.add_service(url: 'https://domain.com')
+    c.add_service(url: 'https://domain.com', proxy: 'http://proxy.domain.com')
+  end
+end
+```
+
 ## HTTP Routes
 
 #### Basic health check
@@ -74,6 +94,13 @@ checks:
 
     /monitoring/health_check
 
+
+#### General info and dependencies
+
+Returns general application info and a list of dependencies' URIs, but executes no checking:
+
+    /monitoring/inspect
+
 ## Plugins
 
 * [ActiveRecord](https://github.com/locaweb/heartcheck-activerecord)

data/lib/heartcheck/app.rb

@@ -16,6 +16,7 @@ module Heartcheck
       '/functional' => Controllers::Functional,
       '/dev' => Controllers::Dev,
       '/info' => Controllers::Info,
+      '/inspect' => Controllers::Inspect,
       '/health_check' => Controllers::HealthCheck,
       '/environment' => Controllers::Environment
     }

data/lib/heartcheck/checks/base.rb

@@ -133,6 +133,13 @@ module Heartcheck
         "#<#{self.class.name} name: #{name}, functional: #{functional?}, dev: #{dev?}>"
       end
 
+      # Returns a structure comprised of host, port and
+      # schema (protocol) for the check
+      #
+      # @return [Hash]
+      def uri_info
+        { error: "#{self.class.name} #url_info not implemented." }
+      end
 
       def informations
         info

data/lib/heartcheck/checks/firewall.rb

@@ -16,6 +16,16 @@ module Heartcheck
         end
       end
 
+      def uri_info
+        services.map do |s|
+          {
+            host: s.uri.host,
+            port: s.uri.port,
+            scheme: s.uri.scheme
+          }
+        end
+      end
+
       private
 
       def custom_error(service)

data/lib/heartcheck/controllers/inspect.rb

@@ -0,0 +1,25 @@
+module Heartcheck
+  module Controllers
+    class Inspect < Base
+      def index
+        results = {
+          application_name: application_name,
+          dependencies: []
+        }
+
+        checks = Heartcheck.checks
+        results[:dependencies] += checks.reduce([]) do |acc, elem|
+          acc << elem.uri_info
+        end.flatten.uniq
+
+        MultiJson.dump(results)
+      end
+
+      private
+
+      def application_name
+        ENV.fetch('HEARTCHECK_APP_NAME')
+      end
+    end
+  end
+end

data/lib/heartcheck/services/firewall.rb

@@ -14,13 +14,13 @@ module Heartcheck
       # @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
+      # @option params [string] :url 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')
+      #   Firewall.new(url: 'https://domain.com')
+      #   Firewall.new(url: 'https://domain.com', proxy: 'http://proxy.domain.com')
       #
       # @return [void]
       def initialize(params)

data/lib/heartcheck/version.rb

@@ -1,3 +1,3 @@
 module Heartcheck
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heartcheck
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Locaweb
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-28 00:00:00.000000000 Z
+date: 2018-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -243,6 +243,7 @@ files:
 - lib/heartcheck/controllers/functional.rb
 - lib/heartcheck/controllers/health_check.rb
 - lib/heartcheck/controllers/info.rb
+- lib/heartcheck/controllers/inspect.rb
 - lib/heartcheck/errors.rb
 - lib/heartcheck/errors/routing_error.rb
 - lib/heartcheck/errors/warning.rb
@@ -276,7 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A simple way to check if your app is runnig like as expected.