doc: Improve description of targets for pg_stat_reset_shared()
authorMichael Paquier
Wed, 15 Nov 2023 00:41:10 +0000 (09:41 +0900)
committerMichael Paquier
Wed, 15 Nov 2023 00:41:10 +0000 (09:41 +0900)
This commit changes the documentation so as the supported targets are
documented with itemized list, making it easier to understand the view a
given target affects.

Author: Atsushi Torikoshi
Discussion: https://postgr.es/m/e3c25d72e81378e7b64f3c52e0306fc9@oss.nttdata.com

doc/src/sgml/monitoring.sgml

index 6b237d41cb42c227a689fd3e6848c02a34e61eb6..1e9913c8bc771b00e4ae54a6ae1d7647548c7b34 100644 (file)
@@ -4717,22 +4717,51 @@ description | Waiting for a newly initialized WAL file to reach durable storage
        
        
         Resets some cluster-wide statistics counters to zero, depending on the
-        argument.  The argument can be bgwriter to reset
-        all the counters shown in
-        the pg_stat_bgwriter view,
-        checkpointer to reset all the counters shown in
-        the pg_stat_checkpointer view,
-        archiver to reset all the counters shown in
-        the pg_stat_archiver view,
-        io to reset all the counters shown in the
-        pg_stat_io view,
-        wal to reset all the counters shown in the
-        pg_stat_wal view or
-        recovery_prefetch to reset all the counters shown
-        in the pg_stat_recovery_prefetch view.
-        If target is NULL or
-        is not specified, all the counters from the views listed above are
-        reset.
+        argument. target can be:
+       
+        
+         
+          archiver: Reset all the counters shown in the
+          pg_stat_archiver view.
+         
+        
+        
+         
+           bgwriter: Reset all the counters shown in the
+           pg_stat_bgwriter view.
+         
+        
+        
+         
+          checkpointer: Reset all the counters shown in the
+          pg_stat_checkpointer view.
+         
+        
+        
+         
+          io: Reset all the counters shown in the
+          pg_stat_io view.
+         
+        
+        
+         
+          recovery_prefetch: Reset all the counters shown in
+          the pg_stat_recovery_prefetch view.
+         
+        
+        
+         
+          wal: Reset all the counters shown in the
+          pg_stat_wal view.
+         
+        
+        
+         
+          NULL or not specified: All the counters from the
+          views listed above are reset.
+         
+        
+       
        
        
         This function is restricted to superusers by default, but other users