rails-healthcheck 1.1.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 370d735adceeebed3048fbd2284ea7438c929d6837a80da08c784116d087fb8d
-  data.tar.gz: 18e713ea4c2416c4bc57c1849de24011ba2bc3598c010927a3052814faac8f51
+  metadata.gz: 5a5cf78b04593281cfd2e3018a79703e07aadc3d2a4ace5cc2d972f7ad083705
+  data.tar.gz: d0559dc632284d6f0a7f853632998973e6f2937974b1e20606a55851e1cd7c46
 SHA512:
-  metadata.gz: 511307f0fd44e27b7ea2f8835d1908bfbcd9eb79808b5c3b062d734a40d1f92c34d1e8b0c5c9fb46c93bdc7d824eaf1434b051ef4e412e0124ab71d8483e0c7c
-  data.tar.gz: '073971490643f620002ae30b79dc38a01424caaf511a9de8f1d7f3a4e077c2bb2708b83d9b404cf64fb67e837e48a41403955333029baeb3eea5cc1ff114be03'
+  metadata.gz: c9e1c73e1314bd9731e0f81f4aa45364490e64b9fbdb3339b93506337c9778a76172347af086fe7cb834f5e5740cb63df9203968554685febaaf0e65e21c1e5b
+  data.tar.gz: 453b5a2ce77392ad5b1763d3e56b386d2a078c2fc3d9f950e30b673b331f1400a4f966228141de6cb2ee7a31eef09d022d68901abe2ff1e31c024867a6a13321

data/README.md

@@ -1,19 +1,19 @@
 # [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]
 
 A simple way to configure a healthcheck route in Rails applications
 
 ## Table of Contents
+
 - [Getting started](#getting-started)
   - [Installation](#installation)
   - [Settings](#settings)
-  - [Verbose Errors](#verbose-errors)
+  - [Custom Response](#custom-response)
+  - [Verbose](#verbose)
   - [Ignoring logs](#ignoring-logs)
     - [Lograge](#lograge)
+    - [Datadog](#datadog)
   - [Requests Examples](#requests-examples)
 - [Contributing](#contributing)
 - [License](#license)
@@ -34,7 +34,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,41 +48,81 @@ Healthcheck.configure do |config|
   config.route = '/healthcheck'
   config.method = :get
 
+  # -- Custom Response --
+  # config.custom = lambda { |controller, checker|
+  #   return controller.render(plain: 'Everything is awesome!') unless checker.errored?
+  #   controller.verbose? ? controller.verbose_error(checker) : controller.head_error
+  # }
+
   # -- 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
 ```
 
-### 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
+
+You can enable verbose responses setting `config.verbose = true`.
+
+- On success
+
+```json
+{
+  "code": 200,
+  "status": {
+    "migrations": "OK",
+    "environments": "OK"
+  }
+}
+```
 
-When happen an error and verbose is enabled (`config.verbose = true`), the response will be like this:
+- On error
 
 ```json
 {
-    "code": 503,
-    "errors": [
-        {
-            "name": "migrations",
-            "exception": "ActiveRecord::PendingMigrationError",
-            "message": "Migrations are pending. To resolve this issue, run: bin/rails db:migrate RAILS_ENV=production"
-        },
-        {
-            "name": "environments",
-            "exception": "Dotenv::MissingKeys",
-            "message": "Missing required configuration key: [\"RAILS_ENV\"]"
-        }
-    ]
+  "code": 503,
+  "errors": [
+    {
+      "name": "migrations",
+      "exception": "ActiveRecord::PendingMigrationError",
+      "message": "Migrations are pending. To resolve this issue, run: bin/rails db:migrate RAILS_ENV=production"
+    },
+    {
+      "name": "environments",
+      "exception": "Dotenv::MissingKeys",
+      "message": "Missing required configuration key: [\"RAILS_ENV\"]"
+    }
+  ]
 }
 ```
 
 ## 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 +133,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,54 +153,22 @@ 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
+
 ```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"}]}
 ```
 
@@ -172,11 +192,7 @@ Everyone interacting in the Rails::Healthcheck project’s codebases, issue trac
 [code_of_conduct_page]: https://github.com/linqueta/rails-healthcheck/blob/master/CODE_OF_CONDUCT.md
 [mit_license_page]: https://opensource.org/licenses/MIT
 [contributor_convenant_page]: http://contributor-covenant.org
-[travis_status_image]: https://travis-ci.org/linqueta/rails-healthcheck.svg?branch=master
-[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

@@ -1,31 +1,19 @@
 # frozen_string_literal: true
 
 require 'action_controller/railtie'
+
 module Healthcheck
   class HealthchecksController < ActionController::Base
     def check
-      checker = Healthcheck.check
-      return head Healthcheck.configuration.success unless checker.errored?
-
-      verbose? ? verbose_error(checker) : head_error
-    end
-
-    private
+      return Healthcheck.custom!(self) if Healthcheck.custom?
 
-    def head_error
-      head(Healthcheck.configuration.error)
-    end
-
-    def verbose_error(checker)
-      render status: Healthcheck.configuration.error,
-             json: {
-               code: Healthcheck.configuration.error,
-               errors: checker.errors.as_json
-             }
-    end
-
-    def verbose?
-      Healthcheck.configuration.verbose
+      checker = Healthcheck.check
+      response = if checker.errored?
+                   Healthcheck::Response::Error.new(self, checker)
+                 else
+                   Healthcheck::Response::Success.new(self, checker)
+                 end
+      response.execute!
     end
   end
 end

data/lib/generators/healthcheck/install_generator.rb

@@ -18,10 +18,16 @@ module Healthcheck
             config.route = '/healthcheck'
             config.method = :get
 
+            # -- Custom Response --
+            # config.custom = lambda { |controller, checker|
+            #   return controller.render(plain: 'Everything is awesome!') unless checker.errored?
+            #   controller.verbose? ? controller.verbose_error(checker) : controller.head_error
+            # }
+
             # -- 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.rb

@@ -8,6 +8,10 @@ require 'healthcheck/error'
 require 'healthcheck/router'
 require 'healthcheck/engine'
 
+require 'healthcheck/response/base'
+require 'healthcheck/response/success'
+require 'healthcheck/response/error'
+
 module Healthcheck
   CONTROLLER_ACTION = 'Healthcheck::HealthchecksController#check'
 
@@ -22,10 +26,18 @@ module Healthcheck
   end
 
   def routes(router)
-    Healthcheck::Router.mount(router)
+    Router.mount(router)
   end
 
   def check
-    Healthcheck::Checker.new.tap(&:check)
+    Checker.new.tap(&:check)
+  end
+
+  def custom!(controller)
+    configuration.custom.call(controller, check)
+  end
+
+  def custom?
+    configuration.custom
   end
 end

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/response/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Healthcheck
+  module Response
+    class Base
+      def initialize(controller, checker)
+        @controller = controller
+        @checker = checker
+        @configuration = Healthcheck.configuration
+      end
+
+      def execute!
+        verbose? ? @controller.render(verbose) : @controller.head(status)
+      end
+
+      private
+
+      def verbose?
+        @configuration.verbose
+      end
+    end
+  end
+end

data/lib/healthcheck/response/error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Healthcheck
+  module Response
+    class Error < Base
+      def verbose
+        {
+          status: Healthcheck.configuration.error,
+          json: {
+            code: Healthcheck.configuration.error,
+            errors: @checker.errors.as_json
+          }
+        }
+      end
+
+      def status
+        @configuration.error
+      end
+    end
+  end
+end

data/lib/healthcheck/response/success.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Healthcheck
+  module Response
+    class Success < Base
+      def verbose
+        {
+          status: @configuration.success,
+          json: {
+            code: @configuration.success,
+            status: @configuration.checks.each_with_object({}) { |check, obj| obj[check.name] = 'OK' }
+          }
+        }
+      end
+
+      def status
+        @configuration.success
+      end
+    end
+  end
+end

data/lib/healthcheck/version.rb

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

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: rails-healthcheck
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.4.0
 platform: ruby
 authors:
 - linqueta
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2021-05-16 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,14 +58,14 @@ 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-rails
   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
@@ -152,6 +166,9 @@ files:
 - lib/healthcheck/configuration.rb
 - lib/healthcheck/engine.rb
 - lib/healthcheck/error.rb
+- lib/healthcheck/response/base.rb
+- lib/healthcheck/response/error.rb
+- lib/healthcheck/response/success.rb
 - lib/healthcheck/router.rb
 - lib/healthcheck/version.rb
 - lib/rails-healthcheck.rb
@@ -159,7 +176,7 @@ homepage: https://github.com/linqueta/rails-healthcheck
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -175,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Healthcheck route for a Rails application
 test_files: []