govuk_app_config 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97c53dced58ec8966b00eafd00aca2ce042ff3537b6d7beb5ef26d3ba7b32d42
-  data.tar.gz: c2828b3c76b1a9fd81afd7d5c939eaa5ccf31e4c95c457d3317a1f28714a4546
+  metadata.gz: 9fc8eb993da7f05c65a86ed611ecca3d47a61c5966482d24f657d2b0799ccfe4
+  data.tar.gz: 2e70812a60e8af9649df62acd3c6e2c4db5f011bab737b53f12241afe4670bf0
 SHA512:
-  metadata.gz: 7a52a2c462bfe26d9b5db5dacab7ba4407d73b7580f68412412929fa16275222a7ff151fca08912628bdc825cf2a55b24c045c97c1b38cd90a8a2cd33d6c70bd
-  data.tar.gz: ad5613de6d8d9ba992c6dc432467250cb3db36cecd847b7713716fbaf5313f1bdf625502cf920add7e829853a11830409b6ff387cee00072feb88fedcc9b1f43
+  metadata.gz: 4394c0661fad4cf1bf067d3b1a2cf50fa37f93112b2fec97b153e39f040ab10834c47b48056cdb2dc071e64cee182f1183ef095f55292b1998b10db450ae285e
+  data.tar.gz: 634551494d9d5691cdd524731e41d94bc3ccbb8b2de218f73acbaca97755a01e0efc7710686a8ae6ec48d3115e3fd849e3b33f9cc1a6221f3a3c2f8f1e7a7c5d

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.5.0
+
+* Add healthcheck support.  See README.md for usage information.
+
 # 1.4.2
 
 * Ignore `ActionController::UnknownHttpMethod` errors.

data/README.md

@@ -47,12 +47,6 @@ $ bundle exec unicorn -c config/unicorn.rb
 
 If you include `govuk_app_config` in your `Gemfile`, Rails' autoloading mechanism will make sure that your application is configured to send errors to Sentry.
 
-If you use the gem outside of Rails you'll have to explicitly require it:
-
-```rb
-require "govuk_app_config"
-```
-
 Your app will have to have the following environment variables set:
 
 - `SENTRY_DSN` - the [Data Source Name (DSN)][dsn] for Sentry
@@ -111,6 +105,51 @@ GovukStatsd.gauge "bork", 100
 GovukStatsd.time("account.activate") { @account.activate! }
 ```
 
+## Healthchecks
+
+Set up a route in your rack-compatible Ruby application, and pick the built-in
+or custom checks you wish to perform.
+
+Custom checks must be any class or instance which implements
+[this interface](spec/lib/govuk_healthcheck/shared_interface.rb):
+```ruby
+module CustomCheck
+  def self.name
+    :custom_check
+  end
+
+  def self.status
+    ThingChecker.everything_okay? ? OK : CRITICAL
+  end
+
+  # Optional
+  def self.message
+    "This is an optional custom message"
+  end
+
+  # Optional
+  def self.details
+    {
+      extra: "This is an optional details hash",
+    }
+  end
+end
+```
+
+For Rails apps:
+```ruby
+get "/healthcheck", to: GovukHealthcheck.rack_response(
+  GovukHealthcheck::SidekiqRedis,
+  GovukHealthcheck::ActiveRecord,
+  CustomCheck,
+)
+```
+
+This will check:
+- Redis connectivity (via Sidekiq)
+- Database connectivity (via ActiveRecord)
+- Your custom healthcheck
+
 ## Rails logging
 
 In Rails applications, the application will be configured to send JSON-formatted

data/lib/govuk_app_config.rb

@@ -2,6 +2,7 @@ require "govuk_app_config/version"
 require "govuk_app_config/govuk_statsd"
 require "govuk_app_config/govuk_error"
 require "govuk_app_config/govuk_logging"
+require "govuk_app_config/govuk_healthcheck"
 # This require is deprecated and should be removed on next major version bump
 # and should be required by applications directly.
 require "govuk_app_config/govuk_unicorn"

data/lib/govuk_app_config/govuk_healthcheck.rb

@@ -0,0 +1,14 @@
+require "govuk_app_config/govuk_healthcheck/checkup"
+require "govuk_app_config/govuk_healthcheck/active_record"
+require "govuk_app_config/govuk_healthcheck/sidekiq_redis"
+require "json"
+
+module GovukHealthcheck
+  def self.rack_response(*checks)
+    proc { [200, {}, [JSON.dump(healthcheck(checks))]] }
+  end
+
+  def self.healthcheck(checks)
+    Checkup.new(checks).run
+  end
+end

data/lib/govuk_app_config/govuk_healthcheck/active_record.rb

@@ -0,0 +1,11 @@
+module GovukHealthcheck
+  module ActiveRecord
+    def self.name
+      :database_connectivity
+    end
+
+    def self.status
+      ::ActiveRecord::Base.connected? ? OK : CRITICAL
+    end
+  end
+end

data/lib/govuk_app_config/govuk_healthcheck/checkup.rb

@@ -0,0 +1,53 @@
+module GovukHealthcheck
+  STATUSES = [
+    OK = "ok".freeze,
+    WARNING = "warning".freeze,
+    CRITICAL = "critical".freeze,
+  ].freeze
+
+  class Checkup
+    # @param checks [Array] Array of objects/classes that respond to `run`
+    def initialize(checks)
+      @checks = checks
+    end
+
+    def run
+      {
+        status: worst_status,
+        checks: component_statuses,
+      }
+    end
+
+  private
+
+    def component_statuses
+      @component_statuses ||= @checks.each_with_object({}) do |check, hash|
+        hash[check.name] = build_component_status(check)
+      end
+    end
+
+    def worst_status
+      if status?(CRITICAL)
+        CRITICAL
+      elsif status?(WARNING)
+        WARNING
+      else
+        OK
+      end
+    end
+
+    def status?(status)
+      component_statuses.values.any? {|s| s[:status] == status }
+    end
+
+    def build_component_status(check)
+      component_status = details(check).merge(status: check.status)
+      component_status[:message] = check.message if check.respond_to?(:message)
+      component_status
+    end
+
+    def details(check)
+      check.respond_to?(:details) ? check.details : {}
+    end
+  end
+end

data/lib/govuk_app_config/govuk_healthcheck/sidekiq_redis.rb

@@ -0,0 +1,11 @@
+module GovukHealthcheck
+  module SidekiqRedis
+    def self.name
+      :redis_connectivity
+    end
+
+    def self.status
+      Sidekiq.redis_info ? OK : CRITICAL
+    end
+  end
+end

data/lib/govuk_app_config/govuk_logging.rb

@@ -1,4 +1,3 @@
-
 require 'logstasher'
 
 module GovukLogging

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "1.4.2"
+  VERSION = "1.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-04 00:00:00.000000000 Z
+date: 2018-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statsd-ruby
@@ -158,6 +158,10 @@ files:
 - lib/govuk_app_config.rb
 - lib/govuk_app_config/configure.rb
 - lib/govuk_app_config/govuk_error.rb
+- lib/govuk_app_config/govuk_healthcheck.rb
+- lib/govuk_app_config/govuk_healthcheck/active_record.rb
+- lib/govuk_app_config/govuk_healthcheck/checkup.rb
+- lib/govuk_app_config/govuk_healthcheck/sidekiq_redis.rb
 - lib/govuk_app_config/govuk_logging.rb
 - lib/govuk_app_config/govuk_statsd.rb
 - lib/govuk_app_config/govuk_unicorn.rb
@@ -183,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Base configuration for GOV.UK applications