health-reporter 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90f655ef277bd77b6f90e6129976868c5c3f934f
-  data.tar.gz: d905978f2768c0472a238e4b5c8c3c0b3831e882
+  metadata.gz: 155d97c5b4cc48d064e2d0c3ba40c19094a6c700
+  data.tar.gz: 2e1bc68f9c30819cd1fd586ce1a7f01552e038dc
 SHA512:
-  metadata.gz: 9ab4e6974bcc5ffad2e8d454e28f21e87d1528c6bd3fbfc4fd13bdcd1850d57a0502df6e7000b9d2fa3d21fa0eabfcca69564b0495f2972f25d256aa8262fd0d
-  data.tar.gz: df47ccab910847e661cc3769594344408635bdced26e8c93563bfceb672fa6445ad332010ae94dc05cf0ede58be9fb7bcf80fec1cd13b8afb28a77eae4e935ac
+  metadata.gz: 049f9b1956fccdd9d144bcb087e159b8555e2e861d239a0f32929209ce65c88426586fa5d2b18647656f02e50e4be0e08e1ba1d426d30427f36b6dd007bdd9a8
+  data.tar.gz: 1a538e5844bff5fd7c8ac3a0e29d1814e86884ffb03f040959dfdc731944865e64960237453c9f10ef6d3eb73581cec4f276980e0f601c42f0d9b836373bdb46

data/README.md

@@ -1,5 +1,6 @@
 # HealthReporter
 
+The HealthReporter gem makes the caching of health check requests on services easy.  Simiply register a lambda returning true/false that determines if the service is healthy or not.  The HealthReporter caches the result for future requests using a TTL value.  If the cache is still valid it will not use the lambda to determine service health.
 
 ## Installation
 
@@ -33,7 +34,47 @@ docker-compose run --rm health-reporter bundle exec rspec -cfd spec/*
 
 ## Usage
 
-#TODO add dependency registration and calling
+### Overview
+
+Out of the box you can simply call it as follows with the preconfigured always true self-check lambda:
+```ruby
+  require 'health_reporter'
+  HealthReporter.healthy?
+  => true
+```
+
+The default values can be overridden as follow:
+```ruby
+  require 'health_reporter'
+  HealthReporter.self_test = lambda{ false }
+  HealthReporter.healthy_cache_ttl = 60
+  HealthReporter.unhealthy_cache_ttl = 30
+  HealthReporter.healthy?
+  => false
+```
+
+### Configuration on startup
+
+First it is set up somewhere in your service startup (config.ru) where you configure how it determines health:
+```ruby
+  require 'health_reporter'
+  HealthReporter.self_test = lambda{ false }
+  HealthReporter.healthy_cache_ttl = 60
+  HealthReporter.unhealthy_cache_ttl = 30
+```
+
+### Health checking via an endpoint
+
+In the controller/model of the health check you simply call the following and based on the boolean return respond with 200 or 500 for other services to see this service health:
+```ruby
+  require 'health_reporter'
+  HealthReporter.healthy?
+  => false
+```
+
+## Future
+
+### Add dependency registration and calling
 
 ## Contributing
 

data/lib/health_reporter/version.rb

@@ -1,3 +1,3 @@
 class HealthReporter
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: health-reporter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Barney de Villiers