Re: Add explanations which are influenced by track_io_timing

Fujii Masao <masao.fujii@oss.nttdata.com>

From: Fujii Masao <masao.fujii@oss.nttdata.com>
To: Atsushi Torikoshi <atorik@gmail.com>, PostgreSQL-development <pgsql-hackers@postgresql.org>
Date: 2020-05-13T14:27:30Z
Lists: pgsql-hackers

Attachments


On 2020/05/13 21:54, Atsushi Torikoshi wrote:
> Hi,
> 
> When track_io_timing is on, I/O timing information is
> displayed in pg_stat_database, in the output of EXPLAIN
> when the BUFFERS option is used, and in pg_stat_statements
> as documented in [1].
> 
> This is also described in the manual for pg_stat_statements
> [2], however, manuals for pg_stat_database and EXPLAIN
> doesn't refer to it.
> 
> I think it'll be better to add descriptions to both of them
> for consistency.
> 
> Thoughts?


+1

+      in milliseconds(if <xref linkend="guc-track-io-timing"/> is enabled,
+      otherwise zero)

It's better to add a space character just after "seconds".

-      written.
+      written. In addition, If <xref linkend="guc-track-io-timing"/> is enabled,
+      also include I/O Timings.

Isn't it better to just use clearer description like "the time reading and
writing data blocks" here instead of "I/O Timing"?
What about the attached patch based on yours?

Regards,

-- 
Fujii Masao
Advanced Computing Technology Center
Research and Development Headquarters
NTT DATA CORPORATION

Commits

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