From 9b809157967e1498ea690e50cb4a9a39ff4a07a8 Mon Sep 17 00:00:00 2001 From: Nadav Shatz Date: Mon, 8 Sep 2025 09:58:31 +0300 Subject: [PATCH 3/3] doc: document external replication delay command and arguments Add English documentation for replication_delay_source ('builtin'|'cmd'), replication_delay_source_cmd including positional instance identifier arguments passed in Pgpool backend order, and replication_delay_source_timeout. --- doc/src/sgml/stream-check.sgml | 90 ++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) diff --git a/doc/src/sgml/stream-check.sgml b/doc/src/sgml/stream-check.sgml index d2ca3ca49..12e745e76 100644 --- a/doc/src/sgml/stream-check.sgml +++ b/doc/src/sgml/stream-check.sgml @@ -309,6 +309,96 @@ GRANT pg_monitor TO sr_check_user; + + replication_delay_source (enum) + + replication_delay_source configuration parameter + + + + + Specifies the source of replication delay information used by the + streaming replication delay check worker. Valid values are: + + + + builtin — query the primary and standbys to compute delay. + + + cmd — run an external command to obtain delays for each backend. + + + + When set to cmd, must be set + to the command to execute, and controls + its timeout. + + + This parameter can be changed by reloading the Pgpool-II configurations. + + + + + + replication_delay_source_cmd (string) + + replication_delay_source_cmd configuration parameter + + + + + Specifies the external command to execute when + is set to cmd. The command is executed as the + Pgpool-II process user. + + + The command receives an ordered list of instance identifiers as positional + arguments corresponding to Pgpool backend node indexes (0..N-1). The order + matches Pgpool's backend order so the script can map metrics (for example + from AWS CloudWatch for Aurora) back to the correct node. Each identifier is + one of: + + + + backend_application_name (if configured) + + + <hostname>:<port> (if application name is empty) + + + node<i> (fallback) + + + + The command must write a single line to stdout containing one whitespace-separated + delay value per backend, in milliseconds, in the same order as the arguments. + For example: "0 25.5 100" for a 3-node cluster. + + + This parameter can be changed by reloading the Pgpool-II configurations. + + + + + + replication_delay_source_timeout (integer) + + replication_delay_source_timeout configuration parameter + + + + + Specifies the timeout in seconds for the external command executed when + is set to cmd. + If the command does not finish within the timeout, Pgpool logs an error and + continues. + + + This parameter can be changed by reloading the Pgpool-II configurations. + + + + log_standby_delay (enum) -- 2.51.0