rails_health_checks 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0f595984abf8a7db84183766d61918bdf684642b6ea67b2075afbda8f4cbae6
-  data.tar.gz: ab35a0deb32d298eae8dadc04c39dbf8ca34b8e77018625ebad8ba81e1901f34
+  metadata.gz: 4e3f62376ecb6e658daaf39738dbb50a5eb6885b765af8766a74f748dafe9ac5
+  data.tar.gz: da0bcf07fdb7636c810e6656b99084d1554fbd3d4012d69560a8bd8474a05232
 SHA512:
-  metadata.gz: 2f2db831794c15dbf59c6763ed65a092e9bc56db1dc87e35d4565cccd63303cfe9555a7b36f738e6a861086c0362f8eb98459e99ea46f5838bfeb3862130ebf5
-  data.tar.gz: 3d5b057c32506961cf0416d37ea45c70f5218767961ddeed208b37887abd7781187fc1f480aff2e5fb522bfad8400e355fa745a04ec876a064e1aeb938e91c78
+  metadata.gz: eccd94c21587daabf39b10f6d98b5be36a632353b698538db2fb8e14be6e0dab9b0f4d175d9f8e896a4cde1faca45824036b4f4618e7bb8303e5e435064584a3
+  data.tar.gz: 92ac0ad412e0cc473cccaa16240bcf78b3a2c4cac017f15651386990009cd32b2bf82866d39d58ccd7fa287de88745f6fb84ee99df472c385a2525277dfefa93

data/README.md

@@ -15,6 +15,9 @@ A Rails engine providing structured, pluggable health check endpoints for monito
 - [Configuration](#configuration)
 - [Authentication](#authentication)
 - [Built-in Checks](#built-in-checks)
+- [Per-Environment Toggling](#per-environment-toggling)
+- [Check Groups](#check-groups)
+- [Custom Checks](#custom-checks)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -139,6 +142,69 @@ The block receives the `ActionDispatch::Request` object and must return a truthy
 
 ---
 
+## Per-Environment Toggling
+
+Disable specific checks in specific environments:
+
+```ruby
+RailsHealthChecks.configure do |config|
+  config.checks = [:database, :cache, :disk, :memory]
+  config.disable :disk,   in: :test
+  config.disable :memory, in: [:test, :development]
+end
+```
+
+The check is removed from the active list only when `Rails.env` matches. The `in:` option accepts a single symbol or an array.
+
+[↑ Back to top](#table-of-contents)
+
+---
+
+## Check Groups
+
+Group related checks and expose them at a dedicated endpoint:
+
+```ruby
+RailsHealthChecks.configure do |config|
+  config.group :system,  [:disk, :memory]
+  config.group :workers, [:sidekiq, :good_job]
+end
+```
+
+| Endpoint | Description |
+|----------|-------------|
+| `GET /health/system` | Runs only `:disk` and `:memory`, same JSON shape as `GET /health` |
+| `GET /health/workers` | Runs only `:sidekiq` and `:good_job` |
+
+Unknown group names return `404 Not Found`.
+
+[↑ Back to top](#table-of-contents)
+
+---
+
+## Custom Checks
+
+Define a class inheriting from `RailsHealthChecks::Check` and register it in your initializer:
+
+```ruby
+class MyApiCheck < RailsHealthChecks::Check
+  def call
+    res = Net::HTTP.get_response(URI("https://api.example.com/status"))
+    res.code == "200" ? pass : fail_with("API returned #{res.code}")
+  end
+end
+
+RailsHealthChecks.configure do |config|
+  config.register :my_api, MyApiCheck.new
+end
+```
+
+`config.register` automatically adds the check to the active checks list. Use `pass`, `warn_with`, and `fail_with` (inherited from `Check`) to set status, and `measure { }` to record latency.
+
+[↑ Back to top](#table-of-contents)
+
+---
+
 ## Contributing
 
 1. Fork the repository

data/app/controllers/rails_health_checks/health_controller.rb

@@ -3,12 +3,12 @@
 module RailsHealthChecks
   class HealthController < ApplicationController
     def show
-      builder = ResponseBuilder.new(run_checks)
+      builder = ResponseBuilder.new(run_checks(RailsHealthChecks.configuration.checks))
       render json: builder.to_json, status: builder.http_status
     end
 
     def live
-      builder = ResponseBuilder.new(run_checks)
+      builder = ResponseBuilder.new(run_checks(RailsHealthChecks.configuration.checks))
       if builder.overall_status == "ok"
         render plain: "OK", status: :ok
       else
@@ -16,11 +16,20 @@ module RailsHealthChecks
       end
     end
 
+    def group
+      group_name = params[:group].to_sym
+      check_names = RailsHealthChecks.configuration.groups[group_name]
+      return render json: { error: "Group '#{group_name}' not found" }, status: :not_found unless check_names
+
+      builder = ResponseBuilder.new(run_checks(check_names))
+      render json: builder.to_json, status: builder.http_status
+    end
+
     private
 
-    def run_checks
+    def run_checks(check_names)
       config = RailsHealthChecks.configuration
-      checks = CheckRegistry.build(config.checks)
+      checks = CheckRegistry.build(check_names)
       CheckRegistry.run(checks, timeout: config.timeout)
     end
   end

data/config/routes.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 RailsHealthChecks::Engine.routes.draw do
-  get "/",     to: "health#show", as: :health
-  get "/live", to: "health#live", as: :health_live
+  get "/",       to: "health#show",  as: :health
+  get "/live",   to: "health#live",  as: :health_live
+  get "/:group", to: "health#group", as: :health_group
 end

data/lib/rails_health_checks/check_registry.rb

@@ -24,11 +24,16 @@ module RailsHealthChecks
     }.freeze
 
     def self.build(check_names)
+      custom = RailsHealthChecks.configuration.custom_checks
       check_names.each_with_object({}) do |name, hash|
-        factory = BUILT_INS.fetch(name) do
-          raise ArgumentError, "Unknown check: #{name}. Available: #{BUILT_INS.keys.join(', ')}"
+        if BUILT_INS.key?(name)
+          hash[name] = BUILT_INS[name].call
+        elsif custom.key?(name)
+          hash[name] = custom[name].dup
+        else
+          available = (BUILT_INS.keys + custom.keys).join(", ")
+          raise ArgumentError, "Unknown check: #{name}. Available: #{available}"
         end
-        hash[name] = factory.call
       end
     end
 

data/lib/rails_health_checks/configuration.rb

@@ -2,10 +2,11 @@
 
 module RailsHealthChecks
   class Configuration
-    attr_accessor :checks, :timeout, :allowed_ips, :token, :sidekiq_queue_size, :solid_queue_job_count, :good_job_latency,
+    attr_writer :checks
+    attr_accessor :timeout, :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
-    attr_reader :authenticate_block
+    attr_reader :authenticate_block, :custom_checks, :groups
 
     def initialize
       @checks = [:database]
@@ -23,10 +24,33 @@ module RailsHealthChecks
       @memory_threshold = nil
       @http_url = nil
       @http_expected_status = 200
+      @custom_checks = {}
+      @groups = {}
+      @disabled_checks = {}
+    end
+
+    def checks
+      disabled = @disabled_checks.filter_map { |name, envs| name if envs.include?(Rails.env.to_s) }
+      @checks - disabled
     end
 
     def authenticate(&block)
       @authenticate_block = block
     end
+
+    def disable(name, **opts)
+      envs = Array(opts.fetch(:in)).map(&:to_s)
+      @disabled_checks[name] ||= []
+      @disabled_checks[name].concat(envs)
+    end
+
+    def group(name, check_names)
+      @groups[name] = check_names
+    end
+
+    def register(name, check)
+      @custom_checks[name] = check
+      @checks << name unless @checks.include?(name)
+    end
   end
 end

data/lib/rails_health_checks/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_health_checks
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Chuck Smith