diff options
| author | Michael Paquier <michael@paquier.xyz> | 2023-11-15 09:41:10 +0900 |
|---|---|---|
| committer | Michael Paquier <michael@paquier.xyz> | 2023-11-15 09:41:10 +0900 |
| commit | 7f6bc3b356787e5dbc0d371c9c53cb125c20cd6d (patch) | |
| tree | 1d253c841dad42b9359aa3486d78d1690263c932 | |
| parent | 025584a168a4b3002e19350bb8db0ebf1fd10235 (diff) | |
| download | postgresql-7f6bc3b356787e5dbc0d371c9c53cb125c20cd6d.tar.gz postgresql-7f6bc3b356787e5dbc0d371c9c53cb125c20cd6d.zip | |
doc: Improve description of targets for pg_stat_reset_shared()
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
| -rw-r--r-- | doc/src/sgml/monitoring.sgml | 61 |
1 files changed, 45 insertions, 16 deletions
diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index 6b237d41cb4..1e9913c8bc7 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -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 |