rails_pod_kit 0.0.3 → 0.2.0

data/lib/rails_pod_kit/supervisor.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'concurrent'
+
+require 'rails_pod_kit/error_reporter'
+
+module RailsPodKit
+  # Keeps a background worker alive on a process that must not lose it.
+  #
+  # Both schedulers the gem hosts (SolidQueue's, and sidekiq-cron's) run on
+  # their own thread inside an always-on process, and both share the same
+  # failure mode: the thread dies, the host process notices nothing, and the
+  # schedule stops silently. This is that supervision, once — a timer that
+  # rebuilds the worker as soon as it stops being alive.
+  #
+  # The three things that genuinely differ between workers are injected: how to
+  # build and start one, how to ask whether it is still alive, and how to wind
+  # it down. Everything else — the immediate first tick, the stop latch that
+  # keeps a shutdown from being undone by a tick already in flight, reporting
+  # instead of dying — is identical and lives here.
+  #
+  # Deliberately free of Rails: the sidekiq-cron scheduler runs in a Rails-free
+  # process, and ErrorReporter degrades to a warning where there is no Rails
+  # error reporter to hand the failure to.
+  class Supervisor
+    DEFAULT_INTERVAL = 30
+
+    attr_reader :subject
+
+    # `start:` is a callable returning the started worker. `alive:` and `stop:`
+    # take either a method name to send to that worker or a callable receiving
+    # it, so the common case stays declarative and a liveness check the worker
+    # does not expose itself is still expressible. `stop:` is optional — a
+    # worker with no teardown is simply dropped.
+    def initialize(source:, start:, alive:, stop: nil, interval: DEFAULT_INTERVAL)
+      @source = source
+      @start = start
+      @alive = alive
+      @stop = stop
+      @interval = interval
+      @stopping = false
+    end
+
+    # Starts the timer, which starts the worker on its first (immediate) tick,
+    # and returns without blocking.
+    def start
+      @stopping = false
+      @timer = ::Concurrent::TimerTask.new(execution_interval: @interval, run_now: true) { supervise }
+      @timer.execute
+      self
+    end
+
+    # Graceful stop: drop the timer first so it cannot resurrect the worker,
+    # then wind the worker down rather than leaving it to be cut off.
+    def stop
+      @stopping = true
+      @timer&.shutdown
+      @timer = nil
+      invoke(@stop, @subject) if @subject && @stop
+      @subject = nil
+    end
+
+    def running?
+      !!@subject && invoke(@alive, @subject)
+    end
+
+    private
+
+    def invoke(hook, worker)
+      hook.is_a?(::Symbol) ? worker.public_send(hook) : hook.call(worker)
+    end
+
+    # Concurrent::TimerTask silently drops a raising block, so report here and
+    # let the next tick retry — a worker that cannot start because its backing
+    # store is down must keep trying.
+    def supervise
+      ensure_running
+    rescue StandardError => e
+      ErrorReporter.report(e, source: @source)
+    end
+
+    # Idempotent: starts the worker on the first tick, and replaces it only once
+    # it has actually stopped being alive.
+    def ensure_running
+      return if @stopping || running?
+
+      @subject = @start.call
+    end
+  end
+end

data/lib/rails_pod_kit.rb

@@ -6,9 +6,10 @@ require 'rails_pod_kit/config'
 # RailsPodKit packages the operational endpoints a Rails pod needs to be a good
 # Kubernetes citizen behind a single, opinionated entry point:
 #
-# - Prometheus metrics: Puma and Sidekiq runtime metrics in Prometheus text
-#   format on an in-process /metrics endpoint (default port 9394) — no sidecar,
-#   no separate collector process. A thin wrapper around the yabeda ecosystem.
+# - Prometheus metrics: Puma, Sidekiq and SolidQueue runtime metrics in
+#   Prometheus text format on an in-process /metrics endpoint (default port
+#   9394) — no sidecar, no separate collector process. A thin wrapper around the
+#   yabeda ecosystem, plus the SolidQueue queue gauges yabeda has no plugin for.
 # - Health checks: an opinionated health-monitor-rails configuration serving
 #   liveness/readiness/startup probes on /healthz (see RailsPodKit::Health),
 #   auto-mounted by the gem's Railtie.
@@ -22,8 +23,9 @@ require 'rails_pod_kit/config'
 #   - config/initializers/sidekiq.rb          -> RailsPodKit::Sidekiq.install!(config)
 #   - config/initializers/rails_pod_kit.rb    -> RailsPodKit.configure { ... }
 #                                                RailsPodKit::Health.install!(redis: ...)
-# plus, only when running the dedicated global exporter, a host-owned
-# entrypoint (e.g. bin/pod-exporter) calling GlobalExporter.run!(redis: ...).
+# plus, only when running a dedicated always-on exporter, a host-owned
+# entrypoint calling GlobalExporter.run!(redis: ...) (Sidekiq, Rails-free) or
+# SolidQueue.run_exporter! (SolidQueue, needs the app's ActiveRecord models).
 #
 # The gem is deliberately connection-agnostic: it never reads REDIS_URL or
 # makes TLS decisions. The host injects its Redis options where needed
@@ -57,5 +59,6 @@ require 'rails_pod_kit/config'
 require 'yabeda/prometheus/mmap'
 
 require 'rails_pod_kit/sidekiq'
+require 'rails_pod_kit/solid_queue'
 require 'rails_pod_kit/health'
 require 'rails_pod_kit/railtie'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_pod_kit
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Fabio Napoleoni
@@ -93,6 +93,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: health-monitor-rails
   requirement: !ruby/object:Gem::Requirement
@@ -123,10 +137,13 @@ dependencies:
         version: '5.0'
 description: |
   Packages the yabeda ecosystem and health-monitor-rails into a single,
-  opinionated kit for running Rails applications on Kubernetes: Puma and
-  Sidekiq runtime metrics in Prometheus text format on an in-process /metrics
-  endpoint (default port 9394), plus a /healthz endpoint wired for
-  liveness/readiness/startup probes. No sidecar, no separate collector.
+  opinionated kit for running Rails applications on Kubernetes: Puma, Sidekiq
+  and SolidQueue runtime metrics in Prometheus text format on an in-process
+  /metrics endpoint (default port 9394), plus a /healthz endpoint wired for
+  liveness/readiness/startup probes. No sidecar, no separate collector. It
+  also hosts the schedulers that let a job executor scale to zero without
+  stranding its recurring jobs: a supervised SolidQueue scheduler thread, and
+  a supervised sidekiq-cron poller for Sidekiq.
 email:
 - f.napoleoni@gmail.com
 executables: []
@@ -138,11 +155,19 @@ files:
 - VERSION
 - lib/rails_pod_kit.rb
 - lib/rails_pod_kit/config.rb
+- lib/rails_pod_kit/error_reporter.rb
+- lib/rails_pod_kit/exporter.rb
 - lib/rails_pod_kit/global_exporter.rb
+- lib/rails_pod_kit/global_scheduler.rb
 - lib/rails_pod_kit/health.rb
 - lib/rails_pod_kit/puma.rb
 - lib/rails_pod_kit/railtie.rb
+- lib/rails_pod_kit/shutdown.rb
 - lib/rails_pod_kit/sidekiq.rb
+- lib/rails_pod_kit/solid_queue.rb
+- lib/rails_pod_kit/solid_queue/metrics.rb
+- lib/rails_pod_kit/solid_queue/scheduler_runner.rb
+- lib/rails_pod_kit/supervisor.rb
 - lib/rails_pod_kit/version.rb
 homepage: https://github.com/fabn/rails_pod_kit
 licenses:
@@ -167,6 +192,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: 'Operational endpoints for Rails pods: Prometheus metrics (Puma + Sidekiq)
-  and health checks'
+summary: 'Operational endpoints for Rails pods: Prometheus metrics (Puma, Sidekiq,
+  SolidQueue) and health checks'
 test_files: []