mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Improve description of targets for pg_stat_reset_shared()

Browse Source 
This commit changes the documentation so as the supported targets are
documented with itemized list, making it easier to understand the view a
given target affects.

Author: Atsushi Torikoshi
Discussion: https://postgr.es/m/e3c25d72e81378e7b64f3c52e0306fc9@oss.nttdata.com
This commit is contained in:
Michael Paquier 2023-11-15 09:41:10 +09:00
parent 025584a168
commit 7f6bc3b356
1 changed files with 45 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
doc/src/sgml/monitoring.sgml
View File

@ -4717,22 +4717,51 @@ description | Waiting for a newly initialized WAL file to reach durable storage
</para>
<para>
Resets some cluster-wide statistics counters to zero, depending on the
argument. The argument can be <literal>bgwriter</literal> to reset
all the counters shown in
the <structname>pg_stat_bgwriter</structname> view,
<literal>checkpointer</literal> to reset all the counters shown in
the <structname>pg_stat_checkpointer</structname> view,
<literal>archiver</literal> to reset all the counters shown in
the <structname>pg_stat_archiver</structname> view,
<literal>io</literal> to reset all the counters shown in the
<structname>pg_stat_io</structname> view,
<literal>wal</literal> to reset all the counters shown in the
<structname>pg_stat_wal</structname> view or
<literal>recovery_prefetch</literal> to reset all the counters shown
in the <structname>pg_stat_recovery_prefetch</structname> view.
If <parameter>target</parameter> is <literal>NULL</literal> or
is not specified, all the counters from the views listed above are
reset.
argument. <parameter>target</parameter> can be:
<itemizedlist>
<listitem>
<para>
<literal>archiver</literal>: Reset all the counters shown in the
<structname>pg_stat_archiver</structname> view.
</para>
</listitem>
<listitem>
<para>
<literal>bgwriter</literal>: Reset all the counters shown in the
<structname>pg_stat_bgwriter</structname> view.
</para>
</listitem>
<listitem>
<para>
<literal>checkpointer</literal>: Reset all the counters shown in the
<structname>pg_stat_checkpointer</structname> view.
</para>
</listitem>
<listitem>
<para>
<literal>io</literal>: Reset all the counters shown in the
<structname>pg_stat_io</structname> view.
</para>
</listitem>
<listitem>
<para>
<literal>recovery_prefetch</literal>: Reset all the counters shown in
the <structname>pg_stat_recovery_prefetch</structname> view.
</para>
</listitem>
<listitem>
<para>
<literal>wal</literal>: Reset all the counters shown in the
<structname>pg_stat_wal</structname> view.
</para>
</listitem>
<listitem>
<para>
<literal>NULL</literal> or not specified: All the counters from the
views listed above are reset.
</para>
</listitem>
</itemizedlist>
</para>
<para>
This function is restricted to superusers by default, but other users