Skip to content

Commit 2a5862f

Browse files
committed
doc: Improve wording of section for repslot statistics
This documentation has been added in 9868167, so no backpatch is needed. Author: Justin Pryzby, Michael Paquier Discussion: https://postgr.es/m/20201222041153.GK30237@telsasoft.com
1 parent 2484329 commit 2a5862f

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

doc/src/sgml/monitoring.sgml

+20-20
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser
317317
<row>
318318
<entry><structname>pg_stat_replication_slots</structname><indexterm><primary>pg_stat_replication_slots</primary></indexterm></entry>
319319
<entry>One row per replication slot, showing statistics about
320-
replication slot usage.
320+
the replication slot's usage.
321321
See <link linkend="monitoring-pg-stat-replication-slots-view">
322322
<structname>pg_stat_replication_slots</structname></link> for details.
323323
</entry>
@@ -2604,10 +2604,10 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
26042604
<structfield>spill_txns</structfield> <type>bigint</type>
26052605
</para>
26062606
<para>
2607-
Number of transactions spilled to disk after the memory used by
2608-
logical decoding of changes from WAL for this slot exceeds
2607+
Number of transactions spilled to disk once the memory used by
2608+
logical decoding to decode changes from WAL has exceeded
26092609
<literal>logical_decoding_work_mem</literal>. The counter gets
2610-
incremented both for toplevel transactions and subtransactions.
2610+
incremented for both toplevel transactions and subtransactions.
26112611
</para></entry>
26122612
</row>
26132613

@@ -2616,9 +2616,10 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
26162616
<structfield>spill_count</structfield> <type>bigint</type>
26172617
</para>
26182618
<para>
2619-
Number of times transactions were spilled to disk while decoding changes
2620-
from WAL for this slot. Transactions may get spilled repeatedly, and
2621-
this counter gets incremented on every such invocation.
2619+
Number of times transactions were spilled to disk while decoding
2620+
changes from WAL for this slot. This counter is incremented each time
2621+
a transaction is spilled, and the same transaction may be spilled
2622+
multiple times.
26222623
</para></entry>
26232624
</row>
26242625

@@ -2639,11 +2640,12 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
26392640
<structfield>stream_txns</structfield> <type>bigint</type>
26402641
</para>
26412642
<para>
2642-
Number of in-progress transactions streamed to the decoding output plugin
2643-
after the memory used by logical decoding of changes from WAL for this
2644-
slot exceeds <literal>logical_decoding_work_mem</literal>. Streaming only
2643+
Number of in-progress transactions streamed to the decoding output
2644+
plugin after the memory used by logical decoding to decode changes
2645+
from WAL for this slot has exceeded
2646+
<literal>logical_decoding_work_mem</literal>. Streaming only
26452647
works with toplevel transactions (subtransactions can't be streamed
2646-
independently), so the counter does not get incremented for subtransactions.
2648+
independently), so the counter is not incremented for subtransactions.
26472649
</para></entry>
26482650
</row>
26492651

@@ -2653,9 +2655,9 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
26532655
</para>
26542656
<para>
26552657
Number of times in-progress transactions were streamed to the decoding
2656-
output plugin while decoding changes from WAL for this slot. Transactions
2657-
may get streamed repeatedly, and this counter gets incremented on every
2658-
such invocation.
2658+
output plugin while decoding changes from WAL for this slot. This
2659+
counter is incremented each time a transaction is streamed, and the
2660+
same transaction may be streamed multiple times.
26592661
</para></entry>
26602662
</row>
26612663

@@ -5042,19 +5044,17 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
50425044
</row>
50435045

50445046
<row>
5045-
<entry role="func_table_entry"><para role="func_signature">
5047+
<entry role="func_table_entry"><para role="func_signature">
50465048
<indexterm>
50475049
<primary>pg_stat_reset_replication_slot</primary>
50485050
</indexterm>
50495051
<function>pg_stat_reset_replication_slot</function> ( <type>text</type> )
50505052
<returnvalue>void</returnvalue>
50515053
</para>
50525054
<para>
5053-
Resets statistics to zero for a single replication slot, or for all
5054-
replication slots in the cluster. The argument can be either the name
5055-
of the slot to reset the stats or NULL. If the argument is NULL, all
5056-
counters shown in the <structname>pg_stat_replication_slots</structname>
5057-
view for all replication slots are reset.
5055+
Resets statistics of the replication slot defined by the argument. If
5056+
the argument is <literal>NULL</literal>, resets statistics for all
5057+
the replication slots.
50585058
</para>
50595059
<para>
50605060
This function is restricted to superusers by default, but other users

0 commit comments

Comments
 (0)