docs: Enhance the pg_stat_checkpointer view documentation.
authorFujii Masao
Mon, 30 Sep 2024 16:55:45 +0000 (01:55 +0900)
committerFujii Masao
Mon, 30 Sep 2024 17:01:57 +0000 (02:01 +0900)
This commit updates the documentation for the pg_stat_checkpointer view
to clarify what kind of checkpoints or restartpoints each counter tracks.
This makes it easier to understand the meaning of each counter.

Previously, the num_requested description included "backend,"
which could be misleading since requests come from other sources as well.
This commit also removes "backend" from the description of num_requested,
to avoid confusion.

Author: Fujii Masao
Reviewed-by: Anton A. Melnikov
Discussion: https://postgr.es/m/4640258e-d959-4cf0-903c-cd02389c3e05@oss.nttdata.com

doc/src/sgml/monitoring.sgml

index d83e99da4958bf18a9b9ec460f4f0fbcc8a4cffb..48ffe87241c844941e3541daa449c993952ae964 100644 (file)
@@ -3051,10 +3051,7 @@ description | Waiting for a newly initialized WAL file to reach durable storage
        num_timed bigint
       
       
-       Number of scheduled checkpoints due to timeout.
-       Note that checkpoints may be skipped if the server has been idle
-       since the last one, and this value counts both completed and
-       skipped checkpoints
+       Number of scheduled checkpoints due to timeout
       
      
 
@@ -3063,7 +3060,7 @@ description | Waiting for a newly initialized WAL file to reach durable storage
        num_requested bigint
       
       
-       Number of backend requested checkpoints
+       Number of requested checkpoints
       
      
 
@@ -3146,6 +3143,18 @@ description | Waiting for a newly initialized WAL file to reach durable storage
    
   
 
+  
+   Checkpoints may be skipped if the server has been idle since the last one.
+   num_timed and
+   num_requested count both completed and skipped
+   checkpoints, while num_done tracks only
+   the completed ones.  Similarly, restartpoints may be skipped
+   if the last replayed checkpoint record is already the last restartpoint.
+   restartpoints_timed and
+   restartpoints_req count both completed and
+   skipped restartpoints, while restartpoints_done
+   tracks only the completed ones.
+