Doc: clarify the log message level of the VERBOSE option

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>

On 2024-12-04 21:08, Yugo Nagata wrote:

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.

Thanks for your response!

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

Yes, you're right. I missed it.

-      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?

Since the messages for the VERBOSE options look similar, I unified the
descriptions
for VACUUM, ANALYZE, and REINDEX. However, I don’t have a strong opinion
on this.
I’ve fixed it in the v2 patch.

Regards,
--
Masahiro Ikeda
NTT DATA CORPORATION

On Thu, 05 Dec 2024 10:39:22 +0900
Masahiro Ikeda <ikedamsh@oss.nttdata.com> wrote:

On 2024-12-04 21:08, Yugo Nagata wrote:

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.

Thanks for your response!

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

Yes, you're right. I missed it.

-      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?

Since the messages for the VERBOSE options look similar, I unified the
descriptions
for VACUUM, ANALYZE, and REINDEX. However, I don’t have a strong opinion
on this.
I’ve fixed it in the v2 patch.

-      Prints a progress report as each table is clustered.
+      Prints a progress report as each table is clustered,
+      at <literal>INFO</literal> level.

I feel like the comma could not be necessary here like the fix for
the ANALYZE document, but it might be better to wait for a review
from a native English speaker.

Regards,
Yugo Nagata

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

On 2024-12-05 16:23, Yugo NAGATA wrote:

-      Prints a progress report as each table is clustered.
+      Prints a progress report as each table is clustered,
+      at <literal>INFO</literal> level.

I feel like the comma could not be necessary here like the fix for
the ANALYZE document, but it might be better to wait for a review
from a native English speaker.

Thanks. OK, I'll wait.

Regards,
--
Masahiro Ikeda
NTT DATA CORPORATION

On 2024/12/05 16:48, Masahiro Ikeda wrote:

On 2024-12-05 16:23, Yugo NAGATA wrote:

-      Prints a progress report as each table is clustered.
+      Prints a progress report as each table is clustered,
+      at <literal>INFO</literal> level.

I feel like the comma could not be necessary here like the fix for
the ANALYZE document, but it might be better to wait for a review
from a native English speaker.

Thanks. OK, I'll wait.

I'm not a native English speaker, but barring any objection,
I'd like to commit the attached patch. In this patch,
I've just removed a comma and updated the commit log message.

Regards,

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

On 2024-12-20 02:57, Fujii Masao wrote:

On 2024/12/05 16:48, Masahiro Ikeda wrote:

On 2024-12-05 16:23, Yugo NAGATA wrote:

-      Prints a progress report as each table is clustered.
+      Prints a progress report as each table is clustered,
+      at <literal>INFO</literal> level.

I feel like the comma could not be necessary here like the fix for
the ANALYZE document, but it might be better to wait for a review
from a native English speaker.

Thanks. OK, I'll wait.

I'm not a native English speaker, but barring any objection,
I'd like to commit the attached patch. In this patch,
I've just removed a comma and updated the commit log message.

Regards,

Sorry for the late reply. It's okay with me.
Thank you!

Regards,
--
Masahiro Ikeda
NTT DATA CORPORATION

On 2025/01/06 16:17, Masahiro Ikeda wrote:

On 2024-12-20 02:57, Fujii Masao wrote:

On 2024/12/05 16:48, Masahiro Ikeda wrote:

On 2024-12-05 16:23, Yugo NAGATA wrote:

-      Prints a progress report as each table is clustered.
+      Prints a progress report as each table is clustered,
+      at <literal>INFO</literal> level.

I feel like the comma could not be necessary here like the fix for
the ANALYZE document, but it might be better to wait for a review
from a native English speaker.

Thanks. OK, I'll wait.

I'm not a native English speaker, but barring any objection,
I'd like to commit the attached patch. In this patch,
I've just removed a comma and updated the commit log message.

Regards,

Sorry for the late reply. It's okay with me.

Thanks for checking that! Pushed.

Regards,

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