govuk_app_config 2.10.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f98f57ba0b9010154d3aefbc2540acd056d35ef42af9e3b22b00495255f46899
-  data.tar.gz: c5315e4ba1f476e7c0fcb99839ad9e8705a1546e4b48e3246a16e94f6552b383
+  metadata.gz: 68431d222e7798dd3027131ef5d05ea7cfab1f7df54d5e06274f2de19f4e51ea
+  data.tar.gz: 6c5273bd18e606f6269279d547e91630574d61dc7a1151bfbbecd55f3f38d371
 SHA512:
-  metadata.gz: cea414c28b13d2b9cb359bade9dd6626eceb9dfd0f76ca79f77b2b8bff9f4807c01858951860e6888f795a32aa50cd2c79cc1ea63f72a01315a6cbd44b49d8cd
-  data.tar.gz: 3ef1e0ea53a489935775c9475cecb5f55585d2cfba0aed30b6a184430ab7fada8e24670150ebfa60043a59a6d750f76aeb913b89f826da2bbe3db68ca524cc7a
+  metadata.gz: '06387b0c49fe60c29728fdda8a8f3bfe529c9b8db2b87ef795b20dfb2ef157667102768d496a7cb1ccad4425265051075f9886d9e155632bb68c47626480c882'
+  data.tar.gz: 4ec51524d66f98be80b779d28ec65d0355b721e2fd794c03f4c61a573371c800e46f6d7c6ee514dd080430763803f7396bcd37c0e4bd7e57d33d886f6ae59980

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 3.0.0
+
+* BREAKING: Implement RFC 141 - remove unsuitable healthchecks and return a 500 on healthcheck failure ([#193](https://github.com/alphagov/govuk_app_config/pull/193))
+
 # 2.10.0
 * Allow LUX domain on img-src policy ([#191](https://github.com/alphagov/govuk_app_config/pull/191))
 

data/lib/govuk_app_config/govuk_healthcheck.rb

@@ -4,19 +4,16 @@ require "govuk_app_config/govuk_healthcheck/mongoid"
 require "govuk_app_config/govuk_healthcheck/rails_cache"
 require "govuk_app_config/govuk_healthcheck/redis"
 require "govuk_app_config/govuk_healthcheck/sidekiq_redis"
-require "govuk_app_config/govuk_healthcheck/threshold_check"
-require "govuk_app_config/govuk_healthcheck/sidekiq_queue_check"
-require "govuk_app_config/govuk_healthcheck/sidekiq_queue_latency_check"
-require "govuk_app_config/govuk_healthcheck/sidekiq_retry_size_check"
 require "json"
 
 module GovukHealthcheck
   def self.rack_response(*checks)
     proc do
+      checkup = healthcheck(checks)
       [
-        200,
+        checkup[:status] == :ok ? 200 : 500,
         { "Content-Type" => "application/json" },
-        [JSON.dump(healthcheck(checks))],
+        [JSON.dump(checkup)],
       ]
     end
   end

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "2.10.0".freeze
+  VERSION = "3.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 3.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstasher
@@ -237,11 +237,7 @@ files:
 - lib/govuk_app_config/govuk_healthcheck/mongoid.rb
 - lib/govuk_app_config/govuk_healthcheck/rails_cache.rb
 - lib/govuk_app_config/govuk_healthcheck/redis.rb
-- lib/govuk_app_config/govuk_healthcheck/sidekiq_queue_check.rb
-- lib/govuk_app_config/govuk_healthcheck/sidekiq_queue_latency_check.rb
 - lib/govuk_app_config/govuk_healthcheck/sidekiq_redis.rb
-- lib/govuk_app_config/govuk_healthcheck/sidekiq_retry_size_check.rb
-- lib/govuk_app_config/govuk_healthcheck/threshold_check.rb
 - lib/govuk_app_config/govuk_i18n.rb
 - lib/govuk_app_config/govuk_logging.rb
 - lib/govuk_app_config/govuk_statsd.rb

data/lib/govuk_app_config/govuk_healthcheck/sidekiq_queue_check.rb

@@ -1,62 +0,0 @@
-module GovukHealthcheck
-  class SidekiqQueueCheck
-    def status
-      queues.each do |name, value|
-        if value >= critical_threshold(queue: name)
-          return :critical
-        elsif value >= warning_threshold(queue: name)
-          return :warning
-        end
-      end
-
-      :ok
-    end
-
-    def message
-      messages = queues.map do |name, value|
-        critical = critical_threshold(queue: name)
-        warning = warning_threshold(queue: name)
-
-        if value >= critical
-          "#{name} (#{value}) is above the critical threshold (#{critical})"
-        elsif value >= warning
-          "#{name} (#{value}) is above the warning threshold (#{warning})"
-        end
-      end
-
-      messages = messages.compact
-
-      if messages.empty?
-        "all queues are below the critical and warning thresholds"
-      else
-        messages.join("\n")
-      end
-    end
-
-    def details
-      {
-        queues: queues.each_with_object({}) do |(name, value), hash|
-          hash[name] = {
-            value: value,
-            thresholds: {
-              critical: critical_threshold(queue: name),
-              warning: warning_threshold(queue: name),
-            }.reject { |_, val| val.to_f.infinite? || val.to_f.nan? },
-          }
-        end,
-      }
-    end
-
-    def queues
-      raise "This method must be overriden to be a hash of queue names and data."
-    end
-
-    def critical_threshold(queue:) # rubocop:disable Lint/UnusedMethodArgument
-      raise "This method must be overriden to be the critical threshold."
-    end
-
-    def warning_threshold(queue:) # rubocop:disable Lint/UnusedMethodArgument
-      raise "This method must be overriden to be the warning threshold."
-    end
-  end
-end

data/lib/govuk_app_config/govuk_healthcheck/sidekiq_queue_latency_check.rb

@@ -1,13 +0,0 @@
-module GovukHealthcheck
-  class SidekiqQueueLatencyCheck < SidekiqQueueCheck
-    def name
-      :sidekiq_queue_latency
-    end
-
-    def queues
-      @queues ||= Sidekiq::Stats.new.queues.keys.each_with_object({}) do |name, hash|
-        hash[name] = Sidekiq::Queue.new(name).latency
-      end
-    end
-  end
-end

data/lib/govuk_app_config/govuk_healthcheck/sidekiq_retry_size_check.rb

@@ -1,11 +0,0 @@
-module GovukHealthcheck
-  class SidekiqRetrySizeCheck < ThresholdCheck
-    def name
-      :sidekiq_retry_size
-    end
-
-    def value
-      Sidekiq::Stats.new.retry_size
-    end
-  end
-end

data/lib/govuk_app_config/govuk_healthcheck/threshold_check.rb

@@ -1,50 +0,0 @@
-module GovukHealthcheck
-  class ThresholdCheck
-    def status
-      if value >= critical_threshold
-        :critical
-      elsif value >= warning_threshold
-        :warning
-      else
-        :ok
-      end
-    end
-
-    def message
-      if value >= critical_threshold
-        "#{value} is above the critical threshold (#{critical_threshold})"
-      elsif value >= warning_threshold
-        "#{value} is above the warning threshold (#{warning_threshold})"
-      else
-        "#{value} is below the critical and warning thresholds"
-      end
-    end
-
-    def details
-      {
-        value: value,
-        total: total,
-        thresholds: {
-          critical: critical_threshold,
-          warning: warning_threshold,
-        },
-      }
-    end
-
-    def value
-      raise "This method must be overridden to be the check value."
-    end
-
-    def total
-      nil # This method can be overriden to provide the total for the check.
-    end
-
-    def critical_threshold
-      raise "This method must be overriden to be the critical threshold."
-    end
-
-    def warning_threshold
-      raise "This method must be overriden to be the warning threshold."
-    end
-  end
-end