doc: Add more details about pg_stat_get_xact_blocks_{fetched,hit}

michaelpq · michaelpq · commit 1372166bac30 · 2023-04-05T07:59:55.000+09:00
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
diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml
@@ -3296,17 +3296,21 @@ 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>
 
      <row>
       <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>
 
