rails_health_checks 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 010ea2d8734800da5baaaa805b0671ac685f3c5a26a11967ca64f00cfd03500c
-  data.tar.gz: 7f81bbd9940d17d7b67f779da47b6fe42796ab6542080fcf2a790976c9e83be5
+  metadata.gz: cf33a3b43064f931e789b7d28fff6145c206229b14da15d4da208717007f2c44
+  data.tar.gz: 85c221c95529597327d5a830c9dc6f46da3720133cc19b2366be7af3256f0f57
 SHA512:
-  metadata.gz: f6da67674aa9871b760450a01834a09b1bdebcbacbd21c330c60d2a6c98725b331321c3e187e7741269f414b11562b1dcb48ea99ec8d8face847677c678bbdd0
-  data.tar.gz: f5cf9df5e54de04defd67440c8d838f7c7a085f2712351b1e79920975d64d5c957c43d02cf5de3497ef25ae4ee77ac8a6d8e52d32c682fb0158e753d958a683b
+  metadata.gz: 5f460a617a378811cceda76d3993f589424af6b8bca336a00f2e887cdcc540f1bf29a6a0f049dd7a1a19c8944efff566f92e567a70380651983ed95e106abaa3
+  data.tar.gz: ec5f9be2fc4ad1d84582006455cb742c010232b4e65c0f99f8d4782429d48bda9973e0f6f9e9074bc1d799a03b5e856daf650adc8c0b2dda4637242a7844ede9

data/README.md

@@ -57,6 +57,8 @@ mount RailsHealthChecks::Engine => "/health"
 | `GET /health/live` | Plain text | Load balancer liveness probes |
 | `GET /health/metrics` | Prometheus text | Prometheus / OpenMetrics scraping |
 
+`/health` and `/health/live` also respond to `HEAD` requests (useful for lightweight load balancer probes).
+
 HTTP status is `200 OK` when all checks pass, `503 Service Unavailable` otherwise (except `/metrics` which always returns `200`).
 
 ### JSON response shape
@@ -82,11 +84,14 @@ Status values: `ok` | `degraded` | `critical`. Overall status is `critical` if a
 ```ruby
 # config/initializers/rails_health_checks.rb
 RailsHealthChecks.configure do |config|
-  config.checks  = [:database, :cache]  # checks to run (default: [:database])
-  config.timeout = 5            # global timeout per check in seconds (default: 5)
+  config.checks         = [:database, :cache]  # checks to run (default: [:database])
+  config.timeout        = 5                    # global timeout per check in seconds (default: 5)
+  config.cache_duration = 10                   # cache results for N seconds (default: nil, disabled)
 end
 ```
 
+Configuration is validated at boot time. An unknown check name or a missing `http_url` for the `:http` check raises `RailsHealthChecks::ConfigurationError` on startup rather than silently failing on the first request.
+
 [↑ Back to top](#table-of-contents)
 
 ---
@@ -139,7 +144,7 @@ The block receives the `ActionDispatch::Request` object and must return a truthy
 | `:resque` | Resque Redis connectivity; optional `config.resque_queue_size` threshold for total queue depth |
 | `:disk` | Free disk bytes via `df`; optional `config.disk_warn_threshold` / `config.disk_critical_threshold` (bytes) and `config.disk_path` (default: `/`) |
 | `:memory` | Process RSS via `ps`; optional `config.memory_threshold` (bytes) reports `degraded` when exceeded |
-| `:http` | HTTP GET to `config.http_url`; reports `critical` if response code differs from `config.http_expected_status` (default: `200`) or a network error occurs |
+| `:http` | HTTP GET to `config.http_url`; reports `critical` if response code differs from `config.http_expected_status` (default: `200`) or a network error occurs; optional `config.http_headers` hash sends custom request headers (e.g. `{ "Authorization" => "Bearer ..." }`) |
 
 [↑ Back to top](#table-of-contents)
 

data/app/controllers/rails_health_checks/application_controller.rb

@@ -9,6 +9,18 @@ module RailsHealthChecks
 
     def run_checks(check_names)
       config = RailsHealthChecks.configuration
+
+      if config.cache_duration
+        cache_key = check_names.map(&:to_s).sort.join(",")
+        RailsHealthChecks.result_cache.fetch(cache_key, ttl: config.cache_duration) do
+          build_and_run(check_names, config)
+        end
+      else
+        build_and_run(check_names, config)
+      end
+    end
+
+    def build_and_run(check_names, config)
       checks = CheckRegistry.build(check_names)
       CheckRegistry.run(checks, timeout: config.timeout)
     end

data/config/routes.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 RailsHealthChecks::Engine.routes.draw do
-  get "/",        to: "health#show",   as: :health
-  get "/live",    to: "live#show",     as: :health_live
+  match "/",      to: "health#show",   as: :health,      via: [:get, :head]
+  match "/live",  to: "live#show",     as: :health_live, via: [:get, :head]
   get "/metrics", to: "metrics#show",  as: :health_metrics
   get "/:id",     to: "groups#show",   as: :health_group
 end

data/lib/rails_health_checks/check_registry.rb

@@ -15,7 +15,8 @@ module RailsHealthChecks
       memory:      -> { Checks::MemoryCheck.new(threshold: RailsHealthChecks.configuration.memory_threshold) },
       http:        -> { Checks::HttpCheck.new(
         url:             RailsHealthChecks.configuration.http_url,
-        expected_status: RailsHealthChecks.configuration.http_expected_status
+        expected_status: RailsHealthChecks.configuration.http_expected_status,
+        headers:         RailsHealthChecks.configuration.http_headers
       ) },
       disk:        -> { Checks::DiskCheck.new(
         warn_threshold:     RailsHealthChecks.configuration.disk_warn_threshold,

data/lib/rails_health_checks/checks/http_check.rb

@@ -6,14 +6,18 @@ require "uri"
 module RailsHealthChecks
   module Checks
     class HttpCheck < Check
-      def initialize(url:, expected_status: 200)
+      def initialize(url:, expected_status: 200, headers: {})
         @url = url
         @expected_status = expected_status
+        @headers = headers
       end
 
       def call
         measure do
-          response = Net::HTTP.get_response(URI.parse(@url))
+          uri = URI.parse(@url)
+          request = Net::HTTP::Get.new(uri)
+          @headers.each { |name, value| request[name] = value }
+          response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(request) }
           code = response.code.to_i
           return fail_with("HTTP GET #{@url} returned #{code}, expected #{@expected_status}") if code != @expected_status
         end

data/lib/rails_health_checks/configuration.rb

@@ -1,16 +1,22 @@
 # frozen_string_literal: true
 
 module RailsHealthChecks
+  class ConfigurationError < StandardError; end
+
   class Configuration
+    BUILT_IN_NAMES = %i[database cache sidekiq solid_queue good_job resque disk memory http].freeze
+
     attr_writer :checks
-    attr_accessor :timeout, :allowed_ips, :token, :sidekiq_queue_size, :solid_queue_job_count, :good_job_latency,
+    attr_accessor :timeout, :cache_duration, :allowed_ips, :token,
+                  :sidekiq_queue_size, :solid_queue_job_count, :good_job_latency,
                   :resque_queue_size, :disk_warn_threshold, :disk_critical_threshold, :disk_path,
-                  :memory_threshold, :http_url, :http_expected_status
+                  :memory_threshold, :http_url, :http_expected_status, :http_headers
     attr_reader :authenticate_block, :custom_checks, :groups
 
     def initialize
       @checks = [:database]
       @timeout = 5
+      @cache_duration = nil
       @allowed_ips = nil
       @token = nil
       @authenticate_block = nil
@@ -24,6 +30,7 @@ module RailsHealthChecks
       @memory_threshold = nil
       @http_url = nil
       @http_expected_status = 200
+      @http_headers = {}
       @custom_checks = {}
       @groups = {}
       @disabled_checks = {}
@@ -53,5 +60,18 @@ module RailsHealthChecks
       @custom_checks[name] = check
       @checks << name unless @checks.include?(name)
     end
+
+    def validate!
+      all_checks = @checks + @groups.values.flatten
+      all_checks.uniq.each do |name|
+        next if BUILT_IN_NAMES.include?(name) || @custom_checks.key?(name)
+
+        raise ConfigurationError, "Unknown check :#{name}. Built-ins: #{BUILT_IN_NAMES.join(', ')}"
+      end
+
+      if @checks.include?(:http) && @http_url.nil?
+        raise ConfigurationError, "config.checks includes :http but config.http_url is not set"
+      end
+    end
   end
 end

data/lib/rails_health_checks/engine.rb

@@ -4,5 +4,9 @@ module RailsHealthChecks
   class Engine < ::Rails::Engine
     isolate_namespace RailsHealthChecks
     config.generators.api_only = true
+
+    config.after_initialize do
+      RailsHealthChecks.configuration.validate!
+    end
   end
 end

data/lib/rails_health_checks/result_cache.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RailsHealthChecks
+  class ResultCache
+    def initialize
+      @store = {}
+      @mutex = Mutex.new
+    end
+
+    def fetch(key, ttl:)
+      @mutex.synchronize do
+        entry = @store[key]
+        return entry[:results] if entry && (Process.clock_gettime(Process::CLOCK_MONOTONIC) - entry[:at]) < ttl
+
+        results = yield
+        @store[key] = { results: results, at: Process.clock_gettime(Process::CLOCK_MONOTONIC) }
+        results
+      end
+    end
+
+    def clear
+      @mutex.synchronize { @store.clear }
+    end
+  end
+end

data/lib/rails_health_checks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsHealthChecks
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/rails_health_checks.rb

@@ -17,6 +17,7 @@ require "rails_health_checks/checks/http_check"
 require "rails_health_checks/check_registry"
 require "rails_health_checks/response_builder"
 require "rails_health_checks/prometheus_formatter"
+require "rails_health_checks/result_cache"
 
 module RailsHealthChecks
   class << self
@@ -27,5 +28,9 @@ module RailsHealthChecks
     def configuration
       @configuration ||= Configuration.new
     end
+
+    def result_cache
+      @result_cache ||= ResultCache.new
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_health_checks
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -60,6 +60,7 @@ files:
 - lib/rails_health_checks/engine.rb
 - lib/rails_health_checks/prometheus_formatter.rb
 - lib/rails_health_checks/response_builder.rb
+- lib/rails_health_checks/result_cache.rb
 - lib/rails_health_checks/version.rb
 - lib/tasks/rails_health_checks_tasks.rake
 homepage: https://github.com/eclectic-coding/rails_health_checks