hermes-rb 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7a8150916885c53a7ec982a4a8b4c52b3ae181c372a49d848af7e1938c4e57d
-  data.tar.gz: 1df94ecfc4595c5c8e6c67d79750c4a2fbca4f1a7119a1f5c532b83890a9e1f8
+  metadata.gz: 7cc73b9dbd7c2d1569311975037c0d5f45aac33c3eca2ba581b095dc2670662f
+  data.tar.gz: dbb3cd464fd5ac24ba0e8f9c8dcbaf904a31d49ad43088f1e01c06323862ee36
 SHA512:
-  metadata.gz: 57bd2ad4a3a48368360bc1d7fcd42817ef698f326c423068b237123142707d64ca025af62cc8fc0bc9540a0cfe338d701124d73a19b3fe6795c98a7a91ff3a50
-  data.tar.gz: 89550087ed862bdeb2cb3472d766071f6504f8608ffad58c3fa164c756dee2775b91d7ee299a55949e8ba7d8a31750accaff0688269a13cf81185a924bf71cfc
+  metadata.gz: 04ebe50de83e5c3fbce03dc0c543563cdc7dd3e64f93cb65a7783c4437f56dadd31f5fcb60c8ec3332e480f8485224282728856ae9c0a1d732c7de9918b2a1b7
+  data.tar.gz: 2873fba2537bb1d8eb9b46e829fc1b312d079fd3eed7dc65bed09caa536349741c365ca2ee108617833b360e8e91d0c6814c01c23c13874b68ca725f84b11ae0

data/Changelog.md

@@ -2,6 +2,9 @@
 
 ## Master
 
+## 0.6.0
+- Add Health check
+
 ## 0.5.0
 - Add Datadog tracer
 - Allow to provide a custom tracer

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hermes-rb (0.5.0)
+    hermes-rb (0.6.0)
       activerecord (>= 5)
       activesupport (>= 5)
       dry-container (~> 0)

data/README.md

@@ -459,6 +459,33 @@ end
 
 Hermes is just an extra layer on top of [hutch](https://github.com/gocardless/hutch), refer to Hutch's docs for more info about dealing with the workers and deployment.
 
+## Health Checks
+
+If you want to perform a health check, use `Hermes::Checks::HealthCheck.check`, which checks if it's possible to connect RabbitMQ via Hutch.
+
+The interface is compliant with `health_check`[https://github.com/ianheggie/health_check] gem. If you want to add the custom health check, just add this to the config:
+
+``` rb
+config.add_custom_check("hermes") do
+  Hermes::Checks::HealthCheck.check
+end
+```
+
+You can also use `bin/health_check` file to perform healthcheck - on success, the script exits with `0` status and on failure, it logs the error and exits with `1` status.
+
+To perform the actual check:
+
+1. Via `health_check` gem:
+```
+curl -v localhost:3000/health_check/hermes.json
+```
+
+2. Via binary:
+
+```
+bin/hermes_health_check
+```
+
 ## CircleCI config for installing RabbitMQ
 
 Use `- image: brandembassy/rabbitmq:latest`

data/bin/hermes_health_check

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require_relative "../lib/hermes-rb"
+
+result = Hermes::Checks::HealthCheck.check
+if result.empty?
+  exit 0
+else
+  Hermes::DependenciesContainer["logger"].log_health_check_failure(result)
+  exit 1
+end

data/hermes-rb.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.executables   = ["hermes_health_check"]
   spec.require_paths = ["lib"]
 
   spec.add_dependency "dry-struct", "~> 1"

data/lib/hermes.rb

@@ -25,6 +25,7 @@ require "hermes/producer_error_handler"
 require "hermes/producer_error_handler/null_handler"
 require "hermes/producer_error_handler/safe_handler"
 require "hermes/tracers"
+require "hermes/checks"
 require "active_support"
 require "active_support/core_ext/string"
 require "active_record"

data/lib/hermes/checks.rb

@@ -0,0 +1,5 @@
+module Hermes
+  module Checks
+    autoload :HealthCheck, "hermes/checks/health_check"
+  end
+end

data/lib/hermes/checks/health_check.rb

@@ -0,0 +1,14 @@
+module Hermes
+  module Checks
+    class HealthCheck
+      def self.check
+        broker = Hutch::Broker.new
+        broker.connect
+        broker.disconnect
+        ""
+      rescue StandardError => e
+        "[Hermes - #{e.message}] "
+      end
+    end
+  end
+end

data/lib/hermes/logger.rb

@@ -17,6 +17,10 @@ module Hermes
       backend.info "[Hutch] published event to: #{routing_key}, properties: #{properties}, body: #{strip_sensitive_info(body)} at #{timestamp}"
     end
 
+    def log_health_check_failure(error)
+      backend.info "[Hermes] health check failed: #{error}"
+    end
+
     private
 
     def strip_sensitive_info(body)

data/lib/hermes/rb/version.rb

@@ -1,5 +1,5 @@
 module Hermes
   module Rb
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hermes-rb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Karol Galanciak
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -210,7 +210,8 @@ description: A messenger of gods, delivering them via RabbitMQ with a little hel
   from Hutch
 email:
 - dev@bookingsync.com
-executables: []
+executables:
+- hermes_health_check
 extensions: []
 extra_rdoc_files: []
 files:
@@ -224,12 +225,15 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/hermes_health_check
 - bin/setup
 - hermes-rb.gemspec
 - lib/hermes-rb.rb
 - lib/hermes.rb
 - lib/hermes/b_3_propagation_model_headers.rb
 - lib/hermes/base_event.rb
+- lib/hermes/checks.rb
+- lib/hermes/checks/health_check.rb
 - lib/hermes/configuration.rb
 - lib/hermes/consumer_builder.rb
 - lib/hermes/database_error_handler.rb