Make GUC wal_sender_timeout user-settable

michaelpq · michaelpq · commit db361db2fce7 · 2018-09-22T15:23:59.000+09:00
Being able to use a value that can be changed on a connection basis is useful with clusters distributed geographically, and makes failure detection more flexible. A note is added in the documentation about the use of "options" in primary_conninfo, which can be hard to grasp for newcomers with the need of two single quotes when listing a set of parameters. Author: Tsunakawa Takayuki Reviewed-by: Masahiko Sawada, Michael Paquier Discussion: https://postgr.es/m/0A3221C70F24FB45833433255569204D1FAAD3AE@G01JPEXMBYT05
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
@@ -3127,10 +3127,14 @@ include_dir 'conf.d'
         Terminate replication connections that are inactive longer
         than the specified number of milliseconds. This is useful for
         the sending server to detect a standby crash or network outage.
-        A value of zero disables the timeout mechanism.  This parameter
-        can only be set in
-        the <filename>postgresql.conf</filename> file or on the server command line.
-        The default value is 60 seconds.
+        A value of zero disables the timeout mechanism. The default value
+        is 60 seconds. With a cluster distributed across multiple geographic
+        locations, using different values per location brings more flexibility
+        in the cluster management. A smaller value is useful for faster
+        failure detection with a standby having a low-latency network
+        connection, and a larger value helps in judging better the health
+        of a standby if located on a remote location, with a high-latency
+        network connection.
        </para>
       </listitem>
      </varlistentry>
diff --git a/doc/src/sgml/high-availability.sgml b/doc/src/sgml/high-availability.sgml
@@ -738,7 +738,7 @@ protocol to make nodes agree on a serializable transactional order.
     A simple example of a <filename>recovery.conf</filename> is:
 <programlisting>
 standby_mode = 'on'
-primary_conninfo = 'host=192.168.1.50 port=5432 user=foo password=foopass'
+primary_conninfo = 'host=192.168.1.50 port=5432 user=foo password=foopass options=''-c wal_sender_timeout=5000'''
 restore_command = 'cp /path/to/archive/%f %p'
 archive_cleanup_command = 'pg_archivecleanup /path/to/archive %r'
 </programlisting>
diff --git a/src/backend/utils/misc/guc.c b/src/backend/utils/misc/guc.c
@@ -2539,7 +2539,7 @@ static struct config_int ConfigureNamesInt[] =
 	},
 
 	{
-		{"wal_sender_timeout", PGC_SIGHUP, REPLICATION_SENDING,
+		{"wal_sender_timeout", PGC_USERSET, REPLICATION_SENDING,
 			gettext_noop("Sets the maximum time to wait for WAL replication."),
 			NULL,
 			GUC_UNIT_MS

Original file line number	Diff line number	Diff line change
`@@ -2539,7 +2539,7 @@ static struct config_int ConfigureNamesInt[] =`
`2539`	`2539`	`},`
`2540`	`2540`
`2541`	`2541`	`{`
`2542`		`- {"wal_sender_timeout", PGC_SIGHUP, REPLICATION_SENDING,`
	`2542`	`+ {"wal_sender_timeout", PGC_USERSET, REPLICATION_SENDING,`
`2543`	`2543`	`gettext_noop("Sets the maximum time to wait for WAL replication."),`
`2544`	`2544`	`NULL,`
`2545`	`2545`	`GUC_UNIT_MS`