doc: Update the layout of "Viewing Statistics" section.
authorFujii Masao
Fri, 29 May 2020 08:14:33 +0000 (17:14 +0900)
committerFujii Masao
Fri, 29 May 2020 08:14:33 +0000 (17:14 +0900)
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

doc/src/sgml/catalogs.sgml
doc/src/sgml/config.sgml
doc/src/sgml/high-availability.sgml
doc/src/sgml/logical-replication.sgml
doc/src/sgml/logicaldecoding.sgml
doc/src/sgml/monitoring.sgml
doc/src/sgml/ref/initdb.sgml
doc/src/sgml/ref/pg_basebackup.sgml
doc/src/sgml/sslinfo.sgml

index 70fda9408b45f8bab18b1b9bdd7651fe3af063a3..700271fd40e1403251473970cec9596a87f66a8c 100644 (file)
@@ -10455,8 +10455,9 @@ SCRAM-SHA-256$<iteration count>:&l
 
   
    The pid column can be joined to the
-   pid column of the 
-   linkend="pg-stat-activity-view">pg_stat_activity
+   pid column of the
+   
+   pg_stat_activity
    view to get more
    information on the session holding or awaiting each lock,
    for example
index a2694e548a42598d5a7d2c1d04c6c989c59a03bb..4eef970d41611306875c5b4a2ab6a1019a1f81e4 100644 (file)
@@ -3889,9 +3889,9 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"'  # Windows
         The synchronous standbys will be those whose names appear
         in this list, and
         that are both currently connected and streaming data in real-time
-        (as shown by a state of streaming in the 
-        linkend="pg-stat-replication-view">pg_stat_replication>
-        view).
+        (as shown by a state of streaming in the
+        >
+        pg_stat_replication view).
         Specifying more than one synchronous standby can allow for very high
         availability and protection against data loss.
        
@@ -4244,8 +4244,8 @@ ANY num_sync ( 
        Specifies the minimum frequency for the WAL receiver
        process on the standby to send information about replication progress
        to the primary or upstream standby, where it can be seen using the
-       
-       linkend="pg-stat-replication-view">pg_stat_replication>
+        linkend="monitoring-pg-stat-replication-view">
+       pg_stat_replication>
        view.  The standby will report
        the last write-ahead log location it has written, the last position it
        has flushed to disk, and the last position it has applied.
@@ -6694,8 +6694,10 @@ local0.*    /var/log/postgresql
 
          
           The backend type corresponds to the column
-          backend_type in the view 
-          linkend="pg-stat-activity-view"/>, but additional types can appear
+          backend_type in the view
+          
+          pg_stat_activity,
+          but additional types can appear
           in the log that don't show in that view.
          
 
@@ -7191,7 +7193,8 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv;
         platforms.  You can use the  tool to
         measure the overhead of timing on your system.
         I/O timing information is
-        displayed in , in the output of
+        displayed in 
+        pg_stat_database, in the output of
          when the BUFFERS option is
         used, and by .  Only superusers can
         change this setting.
index 805e1000557e47d88b352f2cdc2fe6ce3990ad4d..65c3fc62a97595b394f0af8072b4fdab89c1a56a 100644 (file)
@@ -895,7 +895,8 @@ primary_conninfo = 'host=192.168.1.50 port=5432 user=foo password=foopass'
     
     
      You can retrieve a list of WAL sender processes via the
-      view. Large differences between
+     
+     pg_stat_replication view. Large differences between
      pg_current_wal_lsn and the view's sent_lsn field
      might indicate that the master server is under heavy load, while
      differences between sent_lsn and
@@ -904,7 +905,8 @@ primary_conninfo = 'host=192.168.1.50 port=5432 user=foo password=foopass'
     
     
      On a hot standby, the status of the WAL receiver process can be retrieved
-     via the  view.  A large
+     via the 
+     pg_stat_wal_receiver view.  A large
      difference between pg_last_wal_replay_lsn and the
      view's flushed_lsn indicates that WAL is being
      received faster than it can be replayed.
index eba331a72b584cdce79e8e2a87c0a844cbc09aa6..e19bb3fd650e1774292512490821e58ed2da7aa5 100644 (file)
 
   
    The monitoring information about subscription is visible in
-   pg_stat_subscription.
+   
+   pg_stat_subscription.
    This view contains one row for every subscription worker.  A subscription
    can have zero or more active subscription workers depending on its state.
   
index bad3bfe6206c519431a72b2fd47408aeaaf673c9..c89f93cf6bb55618d7424f6c7c85205b92a0c990 100644 (file)
@@ -347,7 +347,8 @@ $ pg_recvlogical -d postgres --slot=test --drop-slot
    
     The pg_replication_slots
     view and the
-    pg_stat_replication
+    
+    pg_stat_replication
     view provide information about the current state of replication slots and
     streaming replication connections respectively. These views apply to both physical and
     logical replication.
index 49d4bb13b9e26b2aa1e4fa135d23a72253eff4e7..321a0f4bb11e39b280c6c9cad16e3c31006e9a29 100644 (file)
@@ -300,7 +300,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
       
        One row per server process, showing information related to
        the current activity of that process, such as state and current query.
-       See  for details.
+       See 
+       pg_stat_activity for details.
       
      
 
@@ -308,7 +309,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
       pg_stat_replicationpg_stat_replication
       One row per WAL sender process, showing statistics about
        replication to that sender's connected standby server.
-       See  for details.
+       See 
+       pg_stat_replication for details.
       
      
 
@@ -316,7 +318,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
       pg_stat_wal_receiverpg_stat_wal_receiver
       Only one row, showing statistics about the WAL receiver from
        that receiver's connected server.
-       See  for details.
+       See 
+       pg_stat_wal_receiver for details.
       
      
 
@@ -324,7 +327,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
       pg_stat_subscriptionpg_stat_subscription
       At least one row per subscription, showing information about
        the subscription workers.
-       See  for details.
+       See 
+       pg_stat_subscription for details.
       
      
 
@@ -332,7 +336,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
       pg_stat_sslpg_stat_ssl
       One row per connection (regular and replication), showing information about
        SSL used on this connection.
-       See  for details.
+       See 
+       pg_stat_ssl for details.
       
      
 
@@ -340,7 +345,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
       pg_stat_gssapipg_stat_gssapi
       One row per connection (regular and replication), showing information about
        GSSAPI authentication and encryption used on this connection.
-       See  for details.
+       See 
+       pg_stat_gssapi for details.
       
      
 
@@ -404,7 +410,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
       pg_stat_archiverpg_stat_archiver
       One row only, showing statistics about the
        WAL archiver process's activity. See
-        for details.
+       
+       pg_stat_archiver for details.
       
      
 
@@ -412,14 +419,16 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
       pg_stat_bgwriterpg_stat_bgwriter
       One row only, showing statistics about the
        background writer process's activity. See
-        for details.
+       
+       pg_stat_bgwriter for details.
      
      
 
      
       pg_stat_databasepg_stat_database
       One row per database, showing database-wide statistics. See
-        for details.
+       
+       pg_stat_database for details.
       
      
 
@@ -428,7 +437,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
       
        One row per database, showing database-wide statistics about
        query cancels due to conflict with recovery on standby servers.
-       See  for details.
+       See 
+       pg_stat_database_conflicts for details.
       
      
 
@@ -437,7 +447,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
       
        One row for each table in the current database, showing statistics
        about accesses to that specific table.
-       See  for details.
+       See 
+       pg_stat_all_tables for details.
       
      
 
@@ -479,7 +490,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
       
        One row for each index in the current database, showing statistics
        about accesses to that specific index.
-       See  for details.
+       See 
+       pg_stat_all_indexes for details.
       
      
 
@@ -500,7 +512,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
       
        One row for each table in the current database, showing statistics
        about I/O on that specific table.
-       See  for details.
+       See 
+       pg_statio_all_tables for details.
       
      
 
@@ -521,7 +534,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
       
        One row for each index in the current database,
        showing statistics about I/O on that specific index.
-       See  for details.
+       See 
+       pg_statio_all_indexes for details.
       
      
 
@@ -542,7 +556,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
      
        One row for each sequence in the current database,
        showing statistics about I/O on that specific sequence.
-       See  for details.
+       See 
+       pg_statio_all_sequences for details.
      
      
 
@@ -564,7 +579,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
       
        One row for each tracked function, showing statistics
        about executions of that function. See
-        for details.
+       
+       pg_stat_user_functions for details.
       
      
 
@@ -578,7 +594,8 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
      
       pg_stat_slrupg_stat_slru
       One row per SLRU, showing statistics of operations. See
-        for details.
+       
+       pg_stat_slru for details.
       
      
 
@@ -608,6 +625,20 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
    into the kernel's handling of I/O.
   
 
+
+  <structname>pg_stat_activity</structname>
+
+  
+   pg_stat_activity
+  
+
+  
+   The pg_stat_activity view will have one row
+   per server process, showing information related to
+   the current activity of that process.
+  
 
   
    <structname>pg_stat_activity</structname> View
@@ -889,12 +920,6 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
    
   
 
-  
-   The pg_stat_activity view will have one row
-   per server process, showing information related to
-   the current activity of that process.
-  
-
   
    
     The wait_event and state columns are
@@ -2135,14 +2160,30 @@ postgres   27093  0.0  0.0  30096  2752 ?        Ss   11:34   0:00 postgres: ser
 
 
 SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event is NOT NULL;
- pid  | wait_event_type |  wait_event
-------+-----------------+---------------
+ pid  | wait_event_type | wait_event 
+------+-----------------+------------
  2540 | Lock            | relation
- 6644 | LWLock          | ProcArrayLock
+ 6644 | LWLock          | ProcArray
 (2 rows)
 
    
 
+
+  <structname>pg_stat_replication</structname>
+
+  
+   pg_stat_replication
+  
+
+   
+   The pg_stat_replication view will contain one row
+   per WAL sender process, showing statistics about replication to that
+   sender's connected standby server.  Only directly connected standbys are
+   listed; no information is available about downstream standby servers.
+  
+
   
    <structname>pg_stat_replication</structname> View
    
@@ -2457,13 +2498,6 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
-  
-   The pg_stat_replication view will contain one row
-   per WAL sender process, showing statistics about replication to that
-   sender's connected standby server.  Only directly connected standbys are
-   listed; no information is available about downstream standby servers.
-  
-
   
    The lag times reported in the pg_stat_replication
    view are measurements of the time taken for recent WAL to be written,
@@ -2503,6 +2537,21 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
+
+  <structname>pg_stat_wal_receiver</structname>
+
+  
+   pg_stat_wal_receiver
+  
+
+  
+   The pg_stat_wal_receiver view will contain only
+   one row, showing statistics about the WAL receiver from that receiver's
+   connected server.
+  
+
   
    <structname>pg_stat_wal_receiver</structname> View
    
@@ -2668,10 +2717,20 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
+
+  <structname>pg_stat_subscription</structname>
+
+  
+   pg_stat_subscription
+  
+
   
-   The pg_stat_wal_receiver view will contain only
-   one row, showing statistics about the WAL receiver from that receiver's
-   connected server.
+   The pg_stat_subscription view will contain one
+   row per subscription for main worker (with null PID if the worker is
+   not running), and additional rows for workers handling the initial data
+   copy of the subscribed tables.
   
 
   
@@ -2776,11 +2835,22 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
+
+  <structname>pg_stat_ssl</structname>
+
+  
+   pg_stat_ssl
+  
+
   
-   The pg_stat_subscription view will contain one
-   row per subscription for main worker (with null PID if the worker is
-   not running), and additional rows for workers handling the initial data
-   copy of the subscribed tables.
+   The pg_stat_ssl view will contain one row per
+   backend or WAL sender process, showing statistics about SSL usage on
+   this connection. It can be joined to pg_stat_activity
+   or pg_stat_replication on the
+   pid column to get more details about the
+   connection.
   
 
   
@@ -2896,11 +2966,20 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
+
+  <structname>pg_stat_gssapi</structname>
+
+  
+   pg_stat_gssapi
+  
+
   
-   The pg_stat_ssl view will contain one row per
-   backend or WAL sender process, showing statistics about SSL usage on
-   this connection. It can be joined to pg_stat_activity
-   or pg_stat_replication on the
+   The pg_stat_gssapi view will contain one row per
+   backend, showing information about GSSAPI usage on this connection. It can
+   be joined to pg_stat_activity or
+   pg_stat_replication on the
    pid column to get more details about the
    connection.
   
@@ -2962,16 +3041,20 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
+
+  <structname>pg_stat_archiver</structname>
+
+  
+   pg_stat_archiver
+  
+
   
-   The pg_stat_gssapi view will contain one row per
-   backend, showing information about GSSAPI usage on this connection. It can
-   be joined to pg_stat_activity or
-   pg_stat_replication on the
-   pid column to get more details about the
-   connection.
+   The pg_stat_archiver view will always have a
+   single row, containing data about the archiver process of the cluster.
   
 
-
   
    <structname>pg_stat_archiver</structname> View
    
@@ -3053,9 +3136,18 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
+
+  <structname>pg_stat_bgwriter</structname>
+
+  
+   pg_stat_bgwriter
+  
+
   
-   The pg_stat_archiver view will always have a
-   single row, containing data about the archiver process of the cluster.
+   The pg_stat_bgwriter view will always have a
+   single row, containing global data for the cluster.
   
 
   
@@ -3181,9 +3273,19 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
+
+  <structname>pg_stat_database</structname>
+
+  
+   pg_stat_database
+  
+
   
-   The pg_stat_bgwriter view will always have a
-   single row, containing global data for the cluster.
+   The pg_stat_database view will contain one row
+   for each database in the cluster, plus one for shared objects, showing
+   database-wide statistics.
   
 
   
@@ -3325,7 +3427,8 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
       
        Number of queries canceled due to conflicts with recovery
        in this database. (Conflicts occur only on standby servers; see
-        for details.)
+       
+       pg_stat_database_conflicts for details.)
       
      
 
@@ -3418,10 +3521,21 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
+
+  <structname>pg_stat_database_conflicts</structname>
+
+  
+   pg_stat_database_conflicts
+  
+
   
-   The pg_stat_database view will contain one row
-   for each database in the cluster, plus one for shared objects, showing
-   database-wide statistics.
+   The pg_stat_database_conflicts view will contain
+   one row per database, showing database-wide statistics about
+   query cancels occurring due to conflicts with recovery on standby servers.
+   This view will only contain information on standby servers, since
+   conflicts do not occur on master servers.
   
 
   
@@ -3510,12 +3624,23 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
+
+  <structname>pg_stat_all_tables</structname>
+
+  
+   pg_stat_all_tables
+  
+
   
-   The pg_stat_database_conflicts view will contain
-   one row per database, showing database-wide statistics about
-   query cancels occurring due to conflicts with recovery on standby servers.
-   This view will only contain information on standby servers, since
-   conflicts do not occur on master servers.
+   The pg_stat_all_tables view will contain
+   one row for each table in the current database (including TOAST
+   tables), showing statistics about accesses to that specific table. The
+   pg_stat_user_tables and
+   pg_stat_sys_tables views
+   contain the same information,
+   but filtered to only show user and system tables respectively.
   
 
   
@@ -3750,14 +3875,23 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
+
+  <structname>pg_stat_all_indexes</structname>
+
+  
+   pg_stat_all_indexes
+  
+
   
-   The pg_stat_all_tables view will contain
-   one row for each table in the current database (including TOAST
-   tables), showing statistics about accesses to that specific table. The
-   pg_stat_user_tables and
-   pg_stat_sys_tables views
+   The pg_stat_all_indexes view will contain
+   one row for each index in the current database,
+   showing statistics about accesses to that specific index. The
+   pg_stat_user_indexes and
+   pg_stat_sys_indexes views
    contain the same information,
-   but filtered to only show user and system tables respectively.
+   but filtered to only show user and system indexes respectively.
   
 
   
@@ -3851,16 +3985,6 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
-  
-   The pg_stat_all_indexes view will contain
-   one row for each index in the current database,
-   showing statistics about accesses to that specific index. The
-   pg_stat_user_indexes and
-   pg_stat_sys_indexes views
-   contain the same information,
-   but filtered to only show user and system indexes respectively.
-  
-
   
    Indexes can be used by simple index scans, bitmap index scans,
    and the optimizer.  In a bitmap scan
@@ -3890,6 +4014,25 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
+
+  <structname>pg_statio_all_tables</structname>
+
+  
+   pg_statio_all_tables
+  
+
+  
+   The pg_statio_all_tables view will contain
+   one row for each table in the current database (including TOAST
+   tables), showing statistics about I/O on that specific table. The
+   pg_statio_user_tables and
+   pg_statio_sys_tables views
+   contain the same information,
+   but filtered to only show user and system tables respectively.
+  
+
   
    <structname>pg_statio_all_tables</structname> View
    
@@ -4007,14 +4150,23 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
+
+  <structname>pg_statio_all_indexes</structname>
+
+  
+   pg_statio_all_indexes
+  
+
   
-   The pg_statio_all_tables view will contain
-   one row for each table in the current database (including TOAST
-   tables), showing statistics about I/O on that specific table. The
-   pg_statio_user_tables and
-   pg_statio_sys_tables views
+   The pg_statio_all_indexes view will contain
+   one row for each index in the current database,
+   showing statistics about I/O on that specific index. The
+   pg_statio_user_indexes and
+   pg_statio_sys_indexes views
    contain the same information,
-   but filtered to only show user and system tables respectively.
+   but filtered to only show user and system indexes respectively.
   
 
   
@@ -4098,14 +4250,19 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
+
+  <structname>pg_statio_all_sequences</structname>
+
+  
+   pg_statio_all_sequences
+  
+
   
-   The pg_statio_all_indexes view will contain
-   one row for each index in the current database,
-   showing statistics about I/O on that specific index. The
-   pg_statio_user_indexes and
-   pg_statio_sys_indexes views
-   contain the same information,
-   but filtered to only show user and system indexes respectively.
+   The pg_statio_all_sequences view will contain
+   one row for each sequence in the current database,
+   showing statistics about I/O on that specific sequence.
   
 
   
@@ -4171,10 +4328,20 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
+
+  <structname>pg_stat_user_functions</structname>
+
+  
+   pg_stat_user_functions
+  
+
   
-   The pg_statio_all_sequences view will contain
-   one row for each sequence in the current database,
-   showing statistics about I/O on that specific sequence.
+   The pg_stat_user_functions view will contain
+   one row for each tracked function, showing statistics about executions of
+   that function.  The  parameter
+   controls exactly which functions are tracked.
   
 
   
@@ -4251,10 +4418,19 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
+
+  <structname>pg_stat_slru</structname>
+
   
    SLRU
   
 
+  
+   pg_stat_slru
+  
+
   
    PostgreSQL accesses certain on-disk information
    via SLRU (simple least-recently-used) caches.
@@ -4364,13 +4540,6 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
    
   
 
-  
-   The pg_stat_user_functions view will contain
-   one row for each tracked function, showing statistics about executions of
-   that function.  The  parameter
-   controls exactly which functions are tracked.
-  
-
  
 
  
index a04a180165007aefd34ff3b21f4b6493c00b7a03..63e148833fce85556cd8311d452177ff33787d33 100644 (file)
@@ -219,7 +219,8 @@ PostgreSQL documentation
         may incur a noticeable performance penalty. If set, checksums
         are calculated for all objects, in all databases. All checksum
         failures will be reported in the
-         view.
+        
+        pg_stat_database view.
        
       
      
index 12fadabfb866fa084154b069fd64194b99f41874..d31fb1ce920687202f9118a6fcfc8eda0529b7e2 100644 (file)
@@ -533,7 +533,8 @@ PostgreSQL documentation
         in a non-zero exit status. However, the base backup will not be
         removed in such a case, as if the  option
         had been used.  Checksum verifications failures will also be reported
-        in the  view.
+        in the 
+        pg_stat_database view.
        
       
      
index 78ff83d6422523d30b4a5efd84e2174b8b3542c6..c237d4ba95dbabccba8b5374365c585d2ba61da3 100644 (file)
@@ -16,7 +16,8 @@
 
  
   Some of the information available through this module can also be obtained
-  using the built-in system view .
+  using the built-in system view 
+  pg_stat_ssl.