heartcheck 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e666364972b1ce6c0870fb04f3776741fa6ef036
-  data.tar.gz: 25593711517ef4ab307911bdd632989a603c1f71
+  metadata.gz: 45a358d7f3a8864deb797ecb5639d0e4df274c66
+  data.tar.gz: 530d7ecd987f302e38b41395abe67bc9a4ffced3
 SHA512:
-  metadata.gz: 46409b36ce917552188ff52ee01a318c20f574f5009d76bdbea2becfd0bf9a474e7be3b92c5f001a87ad66000e248d0e7c667ec643d4facd8855b7efd620ce34
-  data.tar.gz: 0c92c86fb761879239595a79c75962bc93c7a1c6178b8c43224ef1d16b6ee8a9e3d85229226ad8cd8d7ee542e039b4146a61d4155740feffab880a5dee9a4c2d
+  metadata.gz: 55db326b56112e68f33b488d27bab4dd1d0442aae29f88a2c8f3dfe28e96fdfaadd0dd9e4b01dbaf9f915495cf7fcbe6b7133af1d73c4b662344d9507f1e1c71
+  data.tar.gz: 2d54d671c2944e925d935e7cc3bd6f7db53c0c1d3f2d10b4bc013dd03fbcc100ad60de6b8789a136449ebc4b1a032ca36e5af5718cce2bfd84b49d67f1dd7a46

data/.ebert.yml

@@ -0,0 +1,3 @@
+engines:
+  rubocop:
+    enabled: true

data/CHANGELOG

@@ -1,5 +1,10 @@
 = Heart Check - Changelog
 
+== Version 1.4.0 :: 2017-12-27
+
+ * Adds property `doc_url` to Checks::Base to provide more details about the
+ failure
+
 == Version 1.3.0 :: 2017-09-21
 
  * Adds the `/environment` endpoint

data/README.md

@@ -7,6 +7,7 @@ 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)
+[![Ebert](https://ebertapp.io/github/locaweb/heartcheck.svg)](https://ebertapp.io/github/locaweb/heartcheck)
 
 ## Installation
 

data/lib/heartcheck/checks/base.rb

@@ -30,6 +30,13 @@ module Heartcheck
       # @return [Integer] (default: 0)
       attr_accessor :timeout
 
+      # An url to provide more info about the check.
+      #   It is important to provide details about the failure, for example:
+      #   - what is the impact
+      #   - how to fix it
+      #   - how to reproduce the failure
+      # @return [String] (default: nil)
+      attr_accessor :doc_url
 
       # Create a new instance and set the default values.
       #
@@ -188,7 +195,11 @@ module Heartcheck
       # @return [Hash]
       def format_error
         lambda do |error|
-          error.is_a?(Hash) ? error : { type: 'error', message: error }
+          if error.is_a?(Hash)
+            error
+          else
+            { type: 'error', message: error, doc_url: doc_url }
+          end
         end
       end
     end

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

@@ -14,6 +14,8 @@ Heartcheck.setup do |monitor|
   # For each check you can set the folling options
   #        name: String  => root name to show in report page (default: class.name)
   #  functional: Boolean => When is false your check is essential to your application (default: false)
+  #     doc_url: String  => To provide more details about the failure (optional)
+  # (default: nil)
   #    on_error: Block   => to customize the errors (default: nil)
   # to_validate: Block   => to validate the sevices (default: nil)
   #
@@ -23,6 +25,7 @@ Heartcheck.setup do |monitor|
   #   c.name       = "filesystem"
   #   c.functional = true
   #   c.add_service(name: "my_file", path: "/var/www/my_project/my_file")
+  #   c.doc_url    = 'http://docs.com/monitoring#check-filesystem'
   #
   #   c.on_error do |sevices|
   #     errors << "Custom error message for #{service[:name]}"

data/lib/heartcheck/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heartcheck
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Locaweb
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2017-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -212,6 +212,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".ebert.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -275,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A simple way to check if your app is runnig like as expected.