diff options
| author | Fujii Masao <fujii@postgresql.org> | 2024-10-01 01:55:45 +0900 |
|---|---|---|
| committer | Fujii Masao <fujii@postgresql.org> | 2024-10-01 02:01:57 +0900 |
| commit | a19f83f87966f763991cc76404f8e42a36e7e842 (patch) | |
| tree | 4e00eb866d26bc091e9aa8b316eea945e37c99d6 | |
| parent | 04c64e3fb35af090c249303b9df0a311f2a07593 (diff) | |
| download | postgresql-a19f83f87966f763991cc76404f8e42a36e7e842.tar.gz postgresql-a19f83f87966f763991cc76404f8e42a36e7e842.zip | |
docs: Enhance the pg_stat_checkpointer view documentation.
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
| -rw-r--r-- | doc/src/sgml/monitoring.sgml | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index d83e99da495..48ffe87241c 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -3051,10 +3051,7 @@ description | Waiting for a newly initialized WAL file to reach durable storage <structfield>num_timed</structfield> <type>bigint</type> </para> <para> - 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 </para></entry> </row> @@ -3063,7 +3060,7 @@ description | Waiting for a newly initialized WAL file to reach durable storage <structfield>num_requested</structfield> <type>bigint</type> </para> <para> - Number of backend requested checkpoints + Number of requested checkpoints </para></entry> </row> @@ -3146,6 +3143,18 @@ description | Waiting for a newly initialized WAL file to reach durable storage </tgroup> </table> + <para> + Checkpoints may be skipped if the server has been idle since the last one. + <structfield>num_timed</structfield> and + <structfield>num_requested</structfield> count both completed and skipped + checkpoints, while <structfield>num_done</structfield> tracks only + the completed ones. Similarly, restartpoints may be skipped + if the last replayed checkpoint record is already the last restartpoint. + <structfield>restartpoints_timed</structfield> and + <structfield>restartpoints_req</structfield> count both completed and + skipped restartpoints, while <structfield>restartpoints_done</structfield> + tracks only the completed ones. + </para> </sect2> <sect2 id="monitoring-pg-stat-wal-view"> |