pgbus 0.9.11 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +2 -0
- data/lib/pgbus/client.rb +63 -5
- data/lib/pgbus/configuration.rb +74 -2
- data/lib/pgbus/doctor.rb +26 -2
- data/lib/pgbus/process/notify_listener.rb +18 -2
- data/lib/pgbus/process/worker.rb +10 -3
- data/lib/pgbus/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d927ac10d70c354f2624eb9495c0e21d6913a3f6a074e94705e32ac69a5f51db
|
|
4
|
+
data.tar.gz: 36c12b3e6cb620f9443bde0a3cdc0137072076ee38e40381d5a3cc3960504596
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c1381157be5c95baab7d9fa9097d18d212c74a3262887ddb31629c54c2cab42c0ca8d699f7da6565a8649fd41d5f4eda63b5b77660cd28cfb8a4516eb04d852d
|
|
7
|
+
data.tar.gz: c36c9c2012f2ccf315e3102bbfc61cbddf3462134782687670bcdebf72f7bae7d639b2b0824b2fd1339ef9836d0b68e7a106169148d324a486652c1770e14665
|
data/CHANGELOG.md
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
|
|
8
8
|
### Added
|
|
9
9
|
|
|
10
|
+
- **Connection-pooler safety (`config.require_primary`, `config.connection_guc_mode`) — pgbus is now correct-and-loud behind a transaction/read-write-splitting pooler instead of silently stalling (issue #332).** Three linked fixes. (1) **Primary affinity:** a read/write-splitting pooler (pgdog/pgcat) can route pgmq's VOLATILE `read`/`archive`/`delete` to a read replica, where workers read nothing (`read_ct=0`) and jobs stop with a **healthy heartbeat** — the supervisor watchdog keys on loop advancement, not read progress, so nothing surfaced the stall. The job read path had zero primary-affinity defense (only the LISTEN/streamer paths validated the primary via `PrimaryValidator`). Setting `config.require_primary = true` (default **false** — a single-primary deployment is byte-identical) makes `verify_connection!` reject a connection that lands on a replica (`pg_is_in_recovery() => t`) at supervisor boot, raising a clear `ConfigurationError` instead of forking children that read nothing. (2) **GUC forwarding:** pgbus's AR-config extraction dropped database.yml's `variables:` block, so `client_min_messages` (and any GUC) never reached pgmq's dedicated raw connections (NOTICE flooding that three consuming apps hand-patched via `connection_params`). GUCs are now forwarded, on both the AR-extracted and explicit-`connection_params` paths, by `config.connection_guc_mode`: `:options` (default) bakes them into the libpq `options` STARTUP param (byte-compatible with today for the read-timeout `statement_timeout`, now also carrying `variables:`), while `:session` applies them via post-connect `SET` on a fresh connection instead — for a transaction-mode PgBouncer that **rejects** the `options` startup param with a FATAL. `pgbus doctor` gains a ninth check ("Primary affinity") that warns (never fails) when the job connection is currently on a replica, naming the direct-port remediation. DB-gated integration tests prove both GUC modes round-trip a forwarded GUC and that `require_primary` verifies on a real primary. Refs #332.
|
|
10
11
|
- **Job-burst tuning guidance + gate benchmark (`rake bench:job_burst`), and a decision NOT to autoscale the job pool (issue #323 phase 3).** Following the issue's measure-first mandate, `benchmarks/job_burst_bench.rb` sweeps worker thread count under a job burst in two connection regimes (pool matched to threads vs. pool fixed small). Measured finding: a job holds a pgmq connection only for the `read_batch` + `archive` round-trip (not the job body), so **the DB connection pool is the hard burst ceiling, not the thread count** — in the fixed-pool regime `peak_busy` never exceeds `pool_size` no matter how many threads run (extra threads just queue on checkout, latency climbs, throughput plateaus), while matching the pool to the thread count scales throughput ~linearly (≈8× from 2→16). The conclusion — issue #323's explicitly sanctioned outcome — is that **elastic job threads on a fixed connection pool cannot help**, so pgbus does *not* autoscale the job execution pool; the fix for job bursts is **static headroom**: raise `threads` (and let `pool_size` follow, or keep it ≥ `threads`). Documented in the Performance & tuning docs. The streams-pool autoscaling below stays the elastic story where it *does* pay off (the streams pool's connection cost genuinely scales with its size). Refs #323.
|
|
11
12
|
- **Fan-out writer throughput gate benchmark (`writer_burst_bench.rb`), and a decision NOT to make the writer pool elastic (issue #323 phase 1).** Following the issue's measure-first mandate, `benchmarks/writer_burst_bench.rb` drives a sustained fan-out burst (a fleet of connections × many wakes) through the `OutboundPump` while sweeping `streams_writer_threads`, across fast/typical socket-write profiles. Measured finding: throughput scales ~linearly with writer count (≈6× from 2→16) — but that is generic parallelism (N workers finish N independent blocking writes ~N× faster), which argues for the **existing static `streams_writer_threads` knob**, not for elastic writers: a fixed-N sweep can't demonstrate the *spikiness* that would make a static count wasteful enough to justify dynamic resize, and the genuinely harmful case (a slow/congested client) is already **shed** by the #320/#322 fan-out deadline + mark-dead path rather than absorbed by scaling writers. Given the elastic-writer rewrite is the issue's highest-risk phase (it would touch the ordering/cursor invariant #321's whole review exists to protect — mis-sizing risks out-of-order SSE frames), the conclusion — issue #323's sanctioned outcome — is that pgbus does **not** autoscale the writer pool; the fan-out-throughput knob is **static `streams_writer_threads`, sized for your peak fan-out fleet**. Documented in the Performance & tuning docs. Refs #323.
|
|
12
13
|
- **Self-tuning elastic streams-pool autoscaling (`config.streams_pool_autoscale`, opt-in, default off).** The dedicated streams pool (durable-broadcast publish + dispatcher replay reads) is a fixed `streams_pool_size` (default 5); under a genuine burst of SSE clients it saturates, and a saturated pool *serialises* replay reads (it doesn't error — the checkout waits; see #324), slowing fan-out. Setting `config.streams_pool_autoscale = true` runs a **periodic maintenance check** (default every 5 minutes, `config.streams_pool_autoscale_interval`) that **grows the streams pool into a fair share of live Postgres connection headroom** while it's saturated and **shrinks it back to `streams_pool_size`** when the burst passes — with no connection-count target to tune: every threshold derives from live `max_connections`. The check adds **no extra connection and no extra thread** — it's a lightweight `pg_stat_activity` query that runs on the streamer's *existing idle LISTEN connection* (a pghero-`capture_query_stats`-style periodic task, run on the listener thread in its health-check window). It counts peer stream processes by a per-process `application_name` tag (`config.streams_application_name`, default `"pgbus_streams"`), and each process grows only into its own fair share of free connections (`free / peers`, claiming ¼, bounded by a per-grow step and half the remaining headroom) so N forked processes provably can't collectively exhaust the database — even in a synchronized cold-boot herd. If the database runs *critically* low on free connections, every process **emergency-shrinks to baseline immediately**, overriding the saturation signal (protecting the DB wins). `config.streams_pool_max` is an **optional** hard per-process ceiling (`nil` = the dynamic fair share is the cap). No per-sample hysteresis or cooldown is needed — the slow cadence is itself the debounce: one grow (or shrink) step per check, and a sustained burst converges over a few checks. Built on the #325 hot-swap primitive; the decision object is a pure function (no thread, no connection), DB-free unit-tested (scripted headroom, incl. convergence-across-checks and emergency-shrink), with a DB-gated integration test proving real grow/shrink/emergency and a `rake bench:pool_autoscale` benchmark (check cost ~0.3 ms; grow-under-saturation `3→7→10`). **Two prerequisite fixes ship with it:** streams-pool connections are now tagged with a per-process `application_name`, and the streams pool is now built from `streams_connection_options` (honoring `streams_database_url`/host/port) rather than the job-database options — the latter a latent wrong-DB bug in the existing streams pool that only surfaced with a separate streams database. Default-off = byte-identical (the Listener runs no maintenance). A pure-*publisher* worker process (no streamer, only `send_stream_message`) autoscales too: each publish opportunistically triggers the same check, throttled to at most once per `streams_pool_autoscale_interval` across all publisher threads (a lock-free compare-and-set claims the window). The publish thread does only that CAS and then hands the work to a background single-worker executor — it never runs the `pg_stat_activity` query or the resize inline (off the hot path), and a quiet process spawns no thread. The query runs through the *job* pool (so it never competes with the streams pool it grows), and the publisher decision is **grow-only**: it grows under its own publish pressure and emergency-shrinks on DB exhaustion, but leaves normal idle shrink to the streamer/consumer that sees the sustained-idle picture. Fail-soft throughout, so a broadcast never fails on a telemetry query. For steady load, a larger static `streams_pool_size` remains the simpler choice — autoscaling earns its keep under genuinely bursty streams traffic. `PoolAutoscaler` lives in `Pgbus::Streams::` (it is a streams-pool controller, not web-specific). Refs #323.
|
|
@@ -26,6 +27,7 @@
|
|
|
26
27
|
|
|
27
28
|
### Fixed
|
|
28
29
|
|
|
30
|
+
- **A pooler-deaf NOTIFY listener no longer raises the worker poll floor to 15s — worse latency than a plain no-NOTIFY deployment (issue #332).** pgbus already detects a transaction-mode pooler / replica LISTEN connection with a self-NOTIFY probe (`NotifyProbe`) and logs a loud, actionable error, but the probe's boolean result was **discarded**: a live-but-deaf listener still reported `running? == true`, so `Worker#wake_timeout` treated it as a healthy NOTIFY source and raised the empty-fetch poll floor to `NOTIFY_FALLBACK_POLL_SECONDS` (15s) — behind a pooler the loop would then sleep up to 15s between polls while jobs sat ready. `NotifyListener` now records the probe result and exposes `delivering?`; `wake_timeout` treats a non-delivering listener as absent and keeps polling at the fast `polling_interval` until a direct-port connection is configured. The streamer path needed no change — its listener already waits on the short `streams_listen_health_check_ms` and has no equivalent 15s ceiling. Refs #332.
|
|
29
31
|
- **The dispatcher no longer logs a scary `Concurrency cleanup failed: ... terminating connection due to administrator command` WARN when an idle DB connection is killed between maintenance cycles.** The dispatcher is a long-lived loop that queries the DB on coarse intervals (concurrency cleanup every 300s, most tasks hourly) and, until now, kept its pooled ActiveRecord connection leased across the idle sleep. When the server terminated that idle backend — routine in **local development** (a Postgres restart, `rails db:migrate` calling `pg_terminate_backend` on idle backends, foreman/overmind restarting the DB) — the next cycle reused the dead socket and *every* maintenance task raised `PG::ConnectionBad` with PostgreSQL's `terminating connection due to administrator command` text, surfaced as an alarming WARN even though the process was healthy and self-heals on the next tick. Two changes: (1) `run_maintenance` now returns every leased AR connection to the pool after each cycle (`clear_active_connections!`, mirroring the Streamer's existing `release_ar_connections`), so an idle backend is never reused — the next cycle checks out afresh and AR's `verify!`-on-checkout transparently discards a dead socket and reconnects; (2) every maintenance task's failure log now routes through `log_maintenance_failure`, which recognizes the terminated-idle-connection signal and logs a calm INFO ("reconnecting on the next cycle") instead of a WARN. Non-connection failures still WARN unchanged, and maintenance backoff is unaffected (a self-healing cycle resets the failure streak on the next successful reconnect).
|
|
30
32
|
- **`priority_levels > 1` no longer silently breaks durable streams.** With job priority enabled, `QueueFactory.for` selects `PriorityStrategy`, and `Client#send_message` routes *every* send — including durable stream broadcasts (which pass no `priority:`) — to a `_p<default_priority>` sub-queue. But the streamer LISTENs and replays exclusively on the **bare** `pgmq.q_<stream>` queue (`read_after`, `notify_stream`), so the broadcast never reached the browser; on a fresh DB, `ensure_stream_queue` also raised `PG::UndefinedTable` because `ensure_queue` created only `_p0.._pN`, never the bare table the NOTIFY trigger and archive index attach to. Durable broadcasts now go through a dedicated `Client#send_stream_message` that always targets the bare queue, and `ensure_stream_queue` creates the bare queue directly via `ensure_single_queue` — both independent of the priority strategy, mirroring the bare-name read path. Streams are delivered by a non-consuming peek; priority sub-queues are meaningless for them. Ephemeral broadcasts (the default mode) were never affected. Refs #310.
|
|
31
33
|
- **Stream maintenance and wildcard workers now correctly identify stream queues (finishes the #306/#307 orphan-sweep fix and closes a durable-stream data-loss bug).** `streams_queue_prefix` (default `pgbus_stream`) was consulted only by the dispatcher's `prune_stream_archives` and `sweep_orphan_streams`, but no code ever *named* a queue with it — real stream queues are `#{queue_prefix}_<name>` (`pgbus_<name>`). So both filters matched **zero** real stream queues: per-stream retention never ran, and the age-based orphan drop shipped in #307 was inert. Worse, a *job* queue whose logical name started with `stream_` (physical `pgbus_stream_x`) *did* match and could be dropped. All stream detection now goes through the new `pgbus_stream_queues` registry (see Added): `prune_stream_archives` and `sweep_orphan_streams` iterate registered streams (reviving #306/#307), `compact_archives` skips registered streams so each stream archive is compacted by exactly one path at its per-stream retention (not the 7-day job default), and — closing #309 — a `queues: ['*']` worker's `resolve_wildcard_queues` now excludes registered stream queues, so wildcard workers no longer claim durable broadcasts, fail to deserialize them, and DLQ-move them out of the stream's replay history. `streams_queue_prefix` is retained for backward compatibility but is now inert (documented). Refs #308, #309.
|
data/lib/pgbus/client.rb
CHANGED
|
@@ -79,7 +79,7 @@ module Pgbus
|
|
|
79
79
|
# Both raise clean PG errors — no Ruby Timeout, no Thread#raise. Only
|
|
80
80
|
# safe on this dedicated-connection branch — never on the shared-AR Proc
|
|
81
81
|
# path, where statement_timeout would leak into application queries.
|
|
82
|
-
conn_opts = apply_connection_bounds(conn_opts)
|
|
82
|
+
conn_opts = wrap_session_gucs(apply_connection_bounds(conn_opts))
|
|
83
83
|
@pgmq = PGMQ::Client.new(conn_opts, pool_size: config.resolved_pool_size, pool_timeout: config.pool_timeout)
|
|
84
84
|
@pgmq_mutex = nil
|
|
85
85
|
# Dedicated streams pool (issue #315): isolates the durable-stream
|
|
@@ -95,8 +95,10 @@ module Pgbus
|
|
|
95
95
|
# with a per-process application_name so the autoscaler can count peer
|
|
96
96
|
# processes from pg_stat_activity (issue #323 P1/P2). Snapshot it so a
|
|
97
97
|
# hot-swap rebuilds a byte-identical pool at a new size.
|
|
98
|
-
@streams_conn_opts =
|
|
99
|
-
|
|
98
|
+
@streams_conn_opts = wrap_session_gucs(
|
|
99
|
+
tag_application_name(
|
|
100
|
+
apply_connection_bounds(config.streams_connection_options)
|
|
101
|
+
)
|
|
100
102
|
)
|
|
101
103
|
@streams_pgmq = PGMQ::Client.new(@streams_conn_opts, pool_size: config.streams_pool_size,
|
|
102
104
|
pool_timeout: config.streams_pool_timeout)
|
|
@@ -163,9 +165,22 @@ module Pgbus
|
|
|
163
165
|
# carries the underlying error plus which config source was in use.
|
|
164
166
|
def verify_connection!
|
|
165
167
|
synchronized do
|
|
166
|
-
@pgmq.with_connection
|
|
168
|
+
@pgmq.with_connection do |conn|
|
|
169
|
+
conn.exec("SELECT 1")
|
|
170
|
+
# When require_primary is set, reject a connection that landed on a
|
|
171
|
+
# read-only replica at boot rather than letting a read/write-splitting
|
|
172
|
+
# pooler silently route pgmq's VOLATILE read/archive to a standby,
|
|
173
|
+
# where workers read nothing and jobs stop with a healthy heartbeat
|
|
174
|
+
# (issue #332). Off by default, so a single-primary deployment is
|
|
175
|
+
# unaffected.
|
|
176
|
+
Process::PrimaryValidator.validate_primary!(conn) if config.require_primary
|
|
177
|
+
end
|
|
167
178
|
end
|
|
168
179
|
true
|
|
180
|
+
rescue Process::ReplicaConnectionError => e
|
|
181
|
+
raise ConfigurationError,
|
|
182
|
+
"Database connection via #{connection_source} landed on a read-only replica " \
|
|
183
|
+
"(require_primary is set): #{e.message}"
|
|
169
184
|
rescue PGMQ::Errors::ConnectionError, PG::Error => e
|
|
170
185
|
raise ConfigurationError, "Database connection failed via #{connection_source}: #{e.message}"
|
|
171
186
|
end
|
|
@@ -182,6 +197,17 @@ module Pgbus
|
|
|
182
197
|
true
|
|
183
198
|
end
|
|
184
199
|
|
|
200
|
+
# Whether the job connection currently lands on a read-only replica
|
|
201
|
+
# (pg_is_in_recovery() => t). Used by the doctor to warn about a
|
|
202
|
+
# read/write-splitting pooler that could route pgmq's VOLATILE read/archive
|
|
203
|
+
# to a standby, silently stalling job processing (issue #332). Raw PG error
|
|
204
|
+
# propagates so the caller can render the reason.
|
|
205
|
+
def in_recovery?
|
|
206
|
+
with_raw_connection do |conn|
|
|
207
|
+
conn.exec(Process::PrimaryValidator::RECOVERY_QUERY).getvalue(0, 0) == "t"
|
|
208
|
+
end
|
|
209
|
+
end
|
|
210
|
+
|
|
185
211
|
# The logical queue names pgbus expects to exist based on the configuration
|
|
186
212
|
# (default queue + worker capsules + recurring tasks). Public wrapper around
|
|
187
213
|
# collect_configured_queues so the doctor can diff configured-vs-existing
|
|
@@ -890,7 +916,14 @@ module Pgbus
|
|
|
890
916
|
PG.connect(opts)
|
|
891
917
|
when Hash
|
|
892
918
|
owned = true
|
|
893
|
-
|
|
919
|
+
# :variables is a database.yml convention, not a libpq keyword —
|
|
920
|
+
# strip it before PG.connect and apply the GUCs via SET so this
|
|
921
|
+
# raw bootstrap/DDL connection matches the pooled connections
|
|
922
|
+
# (issue #332). Empty/absent variables is a plain connect.
|
|
923
|
+
variables = opts[:variables]
|
|
924
|
+
conn = PG.connect(**opts.except(:variables))
|
|
925
|
+
variables&.each { |name, value| conn.exec("SET #{name} = '#{value}'") }
|
|
926
|
+
conn
|
|
894
927
|
else
|
|
895
928
|
raise ConfigurationError, "Cannot resolve raw PG connection from #{opts.class}"
|
|
896
929
|
end
|
|
@@ -1299,6 +1332,31 @@ module Pgbus
|
|
|
1299
1332
|
end
|
|
1300
1333
|
end
|
|
1301
1334
|
|
|
1335
|
+
# In :session GUC mode, a Hash conn_opts carrying database.yml `:variables`
|
|
1336
|
+
# must apply those GUCs via post-connect `SET` rather than the libpq
|
|
1337
|
+
# `options` STARTUP param (which a transaction-mode PgBouncer rejects). We
|
|
1338
|
+
# can't pass `:variables` to PG.connect (not a libpq keyword), so wrap the
|
|
1339
|
+
# opts in a fresh-connect factory Proc: pgmq-ruby natively accepts a callable
|
|
1340
|
+
# per pool slot (pgmq connection.rb), and it must return a UNIQUE
|
|
1341
|
+
# PG::Connection each call (pgmq guards against a shared object). Applies to
|
|
1342
|
+
# a Hash with `:variables` only — a String URL or no variables passes through
|
|
1343
|
+
# unchanged, as does :options mode (where forward_connection_variables
|
|
1344
|
+
# already baked the GUCs into `options`). See issue #332.
|
|
1345
|
+
def wrap_session_gucs(conn_opts)
|
|
1346
|
+
return conn_opts unless config.connection_guc_mode == :session
|
|
1347
|
+
return conn_opts unless conn_opts.is_a?(Hash)
|
|
1348
|
+
|
|
1349
|
+
variables = conn_opts[:variables]
|
|
1350
|
+
return conn_opts if variables.nil? || variables.empty?
|
|
1351
|
+
|
|
1352
|
+
pg_opts = conn_opts.except(:variables)
|
|
1353
|
+
lambda do
|
|
1354
|
+
conn = PG.connect(pg_opts)
|
|
1355
|
+
variables.each { |name, value| conn.exec("SET #{name} = '#{value}'") }
|
|
1356
|
+
conn
|
|
1357
|
+
end
|
|
1358
|
+
end
|
|
1359
|
+
|
|
1302
1360
|
def apply_connection_bounds(conn_opts)
|
|
1303
1361
|
timeout = config.read_timeout
|
|
1304
1362
|
return conn_opts unless timeout&.positive?
|
data/lib/pgbus/configuration.rb
CHANGED
|
@@ -102,6 +102,27 @@ module Pgbus
|
|
|
102
102
|
# Requires a matching entry in config/database.yml under the "pgbus" key.
|
|
103
103
|
attr_accessor :connects_to
|
|
104
104
|
|
|
105
|
+
# Reject a job-pool connection that landed on a read-only replica
|
|
106
|
+
# (pg_is_in_recovery() => t). Default false — a correctly-configured
|
|
107
|
+
# single-primary deployment sees no change. Set true when a read/write
|
|
108
|
+
# splitting pooler (pgdog/pgcat) could route pgmq's VOLATILE read/archive
|
|
109
|
+
# to a replica, which otherwise makes workers silently read nothing.
|
|
110
|
+
# See issue #332.
|
|
111
|
+
attr_accessor :require_primary
|
|
112
|
+
|
|
113
|
+
# How pgbus forwards database.yml GUCs (`variables:` such as
|
|
114
|
+
# client_min_messages, and the read-timeout statement_timeout) onto its
|
|
115
|
+
# dedicated pgmq connections:
|
|
116
|
+
# :options (default) — bake them into the libpq `options` STARTUP param
|
|
117
|
+
# (-c key=value). Works everywhere EXCEPT a
|
|
118
|
+
# transaction-mode PgBouncer, which rejects the
|
|
119
|
+
# `options` startup param with a FATAL.
|
|
120
|
+
# :session — apply them via post-connect `SET` statements on a
|
|
121
|
+
# fresh connection instead, so a transaction-mode
|
|
122
|
+
# pooler accepts them. Dedicated-connection path only.
|
|
123
|
+
# See issue #332.
|
|
124
|
+
attr_reader :connection_guc_mode
|
|
125
|
+
|
|
105
126
|
# Zombie message detection — logs a warning when a message is redelivered
|
|
106
127
|
# (read_ct > 1) without any prior failure recorded in pgbus_failed_events.
|
|
107
128
|
attr_accessor :zombie_detection
|
|
@@ -248,6 +269,8 @@ module Pgbus
|
|
|
248
269
|
@stats_flush_interval = StatBuffer::DEFAULT_FLUSH_INTERVAL
|
|
249
270
|
|
|
250
271
|
@connects_to = nil
|
|
272
|
+
@require_primary = false
|
|
273
|
+
@connection_guc_mode = :options
|
|
251
274
|
|
|
252
275
|
@web_auth = nil
|
|
253
276
|
@web_refresh_interval = 5000
|
|
@@ -510,6 +533,18 @@ module Pgbus
|
|
|
510
533
|
@group_mode = coerced
|
|
511
534
|
end
|
|
512
535
|
|
|
536
|
+
VALID_CONNECTION_GUC_MODES = %i[options session].freeze
|
|
537
|
+
|
|
538
|
+
def connection_guc_mode=(mode)
|
|
539
|
+
mode = mode.to_sym
|
|
540
|
+
unless VALID_CONNECTION_GUC_MODES.include?(mode)
|
|
541
|
+
raise Pgbus::ConfigurationError,
|
|
542
|
+
"Invalid connection_guc_mode: #{mode}. Must be one of: #{VALID_CONNECTION_GUC_MODES.join(", ")}"
|
|
543
|
+
end
|
|
544
|
+
|
|
545
|
+
@connection_guc_mode = mode
|
|
546
|
+
end
|
|
547
|
+
|
|
513
548
|
VALID_PGMQ_SCHEMA_MODES = %i[auto extension embedded].freeze
|
|
514
549
|
|
|
515
550
|
def pgmq_schema_mode=(mode)
|
|
@@ -594,6 +629,8 @@ module Pgbus
|
|
|
594
629
|
raise Pgbus::ConfigurationError, "insights_default_minutes must be a positive integer"
|
|
595
630
|
end
|
|
596
631
|
|
|
632
|
+
raise Pgbus::ConfigurationError, "require_primary must be true or false" unless [true, false].include?(require_primary)
|
|
633
|
+
|
|
597
634
|
validate_streams!
|
|
598
635
|
validate_metrics_backend!
|
|
599
636
|
|
|
@@ -1039,7 +1076,17 @@ module Pgbus
|
|
|
1039
1076
|
if database_url
|
|
1040
1077
|
database_url
|
|
1041
1078
|
elsif connection_params
|
|
1042
|
-
connection_params
|
|
1079
|
+
# An explicit connection_params Hash may carry a database.yml-style
|
|
1080
|
+
# `:variables` block; forward it the same way the AR-extracted path does
|
|
1081
|
+
# so client_min_messages etc. actually reach pgmq's connections and a
|
|
1082
|
+
# non-libpq :variables key never reaches PG.connect (issue #332). A
|
|
1083
|
+
# non-Hash connection_params (e.g. a Proc returning a raw connection)
|
|
1084
|
+
# passes through untouched.
|
|
1085
|
+
if connection_params.is_a?(Hash)
|
|
1086
|
+
forward_connection_variables(connection_params.except(:variables), connection_params[:variables])
|
|
1087
|
+
else
|
|
1088
|
+
connection_params
|
|
1089
|
+
end
|
|
1043
1090
|
elsif defined?(ActiveRecord::Base)
|
|
1044
1091
|
# Extract connection config from ActiveRecord so pgmq-ruby creates its
|
|
1045
1092
|
# own dedicated PG connections. Sharing AR's raw_connection via a Proc
|
|
@@ -1326,13 +1373,15 @@ module Pgbus
|
|
|
1326
1373
|
# Rails 7.1+ db_config.configuration_hash returns the full config
|
|
1327
1374
|
config_hash = db_config.configuration_hash
|
|
1328
1375
|
|
|
1329
|
-
{
|
|
1376
|
+
base = {
|
|
1330
1377
|
host: config_hash[:host] || "localhost",
|
|
1331
1378
|
port: (config_hash[:port] || 5432).to_i,
|
|
1332
1379
|
dbname: config_hash[:database],
|
|
1333
1380
|
user: config_hash[:username],
|
|
1334
1381
|
password: config_hash[:password]
|
|
1335
1382
|
}.compact
|
|
1383
|
+
|
|
1384
|
+
forward_connection_variables(base, config_hash[:variables])
|
|
1336
1385
|
rescue StandardError => e
|
|
1337
1386
|
# Fallback to Proc path if AR config extraction fails (e.g., adapter
|
|
1338
1387
|
# doesn't expose standard config keys). Log a warning since this path
|
|
@@ -1348,5 +1397,28 @@ module Pgbus
|
|
|
1348
1397
|
-> { ActiveRecord::Base.connection.raw_connection }
|
|
1349
1398
|
end
|
|
1350
1399
|
end
|
|
1400
|
+
|
|
1401
|
+
# database.yml's `variables:` block (e.g. client_min_messages) is a Rails
|
|
1402
|
+
# convention, not a libpq keyword — pgmq-ruby passes the hash straight to
|
|
1403
|
+
# PG.connect, which would ignore/reject a `:variables` key. So carry the GUCs
|
|
1404
|
+
# forward by the mechanism the operator's pooler tolerates:
|
|
1405
|
+
# :options — bake them into the libpq `options` STARTUP param
|
|
1406
|
+
# (-c key=value), appended to any existing options. A
|
|
1407
|
+
# transaction-mode PgBouncer rejects this param.
|
|
1408
|
+
# :session — leave the raw `:variables` hash on the returned options so the
|
|
1409
|
+
# Client applies them via post-connect `SET` (pooler-safe).
|
|
1410
|
+
# Empty/absent variables is a no-op on both paths. See issue #332.
|
|
1411
|
+
def forward_connection_variables(base, variables)
|
|
1412
|
+
return base if variables.nil? || variables.empty?
|
|
1413
|
+
|
|
1414
|
+
case connection_guc_mode
|
|
1415
|
+
when :session
|
|
1416
|
+
base.merge(variables: variables)
|
|
1417
|
+
else
|
|
1418
|
+
gucs = variables.map { |k, v| "-c #{k}=#{v}" }.join(" ")
|
|
1419
|
+
options = [base[:options], gucs].compact.reject(&:empty?).join(" ")
|
|
1420
|
+
base.merge(options: options)
|
|
1421
|
+
end
|
|
1422
|
+
end
|
|
1351
1423
|
end
|
|
1352
1424
|
end
|
data/lib/pgbus/doctor.rb
CHANGED
|
@@ -5,7 +5,7 @@ require "pgbus/mcp/health_analyzer"
|
|
|
5
5
|
|
|
6
6
|
module Pgbus
|
|
7
7
|
# Preflight diagnostics for a pgbus deployment — the single command that
|
|
8
|
-
# answers "is this environment healthy enough to run?". Runs
|
|
8
|
+
# answers "is this environment healthy enough to run?". Runs nine checks and
|
|
9
9
|
# returns a machine-readable result plus a human report, so `pgbus doctor`
|
|
10
10
|
# and `rake pgbus:doctor` can gate a deploy or CI run (exit 0 on success,
|
|
11
11
|
# 1 on any failure).
|
|
@@ -42,7 +42,8 @@ module Pgbus
|
|
|
42
42
|
check_notify,
|
|
43
43
|
check_processes,
|
|
44
44
|
check_allowed_global_id_models,
|
|
45
|
-
check_broadcast_queue
|
|
45
|
+
check_broadcast_queue,
|
|
46
|
+
check_primary
|
|
46
47
|
].map(&:to_h)
|
|
47
48
|
end
|
|
48
49
|
|
|
@@ -248,6 +249,29 @@ module Pgbus
|
|
|
248
249
|
Check.new(name: "Broadcast queue", status: :fail, detail: "#{e.class}: #{e.message}")
|
|
249
250
|
end
|
|
250
251
|
|
|
252
|
+
# 9. Primary affinity — pooler safety (issue #332). A read/write-splitting
|
|
253
|
+
# pooler (pgdog/pgcat) can route pgmq's VOLATILE read/archive to a read
|
|
254
|
+
# replica, where workers read nothing and jobs stop with a healthy
|
|
255
|
+
# heartbeat. If the job connection currently lands on a replica
|
|
256
|
+
# (pg_is_in_recovery() => t), warn with the direct-port remediation. A
|
|
257
|
+
# warning, never a failure: a deliberate replica-read setup is rare but
|
|
258
|
+
# possible, and require_primary is the enforcement knob for those who want a
|
|
259
|
+
# hard stop.
|
|
260
|
+
def check_primary
|
|
261
|
+
if @client.in_recovery?
|
|
262
|
+
return Check.new(name: "Primary affinity", status: :warn,
|
|
263
|
+
detail: "job connection is on a read-only replica (pg_is_in_recovery() => t) — " \
|
|
264
|
+
"a read/write-splitting pooler may be routing pgmq reads to a standby, " \
|
|
265
|
+
"silently stalling jobs. Point the connection at the DIRECT primary port " \
|
|
266
|
+
"(worker_notify_* / streams_* overrides) and set require_primary to reject " \
|
|
267
|
+
"a replica at boot")
|
|
268
|
+
end
|
|
269
|
+
|
|
270
|
+
Check.new(name: "Primary affinity", status: :ok, detail: "on primary")
|
|
271
|
+
rescue StandardError => e
|
|
272
|
+
Check.new(name: "Primary affinity", status: :warn, detail: "could not determine (#{e.class}: #{e.message})")
|
|
273
|
+
end
|
|
274
|
+
|
|
251
275
|
# True when some configured worker capsule drains the given queue — either
|
|
252
276
|
# by naming it explicitly or via a "*" wildcard (which drains every queue).
|
|
253
277
|
def worker_drains?(queue)
|
|
@@ -49,12 +49,25 @@ module Pgbus
|
|
|
49
49
|
@running = false
|
|
50
50
|
@thread = nil
|
|
51
51
|
@conn = nil
|
|
52
|
+
# Optimistic until the start-time self-probe runs: assume NOTIFY delivery
|
|
53
|
+
# works so a not-yet-probed listener isn't mistaken for a pooler-deaf one.
|
|
54
|
+
@delivering = true
|
|
52
55
|
end
|
|
53
56
|
|
|
54
57
|
def listening_to
|
|
55
58
|
@state_mutex.synchronize { @listening_to.dup }
|
|
56
59
|
end
|
|
57
60
|
|
|
61
|
+
# Whether the start-time self-probe confirmed this connection can actually
|
|
62
|
+
# receive a NOTIFY. False when a transaction-mode pooler or replica
|
|
63
|
+
# silently drops LISTEN: the thread is still alive (running? == true) but
|
|
64
|
+
# will never wake the loop. The Worker/Consumer consult this so a
|
|
65
|
+
# live-but-deaf listener is treated as absent for wake-timeout purposes —
|
|
66
|
+
# fast polling, not the 15s NOTIFY ceiling (issue #332).
|
|
67
|
+
def delivering?
|
|
68
|
+
@state_mutex.synchronize { @delivering }
|
|
69
|
+
end
|
|
70
|
+
|
|
58
71
|
def start
|
|
59
72
|
@state_mutex.synchronize do
|
|
60
73
|
return self if @running
|
|
@@ -116,8 +129,11 @@ module Pgbus
|
|
|
116
129
|
# One-shot delivery self-probe on the initial connection only. A pooler
|
|
117
130
|
# or replica that silently breaks LISTEN/NOTIFY is surfaced here with an
|
|
118
131
|
# actionable error; the listener still runs and degrades to polling.
|
|
119
|
-
# Reconnects skip the probe to stay cheap.
|
|
120
|
-
|
|
132
|
+
# Reconnects skip the probe to stay cheap. Record the result so the
|
|
133
|
+
# owning worker can drop back to fast polling instead of the 15s NOTIFY
|
|
134
|
+
# ceiling when this connection can't actually deliver (issue #332).
|
|
135
|
+
delivering = NotifyProbe.probe_notify_delivery!(conn, logger: @logger)
|
|
136
|
+
@state_mutex.synchronize { @delivering = delivering }
|
|
121
137
|
@state_mutex.synchronize { @conn = conn }
|
|
122
138
|
drain_commands
|
|
123
139
|
|
data/lib/pgbus/process/worker.rb
CHANGED
|
@@ -605,13 +605,20 @@ module Pgbus
|
|
|
605
605
|
def wake_timeout
|
|
606
606
|
# A dead listener (running? false) will never wake the loop, so treat
|
|
607
607
|
# it as absent and keep polling at the short interval until
|
|
608
|
-
# ensure_notify_listener restarts it.
|
|
609
|
-
#
|
|
610
|
-
|
|
608
|
+
# ensure_notify_listener restarts it. A live-but-deaf listener
|
|
609
|
+
# (delivering? false — a transaction-mode pooler or replica that drops
|
|
610
|
+
# LISTEN) is the same story: it will never wake us, so don't raise the
|
|
611
|
+
# poll floor to the 15s ceiling behind it (issue #332). Only a live,
|
|
612
|
+
# delivering listener earns the long NOTIFY-mode ceiling.
|
|
613
|
+
return effective_polling_interval unless notify_wakeup? && listener_delivering?
|
|
611
614
|
|
|
612
615
|
[effective_polling_interval, config.polling_interval, NOTIFY_FALLBACK_POLL_SECONDS].max
|
|
613
616
|
end
|
|
614
617
|
|
|
618
|
+
def listener_delivering?
|
|
619
|
+
@notify_listener&.running? && @notify_listener.delivering?
|
|
620
|
+
end
|
|
621
|
+
|
|
615
622
|
def effective_polling_interval
|
|
616
623
|
return config.polling_interval if @consumer_priority.zero?
|
|
617
624
|
|
data/lib/pgbus/version.rb
CHANGED