Обсуждение: Be clear about what log_checkpoints emits in the documentation

Hi,

Currently the documentation of the log_checkpoints GUC says the following:

        Some statistics are included in the log messages, including the number
        of buffers written and the time spent writing them.

Usage of the word "Some" makes it a vague statement. Why can't we just
be clear about what statistics the log_checkpoints GUC can emit, like
the attached patch?

Thoughts?

Regards,
Bharath Rupireddy.

At Thu, 23 Dec 2021 20:56:22 +0530, Bharath Rupireddy <bharath.rupireddyforpostgres@gmail.com> wrote in 
> Hi,
> 
> Currently the documentation of the log_checkpoints GUC says the following:
> 
>         Some statistics are included in the log messages, including the number
>         of buffers written and the time spent writing them.
> 
> Usage of the word "Some" makes it a vague statement. Why can't we just
> be clear about what statistics the log_checkpoints GUC can emit, like
> the attached patch?
> 
> Thoughts?

It seems like simply a maintenance burden of documentation since it
doesn't add any further detail of any item in a checkpoint log
message.  But I'm not sure we want detailed explanations for them and
it seems to me we deliberately never explained the detail of any log
messages.

regards.

-- 
Kyotaro Horiguchi
NTT Open Source Software Center

On Fri, Dec 24, 2021 at 11:30 AM Kyotaro Horiguchi
<horikyota.ntt@gmail.com> wrote:
>
> At Thu, 23 Dec 2021 20:56:22 +0530, Bharath Rupireddy <bharath.rupireddyforpostgres@gmail.com> wrote in
> > Hi,
> >
> > Currently the documentation of the log_checkpoints GUC says the following:
> >
> >         Some statistics are included in the log messages, including the number
> >         of buffers written and the time spent writing them.
> >
> > Usage of the word "Some" makes it a vague statement. Why can't we just
> > be clear about what statistics the log_checkpoints GUC can emit, like
> > the attached patch?
> >
> > Thoughts?
>
> It seems like simply a maintenance burden of documentation since it
> doesn't add any further detail of any item in a checkpoint log
> message.  But I'm not sure we want detailed explanations for them and
> it seems to me we deliberately never explained the detail of any log
> messages.

Agreed. "Some statistics" can cover whatever existing and newly added
stuff, if any. Let it be that way.

Regards,
Bharath Rupireddy.