rails_pod_kit 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb47aab3b005492f13eaaa6ede0a89a5891cfbc8d034ebc0f1284b590efbb59a
-  data.tar.gz: 3f0f50b521bb1f96655edcbb296ea00156f90b631239491c49fad381f351989e
+  metadata.gz: 01df88e896cc7b8aac64c01bd55b33be595cea12690fd0b0e47aa4b1289f5d95
+  data.tar.gz: fec8ba424464b8b15c20fe8c87b604fea5b667f42df9908921c13ac42a66e3ba
 SHA512:
-  metadata.gz: 33733cd886176b0341314e9ba6641cb0368f6010e3d24e0b11851d8a18d32119dd183eb8f17a885d8be5f4c5e36d7b123205d5051bf79b90e8f0cc95b434d0ef
-  data.tar.gz: db116a08eb1b3fb3c0d4017a5be0082568e48907032717d35dbb10933f741811b0009c64749937747aa44e45db0dbb73a1647d288f1dca986c6ec8007cc4531e
+  metadata.gz: a2b637351c73a11dcb83f5e4db150ae75bbcf61840af4a4262fd6063fce1a3069912ccea5031ccb84d90513aebf33e193614f5c05703835706a769ca59e675d4
+  data.tar.gz: b8c3b5682c277f6e5b39267454c820e206635c93e8fd74620e43ec673f1367e8c11c8585fcd914814d5e7db7655578352cebec492493eb4cc73e9f483aa59b87

data/README.md

@@ -8,7 +8,7 @@ packaged behind a single, opinionated entry point:
   worker (Sidekiq) processes — no sidecar, no separate collector process. A
   metrics agent (e.g. the Datadog Agent via OpenMetrics autodiscovery) scrapes
   the pod directly.
-- **Health checks** on `/healthz` (database, cache, Redis, optionally Sidekiq),
+- **Health checks** on `/healthz` (database, cache, optionally Redis and Sidekiq),
   wired for Kubernetes startup/liveness/readiness probes — a thin, opinionated
   wrapper around [health-monitor-rails](https://github.com/lbeder/health-monitor-rails).
 
@@ -90,8 +90,10 @@ no initializers.
 
 `Health.install!` configures health-monitor-rails with the kit's defaults:
 endpoint at `/healthz`, checking **database** (health_monitor's default),
-**cache**, **Redis** (connection injected by the host) and — when a `sidekiq:`
-thresholds hash is given — **Sidekiq**. The gem's Railtie mounts
+**cache**, — when a `redis:` connection is given — **Redis** (connection
+injected by the host) and — when a `sidekiq:` thresholds hash is given —
+**Sidekiq**. Omit `redis:` on hosts with no Redis dependency (e.g. a Solid
+Queue stack) to get a database + cache only endpoint. The gem's Railtie mounts
 `HealthMonitor::Engine` at `/` automatically; pass `mount: false` to keep
 route ownership (custom mount point, constraints) and mount it yourself in
 `config/routes.rb`. Any further tuning goes through the optional block, which
@@ -99,7 +101,9 @@ receives the `HealthMonitor` configuration.
 
 ```ruby
 RailsPodKit::Health.install!(
-  redis:   { url: ENV['REDIS_URL'] }, # or a ready Redis/ConnectionPool object
+  redis:   { url: ENV['REDIS_URL'] }, # optional: a ready Redis/ConnectionPool
+                                      # object or options hash; omit for no
+                                      # Redis provider
   path:    :healthz,                  # default
   sidekiq: { queue_size: 200, latency: 10.minutes }
 ) do |config|
@@ -107,6 +111,13 @@ RailsPodKit::Health.install!(
 end
 ```
 
+Without a `redis:` argument the endpoint checks only database and cache
+(plus Sidekiq when its thresholds are given):
+
+```ruby
+RailsPodKit::Health.install!(path: :healthz) # database + cache only
+```
+
 Probe wiring on Kubernetes:
 
 - **startup probe** → `/healthz` — the full check, so the pod doesn't go ready

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/rails_pod_kit/health.rb

@@ -21,7 +21,7 @@ module RailsPodKit
   #   )
   #
   # gives the app a /healthz endpoint checking database (health_monitor's
-  # default), cache, Redis and (optionally) Sidekiq — suitable as a k8s startup
+  # default), cache and (optionally) Redis and Sidekiq — suitable as a k8s startup
   # probe. For liveness/readiness, probe `/healthz?providers[]=none` to
   # short-circuit the dependency checks once the pod is live, so a transient
   # Redis hiccup doesn't restart the app. Same trick for a manual basic check:
@@ -35,8 +35,11 @@ module RailsPodKit
 
     # Configures HealthMonitor with the kit's defaults.
     #
-    # redis:   Redis connection options hash (same shape the host passes to
-    #          Sidekiq) or a ready connection object (Redis / ConnectionPool).
+    # redis:   optional Redis connection options hash (same shape the host
+    #          passes to Sidekiq) or a ready connection object (Redis /
+    #          ConnectionPool); when given the Redis provider is added. Omit
+    #          entirely (or pass nil) on hosts with no Redis dependency to get
+    #          a database + cache only endpoint.
     # path:    mount-relative endpoint path (default :healthz).
     # sidekiq: optional thresholds hash; when given the Sidekiq provider is
     #          added with the provided `queue_size:` / `latency:` overrides
@@ -51,14 +54,17 @@ module RailsPodKit
     #
     # Any further host-specific tuning (extra providers, error callback, …) can
     # be done in the block, which receives the HealthMonitor configuration.
-    def install!(redis:, path: :healthz, sidekiq: nil, silence_controller_log: true, mount: true)
+    def install!(redis: nil, path: :healthz, sidekiq: nil, silence_controller_log: true, mount: true)
       @auto_mount = mount
 
       HealthMonitor.configure do |config|
         config.path = path
         config.cache
-        config.redis.configure do |redis_config|
-          redis_config.connection = build_connection(redis)
+
+        if redis
+          config.redis.configure do |redis_config|
+            redis_config.connection = build_connection(redis)
+          end
         end
 
         if sidekiq

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_pod_kit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Fabio Napoleoni