Skip to content

Commit 92f9468

Browse files
MasaoFujiiMasaoFujii
committed
doc: Update the layout of "Viewing Statistics" section.
This commit updates the "Viewing Statistics" section more like the existing catalogs chapter. - Change its layout so that an introductory paragrap is put above the table for each statistics view. Previously the explanations were below the tables. - Separate each view to different section and add index terms for them. Author: Fujii Masao Reviewed-by: Tom Lane Discussion: https://postgr.es/m/6f8a482c-b3fa-4ed9-21c3-6d222a2cb87d@oss.nttdata.com
1 parent 6a4a335 commit 92f9468

File tree

9 files changed

+300
-120
lines changed

9 files changed

+300
-120
lines changed

‎doc/src/sgml/catalogs.sgml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10455,8 +10455,9 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
1045510455

1045610456
<para>
1045710457
The <structfield>pid</structfield> column can be joined to the
10458-
<structfield>pid</structfield> column of the <link
10459-
linkend="pg-stat-activity-view"><structname>pg_stat_activity</structname></link>
10458+
<structfield>pid</structfield> column of the
10459+
<link linkend="monitoring-pg-stat-activity-view">
10460+
<structname>pg_stat_activity</structname></link>
1046010461
view to get more
1046110462
information on the session holding or awaiting each lock,
1046210463
for example

‎doc/src/sgml/config.sgml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3889,9 +3889,9 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
38893889
The synchronous standbys will be those whose names appear
38903890
in this list, and
38913891
that are both currently connected and streaming data in real-time
3892-
(as shown by a state of <literal>streaming</literal> in the <link
3893-
linkend="pg-stat-replication-view"><literal>pg_stat_replication</literal></link>
3894-
view).
3892+
(as shown by a state of <literal>streaming</literal> in the
3893+
<link linkend="monitoring-pg-stat-replication-view">
3894+
<structname>pg_stat_replication</structname></link> view).
38953895
Specifying more than one synchronous standby can allow for very high
38963896
availability and protection against data loss.
38973897
</para>
@@ -4244,8 +4244,8 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
42444244
Specifies the minimum frequency for the WAL receiver
42454245
process on the standby to send information about replication progress
42464246
to the primary or upstream standby, where it can be seen using the
4247-
<link
4248-
linkend="pg-stat-replication-view"><literal>pg_stat_replication</literal></link>
4247+
<link linkend="monitoring-pg-stat-replication-view">
4248+
<structname>pg_stat_replication</structname></link>
42494249
view. The standby will report
42504250
the last write-ahead log location it has written, the last position it
42514251
has flushed to disk, and the last position it has applied.
@@ -6694,8 +6694,10 @@ local0.* /var/log/postgresql
66946694

66956695
<para>
66966696
The backend type corresponds to the column
6697-
<structfield>backend_type</structfield> in the view <xref
6698-
linkend="pg-stat-activity-view"/>, but additional types can appear
6697+
<structfield>backend_type</structfield> in the view
6698+
<link linkend="monitoring-pg-stat-activity-view">
6699+
<structname>pg_stat_activity</structname></link>,
6700+
but additional types can appear
66996701
in the log that don't show in that view.
67006702
</para>
67016703

@@ -7191,7 +7193,8 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
71917193
platforms. You can use the <xref linkend="pgtesttiming"/> tool to
71927194
measure the overhead of timing on your system.
71937195
I/O timing information is
7194-
displayed in <xref linkend="pg-stat-database-view"/>, in the output of
7196+
displayed in <link linkend="monitoring-pg-stat-database-view">
7197+
<structname>pg_stat_database</structname></link>, in the output of
71957198
<xref linkend="sql-explain"/> when the <literal>BUFFERS</literal> option is
71967199
used, and by <xref linkend="pgstatstatements"/>. Only superusers can
71977200
change this setting.

‎doc/src/sgml/high-availability.sgml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -895,7 +895,8 @@ primary_conninfo = 'host=192.168.1.50 port=5432 user=foo password=foopass'
895895
</para>
896896
<para>
897897
You can retrieve a list of WAL sender processes via the
898-
<xref linkend="pg-stat-replication-view"/> view. Large differences between
898+
<link linkend="monitoring-pg-stat-replication-view"><structname>
899+
pg_stat_replication</structname></link> view. Large differences between
899900
<function>pg_current_wal_lsn</function> and the view's <literal>sent_lsn</literal> field
900901
might indicate that the master server is under heavy load, while
901902
differences between <literal>sent_lsn</literal> and
@@ -904,7 +905,8 @@ primary_conninfo = 'host=192.168.1.50 port=5432 user=foo password=foopass'
904905
</para>
905906
<para>
906907
On a hot standby, the status of the WAL receiver process can be retrieved
907-
via the <xref linkend="pg-stat-wal-receiver-view"/> view. A large
908+
via the <link linkend="monitoring-pg-stat-wal-receiver-view">
909+
<structname>pg_stat_wal_receiver</structname></link> view. A large
908910
difference between <function>pg_last_wal_replay_lsn</function> and the
909911
view's <literal>flushed_lsn</literal> indicates that WAL is being
910912
received faster than it can be replayed.

‎doc/src/sgml/logical-replication.sgml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -495,7 +495,8 @@
495495

496496
<para>
497497
The monitoring information about subscription is visible in
498-
<link linkend="pg-stat-subscription"><literal>pg_stat_subscription</literal></link>.
498+
<link linkend="monitoring-pg-stat-subscription">
499+
<structname>pg_stat_subscription</structname></link>.
499500
This view contains one row for every subscription worker. A subscription
500501
can have zero or more active subscription workers depending on its state.
501502
</para>

‎doc/src/sgml/logicaldecoding.sgml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,8 @@ $ pg_recvlogical -d postgres --slot=test --drop-slot
347347
<para>
348348
The <link linkend="view-pg-replication-slots"><structname>pg_replication_slots</structname></link>
349349
view and the
350-
<link linkend="pg-stat-replication-view"><structname>pg_stat_replication</structname></link>
350+
<link linkend="monitoring-pg-stat-replication-view">
351+
<structname>pg_stat_replication</structname></link>
351352
view provide information about the current state of replication slots and
352353
streaming replication connections respectively. These views apply to both physical and
353354
logical replication.

0 commit comments

Comments
 (0)