Re: Doc: clarify the log message level of the VERBOSE option - Mailing list pgsql-hackers

From Yugo Nagata
Subject Re: Doc: clarify the log message level of the VERBOSE option
Date
Msg-id 20241204210826.d97e4fcc337f4bb4f2bdb48f@sraoss.co.jp
Whole thread Raw
List pgsql-hackers
On Tue, 03 Dec 2024 18:23:11 +0900
Masahiro Ikeda <ikedamsh@oss.nttdata.com> wrote:

> Hi,
> 
> I'd like to clarify the log message level of the VERBOSE option
> because I misunderstood that VACUUM VERBOSE messages cannot be
> printed in the server log.
> 
> Although the hint is mentioned in "Table 19.2. Message Severity Levels",
> it is not addressed for other commands.
> > INFO    Provides information implicitly requested by the user, e.g., 
> > output from VACUUM VERBOSE.
> https://www.postgresql.org/docs/devel/runtime-config-logging.html#RUNTIME-CONFIG-SEVERITY-LEVELS
> 
> IIUC, the following SQL commands support the VERBOSE option:
> * VACUUM
> * ANALYZE
> * REINDEX
> * COPY
> * EXPALIN
> 
> The VERBOSE option for EXPLAIN is not related to the log message level,
> and COPY already specifies the log message level. Therefore, I'd like to
> add descriptions for the VERBOSE option in the ANALYZE, VACUUM, and
> REINDEX commands.
> 
> What do you think?

This would prevent other users from make a misunderstanding as you did.

I found the description on amvalidate also explains a message is output at INFO level.
( https://www.postgresql.org/docs/devel/index-functions.html )

  Problems should be reported with ereport messages, typically at INFO level.

I don't know the actual intention to mention the message level here, but
this might have the same purpose of you.


Should we add the description for CLUSTER command, since
it also has the VERBOSE options?

-      Enables display of progress messages.
+      Prints a detailed analyze activity report for each table as
+      <literal>INFO</literal> messages.

Do we need rewrite the description in addition to mentioning the message level?

Regards,
Yugo Nagata

-- 
Yugo Nagata <nagata@sraoss.co.jp>



pgsql-hackers by date:

Previous
From: Matthias van de Meent
Date:
Subject: Re: Incorrect result of bitmap heap scan.
Next
From: Amit Langote
Date:
Subject: Re: generic plans and "initial" pruning