Commit eaae947e authored by Fujii Masao's avatar Fujii Masao

doc: Add note about I/O timing information in EXPLAIN and pg_stat_database.

Explain that the followings are tracked only when track_io_timing GUC
is enabled.

- blk_read_time and blk_write_time in pg_stat_database
- time spent reading and writing data file blocks in EXPLAIN output
   with BUFFERS option

Whther track_io_timing is enabled affects also blk_read_time and
blk_write_time in pg_stat_statements, but which was already documented.

Author: Atsushi Torikoshi
Reviewed-by: Fujii Masao
Discussion: https://postgr.es/m/CACZ0uYHo_NwbxpLH76OGF-O=13tkR0ZM0zeyGEhZ+JEXZVRyCA@mail.gmail.com
parent 574925bf
...@@ -3390,7 +3390,8 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i ...@@ -3390,7 +3390,8 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
</para> </para>
<para> <para>
Time spent reading data file blocks by backends in this database, Time spent reading data file blocks by backends in this database,
in milliseconds in milliseconds (if <xref linkend="guc-track-io-timing"/> is enabled,
otherwise zero)
</para></entry> </para></entry>
</row> </row>
...@@ -3400,7 +3401,8 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i ...@@ -3400,7 +3401,8 @@ SELECT pid, wait_event_type, wait_event FROM pg_stat_activity WHERE wait_event i
</para> </para>
<para> <para>
Time spent writing data file blocks by backends in this database, Time spent writing data file blocks by backends in this database,
in milliseconds in milliseconds (if <xref linkend="guc-track-io-timing"/> is enabled,
otherwise zero)
</para></entry> </para></entry>
</row> </row>
......
...@@ -171,8 +171,9 @@ ROLLBACK; ...@@ -171,8 +171,9 @@ ROLLBACK;
<para> <para>
Include information on buffer usage. Specifically, include the number of Include information on buffer usage. Specifically, include the number of
shared blocks hit, read, dirtied, and written, the number of local blocks shared blocks hit, read, dirtied, and written, the number of local blocks
hit, read, dirtied, and written, and the number of temp blocks read and hit, read, dirtied, and written, the number of temp blocks read and
written. written, and the time spent reading and writing data file blocks
(in milliseconds) if <xref linkend="guc-track-io-timing"/> is enabled.
A <emphasis>hit</emphasis> means that a read was avoided because the block was A <emphasis>hit</emphasis> means that a read was avoided because the block was
found already in cache when needed. found already in cache when needed.
Shared blocks contain data from regular tables and indexes; Shared blocks contain data from regular tables and indexes;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment