rails-healthcheck 1.1.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41e3825b8a1931d4740ab2a7dd883decbd5de9799bcfbc707078babd111789a8
-  data.tar.gz: fc76c416917531adfc415d8b1f67e741abfd48f3132bfcf5298b4a38b1b8fe2f
+  metadata.gz: 2d25b4cf169226744a322cf74972627d1091753e66ba5fe6eec51f3bba7af225
+  data.tar.gz: 60fe9a9689b2c21e4cac94f5cc8baf6586720fe70bda3e2ea6cd1da2086983d4
 SHA512:
-  metadata.gz: 1194978affdbf2c2a6340e7c3a23e28867df07431cf0cf24005fd6c42d63ef9ab5527e4871ead6f6efd2624d5af8b685fbf033568f4b1deca31e01f7247b0ddc
-  data.tar.gz: 810207678952fe7831d803afe44951fda41cd03ad84879a801a530845562e826ff66fd09d19715d354cb81f96bd35bcc9bf8db2edfdce542d957e8799505aca3
+  metadata.gz: a73b3ae6bfe2395d17ef0867db9811e4db58cfa539c4cb9f8d97849b2555206c6b879e1cf82038175760a7a3378436c6daed1bf033df94f975548dd0da3f1fd6
+  data.tar.gz: a36bfef4ea3fca59937a309646f7bd4fc278b9571df00fa98929dd0048e63de6631afcf0264b255c3df8c8bbb1a22eade6bc8b107f1cd889c458812de91f98b4

data/README.md

@@ -3,7 +3,6 @@
 [![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]
 
 A simple way to configure a healthcheck route in Rails applications
 
@@ -11,9 +10,11 @@ A simple way to configure a healthcheck route in Rails applications
 - [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)
@@ -34,7 +35,7 @@ and run the command bellow to create the initializer:
 rails generate healthcheck:install
 ```
 
-## Settings
+### Settings
 
 You can set the settings in the initializer file (_config/initializers/healthcheck.rb_):
 
@@ -48,14 +49,40 @@ 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 --
-  # 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
 ```
 
+### 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:
@@ -80,9 +107,9 @@ When happen an error and verbose is enabled (`config.verbose = true`), the respo
 
 ## Ignoring logs
 
-### Lograge
+If you want to ignore Healthcheck request logs, you can use these options:
 
-If you are using [Lograge](https://github.com/roidrage/lograge) you can ignore Healthcheck logs using this code:
+### [Lograge](https://github.com/roidrage/lograge)
 
 ```ruby
 # config/environments/production.rb
@@ -93,6 +120,18 @@ Rails.application.configure do
 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
@@ -101,17 +140,6 @@ end
 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
@@ -119,17 +147,6 @@ Transfer-Encoding: chunked
 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)
@@ -137,18 +154,6 @@ Transfer-Encoding: chunked
 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"}]}
 ```
 
@@ -176,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
+[gem_version_page]: https://badge.fury.io/rb/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,8 +4,8 @@ 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
-      desc 'It creates an initialize to set the healthcheck settings'
       create_file(
         'config/initializers/healthcheck.rb',
         <<~HEALTHCHECK_INITIALIZER_TEXT
@@ -18,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,7 +2,7 @@
 
 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)
 

data/lib/healthcheck/version.rb

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

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: rails-healthcheck
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.3.0
 platform: ruby
 authors:
 - linqueta
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-25 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -44,28 +58,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 +112,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 +136,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 +173,7 @@ homepage: https://github.com/linqueta/rails-healthcheck
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,9 +188,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: Healthcheck route for a Rails application
 test_files: []