rails-healthcheck 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90d8e05e3632eea15ad496a96cad8ab62120f22bfa1b2b9e5d0d58965fc6015b
-  data.tar.gz: baa0baa4729818b03ec644ffbfcf1f5b41741458422c6a1c4baff96cef6dca95
+  metadata.gz: eb62ca798614c3adf6326d3b15cac4dd404f177d1dc5ad5f491938f2e3534530
+  data.tar.gz: 531f13e1c8cf658a26e85569e3d72b47b38498a17843cc0c28722c757369d929
 SHA512:
-  metadata.gz: bc248fa637568e69c70389b6d74ae9d1a88608781f9b5b31488355a836cf9549aaec03e5d258cde1c61a44c0d1bb2ca61df019540b60b35276c5d2979059ff78
-  data.tar.gz: 6e23c81ce1702ddbd4ba205de93194c19384e06c7ca92ff69b1fbc964b2abf2b8af007e96b2f53d757dc77d17dad28030bff31532edc04ad2a179de4b958c258
+  metadata.gz: 0c347e99945ed94ce23ee3c4e4c9250b12da9381aa371392ff08e8bd5d247e72179f38f1c57edb1a51008cb113e22e6029795b8c5e22d31a620f30c133085837
+  data.tar.gz: a40b7c53c042fa550507fd3d9102eaf4ffb0ec84503f538976a7463c435832d18a0be1816683b9a2157c657c100a09847572ec9864762d454074e987599bc9d4

data/README.md

@@ -1,13 +1,27 @@
 # [Rails::Healthcheck][gem_page]
 
+[![Gem Version][gem_version_image]][gem_version_page]
 [![Build Status][travis_status_image]][travis_page]
 [![Maintainability][code_climate_maintainability_image]][code_climate_maintainability_page]
-[![Test Coverage][code_climate_test_coverage_image]][code_climate_test_coverage_page]
-[![Gem Version][gem_version_image]][gem_version_page]
 
 A simple way to configure a healthcheck route in Rails applications
 
-## Installation
+## Table of Contents
+- [Getting started](#getting-started)
+  - [Installation](#installation)
+  - [Settings](#settings)
+  - [Custom Response](#custom-response)
+  - [Verbose Errors](#verbose-errors)
+  - [Ignoring logs](#ignoring-logs)
+    - [Lograge](#lograge)
+    - [Datadog](#lograge)
+  - [Requests Examples](#requests-examples)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Getting started
+
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -15,14 +29,15 @@ Add this line to your application's Gemfile:
 gem 'rails-healthcheck'
 ```
 
-and run:
+and run the command bellow to create the initializer:
 
 ```
 rails generate healthcheck:install
 ```
 
-## Settings
-Set the settings in the file _config/initializers/healthcheck.rb_:
+### Settings
+
+You can set the settings in the initializer file (_config/initializers/healthcheck.rb_):
 
 ```ruby
 # frozen_string_literal: true
@@ -34,19 +49,42 @@ Healthcheck.configure do |config|
   config.route = '/healthcheck'
   config.method = :get
 
+  # -- Custom Response --
+  # config.custom = lambda { |controller, checker|
+  #   controller.render json: my_custom_response unless checker.errored?
+  #   ...
+  # }
+
   # -- Checks --
-  # Check if the db is available
-  # config.add_check :database, -> { ActiveRecord::Base.connection.execute('select 1') }
-  # Check if the db is available and without pending migrations
-  # config.add_check :migrations,-> { ActiveRecord::Migration.check_pending! }
-  # Check if the cache is available
-  # config.add_check :cache, -> { Rails.cache.read('some_key') }
-  # Check if the application required envs are defined
+  # config.add_check :database,     -> { ActiveRecord::Base.connection.execute('select 1') }
+  # config.add_check :migrations,   -> { ActiveRecord::Migration.check_pending! }
+  # config.add_check :cache,        -> { Rails.cache.read('some_key') }
   # config.add_check :environments, -> { Dotenv.require_keys('ENV_NAME', 'ANOTHER_ENV') }
 end
 ```
 
-### Verbose errors
+### Custom Response
+
+You can override the configs `success`, `error` and `verbose` and write your custom behaviour for the healthcheck api using the field `custom` in the initializer:
+
+```ruby
+Healthcheck.configure do |config|
+  # ...
+
+  # -- Custom Response --
+  config.custom = lambda { |controller, checker|
+    controller.render json: { field_name: 'my custom field value' } unless checker.errored?
+    ...
+  }
+
+  # ...
+end
+```
+
+Pass a `lambda` or `proc` receiving the params `controller` and `checker` to use it correctly. To use checker, you can see the avialable methods [here][checker_url] and [how][healthcheck_controller_url] it is implemented on HealthcheckController.
+
+### Verbose Errors
+
 When happen an error and verbose is enabled (`config.verbose = true`), the response will be like this:
 
 ```json
@@ -67,79 +105,58 @@ When happen an error and verbose is enabled (`config.verbose = true`), the respo
 }
 ```
 
-### Requests
+## Ignoring logs
 
-- Success
+If you want to ignore Healthcheck request logs, you can use these options:
+
+### [Lograge](https://github.com/roidrage/lograge)
+
+```ruby
+# config/environments/production.rb
+
+Rails.application.configure do
+  config.lograge.enabled = true
+  config.lograge.ignore_actions = [Healthcheck::CONTROLLER_ACTION]
+end
 ```
+
+### [Datadog](https://github.com/roidrage/lograge)
+
+```ruby
+# config/environments/production.rb
+
+filter = Datadog::Pipeline::SpanFilter.new do |span|
+  span.name == 'rack.request' && span.get_tag('http.url') == Healthcheck.configuration.route
+end
+
+Datadog::Pipeline.before_flush(filter)
+```
+
+### Requests Examples
+
+- Success
+
+```shell
 curl -i localhost:3000/healthcheck
 
 HTTP/1.1 200 OK
-X-Frame-Options: SAMEORIGIN
-X-XSS-Protection: 1; mode=block
-X-Content-Type-Options: nosniff
-X-Download-Options: noopen
-X-Permitted-Cross-Domain-Policies: none
-Referrer-Policy: strict-origin-when-cross-origin
-Content-Type: text/html
-Cache-Control: no-cache
-X-Request-Id: cbc9fdd0-8090-4927-b061-1e82bcf2e039
-X-Runtime: 0.003599
-Transfer-Encoding: chunked
 ```
 
 - Error
-```
+```shell
 curl -i localhost:3000/healthcheck
 
 HTTP/1.1 503 Service Unavailable
-X-Frame-Options: SAMEORIGIN
-X-XSS-Protection: 1; mode=block
-X-Content-Type-Options: nosniff
-X-Download-Options: noopen
-X-Permitted-Cross-Domain-Policies: none
-Referrer-Policy: strict-origin-when-cross-origin
-Content-Type: text/html
-Cache-Control: no-cache
-X-Request-Id: e07eb20f-7d32-4f1a-86ad-32403de2b19a
-X-Runtime: 0.033772
-Transfer-Encoding: chunked
 ```
 
 - Error (Verbose)
-```
+```shell
 curl -i localhost:3000/healthcheck
 
 HTTP/1.1 503 Service Unavailable
-X-Frame-Options: SAMEORIGIN
-X-XSS-Protection: 1; mode=block
-X-Content-Type-Options: nosniff
-X-Download-Options: noopen
-X-Permitted-Cross-Domain-Policies: none
-Referrer-Policy: strict-origin-when-cross-origin
-Content-Type: application/json; charset=utf-8
-Cache-Control: no-cache
-X-Request-Id: 8fa5e69a-bfe3-4bbc-875b-ce86f4269467
-X-Runtime: 0.019992
-Transfer-Encoding: chunked
-
 {"code":503,"errors":[{"name":"zero_division","exception":"ZeroDivisionError","message":"divided by 0"}]}
 ```
 
-## Ignoring logs
-
-### Lograge
-
-If you are using [Lograge](https://github.com/roidrage/lograge) you can ignore Healthcheck logs using this code:
-
-```ruby
-# config/environments/production.rb
-
-Rails.application.configure do
-  config.lograge.enabled = true
-  config.lograge.ignore_actions = [Healthcheck::CONTROLLER_ACTION]
-end
-```
-
 ## Contributing
 
 1. Fork it
@@ -164,7 +181,7 @@ Everyone interacting in the Rails::Healthcheck project’s codebases, issue trac
 [travis_page]: https://travis-ci.org/linqueta/rails-healthcheck
 [code_climate_maintainability_image]: https://api.codeclimate.com/v1/badges/670d851a6c06f77fa36e/maintainability
 [code_climate_maintainability_page]: https://codeclimate.com/github/linqueta/rails-healthcheck/maintainability
-[code_climate_test_coverage_image]: https://api.codeclimate.com/v1/badges/670d851a6c06f77fa36e/test_coverage
-[code_climate_test_coverage_page]: https://codeclimate.com/github/linqueta/rails-healthcheck/test_coverage
 [gem_version_image]: https://badge.fury.io/rb/rails-healthcheck.svg
 [gem_version_page]: https://rubygems.org/gems/rails-healthcheck
+[checker_url]: https://github.com/linqueta/rails-healthcheck/blob/master/lib/healthcheck/checker.rb
+[healthcheck_controller_url]: https://github.com/linqueta/rails-healthcheck/blob/master/app/controllers/healthcheck/healthchecks_controller.rb

data/app/controllers/healthcheck/healthchecks_controller.rb

@@ -5,6 +5,7 @@ module Healthcheck
   class HealthchecksController < ActionController::Base
     def check
       checker = Healthcheck.check
+      return Healthcheck.configuration.custom.call(self, checker) if Healthcheck.configuration.custom
       return head Healthcheck.configuration.success unless checker.errored?
 
       verbose? ? verbose_error(checker) : head_error
@@ -13,7 +14,7 @@ module Healthcheck
     private
 
     def head_error
-      head(Healthcheck.configuration.error)
+      head Healthcheck.configuration.error
     end
 
     def verbose_error(checker)

data/lib/generators/healthcheck/install_generator.rb

@@ -4,6 +4,7 @@ require 'rails/generators/base'
 
 module Healthcheck
   class InstallGenerator < Rails::Generators::Base
+    desc 'It creates an initializer to set the healthcheck settings'
     def create_initializer_file
       create_file(
         'config/initializers/healthcheck.rb',
@@ -17,10 +18,16 @@ module Healthcheck
             config.route = '/healthcheck'
             config.method = :get
 
+            # -- Custom Response --
+            # config.custom = lambda { |controller, checker|
+            #   controller.render json: my_custom_response unless checker.errored?
+            #   ...
+            # }
+
             # -- Checks --
-            # config.add_check :database, -> { ActiveRecord::Base.connection.execute('select 1') }
-            # config.add_check :migrations,-> { ActiveRecord::Migration.check_pending! }
-            # config.add_check :cache, -> { Rails.cache.read('some_key') }
+            # config.add_check :database,     -> { ActiveRecord::Base.connection.execute('select 1') }
+            # config.add_check :migrations,   -> { ActiveRecord::Migration.check_pending! }
+            # config.add_check :cache,        -> { Rails.cache.read('some_key') }
             # config.add_check :environments, -> { Dotenv.require_keys('ENV_NAME', 'ANOTHER_ENV') }
           end
         HEALTHCHECK_INITIALIZER_TEXT

data/lib/healthcheck/configuration.rb

@@ -2,12 +2,11 @@
 
 module Healthcheck
   class Configuration
-    SETTINGS = %i[success error verbose route method checks].freeze
+    SETTINGS = %i[success error verbose route method checks custom].freeze
 
     attr_accessor(*SETTINGS)
 
     def initialize
-      SETTINGS.each { |key, _| instance_variable_set("@#{key}", nil) }
       clear!
     end
 

data/lib/healthcheck/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Healthcheck
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-healthcheck
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - linqueta
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +98,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
   name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple way to configure a healthcheck route for a Rails application
 email:
 - lincolnrodrs@gmail.com
@@ -145,7 +159,7 @@ homepage: https://github.com/linqueta/rails-healthcheck
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,9 +174,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
-summary: A simple way to configure a healthcheck route for a Rails application
+summary: Healthcheck route for a Rails application
 test_files: []