Re: BUG #15912: The units of `autovacuum_vacuum_cost_delay` setting should be documented - Mailing list pgsql-bugs

From Tom Lane
Subject Re: BUG #15912: The units of `autovacuum_vacuum_cost_delay` setting should be documented
Date
Msg-id 15882.1571942223@sss.pgh.pa.us
Whole thread Raw
In response to Re: BUG #15912: The units of `autovacuum_vacuum_cost_delay` settingshould be documented  (Bruce Momjian <bruce@momjian.us>)
Responses Re: BUG #15912: The units of `autovacuum_vacuum_cost_delay` settingshould be documented
Re: BUG #15912: The units of `autovacuum_vacuum_cost_delay` settingshould be documented
List pgsql-bugs
[ cc'ing pgsql-docs as well ]

Bruce Momjian <bruce@momjian.us> writes:
> I applied a modified version of this patch.  I didn't backpatch it past
> PG 12 because earlier releases were just too different.

I happened to stumble across the effects of this patch while trying
to improve our explanation of statement_timeout.  I follow the goal
of explaining what the default units are, but I really dislike the
way you did it:

+        Abort any statement that takes more than the specified duration
+        (defaults to milliseconds), starting from the time the command arrives at the server
         from the client. ...

I think this is confusingly bad English, and it's poor exposition
because a minor detail (it must be pretty minor, if we got away
without mentioning it at all for years) is injected into the middle
of the basic statement of the variable's purpose.  I think what we'd
be better off doing is to write a separate sentence mentioning the
units, in more or less the same way that we generally handle the
default value.  In <14850.1571941169@sss.pgh.pa.us> I suggested
this revision for statement_timeout:

        Abort any statement that takes more than the specified duration.
        If <varname>log_min_error_statement</varname> is set
        to <literal>ERROR</literal> or lower, the statement that timed out
        will also be logged.
        If the value is specified as a plain number, it is measured in
        milliseconds by default.
        A value of zero (the default) disables the timeout.

(I'm not quite sure whether the ending "by default" is worth writing
or not.)

Barring objections, I'll run around and make them all look like that.

            regards, tom lane



pgsql-bugs by date:

Previous
From: Tom Lane
Date:
Subject: Re: BUG #16035: STATEMENT_TIMEOUT not working when we have single quote usage inside CTE which is used in inner sql
Next
From: Andres Freund
Date:
Subject: Re: BUG #16073: pg_dump build crashes half way