]> git.ipfire.org Git - thirdparty/postgresql.git/commitdiff
doc: Add more details about pg_stat_get_xact_blocks_{fetched,hit}
authorMichael Paquier <michael@paquier.xyz>
Tue, 4 Apr 2023 22:59:57 +0000 (07:59 +0900)
committerMichael Paquier <michael@paquier.xyz>
Tue, 4 Apr 2023 22:59:57 +0000 (07:59 +0900)
The explanation describing the dependency to system read() calls for
these two functions has been removed in ddfc2d9.  And after more
discussion about d69c404, we have concluded that adding more details
makes them easier to understand.

While on it, use the term "block read requests" (maybe found in cache)
rather than "buffers fetched" and "buffer hits".

Per discussion with Melanie Plageman, Kyotaro Horiguchi, Bertrand
Drouvot and myself.

Discussion: https://postgr.es/m/CAAKRu_ZmdiScT4q83OAbfmR5AH-L5zWya3SXjaxiJvhCob-e2A@mail.gmail.com
Backpatch-through: 11

doc/src/sgml/monitoring.sgml

index 194b63dddbf4cf2d7ff7d5f398a62e460d174280..cbc64c250d124de2d9c05543097ddc245fd240cb 100644 (file)
@@ -3147,8 +3147,11 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
       <entry><literal><function>pg_stat_get_xact_blocks_fetched</function>(oid)</literal><indexterm><primary>pg_stat_get_xact_blocks_fetched</primary></indexterm></entry>
       <entry><type>bigint</type></entry>
       <entry>
-       Returns the number of buffers fetched for table or index, in the current
-       transaction.
+       Returns the number of block read requests for table or index, in the
+       current transaction. This number minus
+       <function>pg_stat_get_xact_blocks_hit</function> gives the number of
+       kernel <function>read()</function> calls; the number of actual
+       physical reads is usually lower due to kernel-level buffering.
       </entry>
      </row>
 
@@ -3156,8 +3159,9 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
       <entry><literal><function>pg_stat_get_xact_blocks_hit</function>(oid)</literal><indexterm><primary>pg_stat_get_xact_blocks_hit</primary></indexterm></entry>
       <entry><type>bigint</type></entry>
       <entry>
-       Returns the number of buffer hits for table or index, in the current
-       transaction.
+       Returns the number of block read requests for table or index, in the
+       current transaction, found in cache (not triggering kernel
+       <function>read()</function> calls).
       </entry>
      </row>