pg.ddx.io  pgsql-hackers@postgresql.org mailing list archive  
help / color / mirror / Atom feed
[PATCH v7 1/4] Remove wal_[sync|write][_time] from pg_stat_wal
10+ messages / 5 participants
[nested] [flat]

Commits from this thread:
  2025-09-02 229911c4bf  Add HINT for COPY TO when WHERE clause is used.
* [PATCH v7 1/4] Remove wal_[sync|write][_time] from pg_stat_wal
@ 2025-02-17 07:17  Bertrand Drouvot <bertranddrouvot.pg@gmail.com>
  0 siblings, 0 replies; 10+ messages in thread

From: Bertrand Drouvot @ 2025-02-17 07:17 UTC (permalink / raw)

a051e71e28a added this information into pg_stat_io (with more details and
granularity), so there is no need to keep it in pg_stat_wal. This also
allows to remove PendingWalStats and simplifies up coming commits related
to per backend WAL statistics.
---
 doc/src/sgml/config.sgml                |  4 +-
 doc/src/sgml/monitoring.sgml            | 98 +++++++++++--------------
 doc/src/sgml/wal.sgml                   |  9 ++-
 src/backend/access/transam/xlog.c       | 27 -------
 src/backend/catalog/system_views.sql    |  4 -
 src/backend/utils/activity/pgstat_wal.c | 24 +-----
 src/backend/utils/adt/pgstatfuncs.c     | 20 +----
 src/include/catalog/pg_proc.dat         |  6 +-
 src/include/pgstat.h                    | 28 -------
 src/test/regress/expected/rules.out     |  6 +-
 src/tools/pgindent/typedefs.list        |  1 -
 11 files changed, 57 insertions(+), 170 deletions(-)
  56.1% doc/src/sgml/
   6.6% src/backend/access/transam/
  11.6% src/backend/utils/activity/
  11.0% src/backend/utils/adt/
   3.4% src/include/catalog/
   7.7% src/include/
   3.3% src/

inline patch 1: doc/src/sgml/config.sgml, doc/src/sgml/monitoring.sgml, doc/src/sgml/wal.sgml and 8 more (+57/-170 lines) download inline-1.patchdiff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index 336630ce417..9fff9048551 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -8341,8 +8341,8 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; You can use the <application>pg_test_timing</application> tool to measure the overhead of timing on your system. I/O timing information is - displayed in <link linkend="monitoring-pg-stat-wal-view"> - <structname>pg_stat_wal</structname></link>. + displayed in <link linkend="monitoring-pg-stat-io-view"> + <structname>pg_stat_io</structname></link> for the wal <literal>object</literal>. Only superusers and users with the appropriate <literal>SET</literal> privilege can change this setting. </para> diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index 928a6eb64b0..e645591ce53 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -2930,6 +2930,47 @@ description | Waiting for a newly initialized WAL file to reach durable storage writer</literal>. </para> + <para> + For the <literal>wal</literal> <structfield>object</structfield>: + <itemizedlist> + <listitem> + <para> + <structfield>writes</structfield> is the number of times WAL buffers were + written out to disk via <function>XLogWrite</function> request (See <xref linkend="wal-configuration"/> + for more information about the internal WAL function <function>XLogWrite</function>). + </para> + </listitem> + <listitem> + <para> + <structfield>fsyncs</structfield> is the number of times WAL files were + synced to disk via <function>issue_xlog_fsync</function> request (if <xref linkend="guc-fsync"/> + is <literal>on</literal> and <xref linkend="guc-wal-sync-method"/> is either + <literal>fdatasync</literal>, <literal>fsync</literal> or <literal>fsync_writethrough</literal>, + otherwise zero) (See <xref linkend="wal-configuration"/> for more information about + the internal WAL function <function>issue_xlog_fsync</function>). + </para> + </listitem> + <listitem> + <para> + <structfield>write_time</structfield> is the total amount of time spent writing + WAL buffers to disk via <function>XLogWrite</function> request (if <xref linkend="guc-track-wal-io-timing"/> + is enabled, otherwise zero). This includes the sync time when <varname>wal_sync_method</varname> + is either <literal>open_datasync</literal> or <literal>open_sync</literal>. + </para> + </listitem> + <listitem> + <para> + <structfield>sync_time</structfield> is the total amount of time spent syncing + WAL files to disk via <function>issue_xlog_fsync</function> request (if + <varname>track_wal_io_timing</varname> is enabled, <varname>fsync</varname> is + <literal>on</literal>, and <varname>wal_sync_method</varname> is either + <literal>fdatasync</literal>, <literal>fsync</literal> or <literal>fsync_writethrough</literal>, + otherwise zero). + </para> + </listitem> + </itemizedlist> + </para> + <para> <structname>pg_stat_io</structname> can be used to inform database tuning. For example: @@ -3255,63 +3296,6 @@ description | Waiting for a newly initialized WAL file to reach durable storage </para></entry> </row> - <row> - <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>wal_write</structfield> <type>bigint</type> - </para> - <para> - Number of times WAL buffers were written out to disk via - <function>XLogWrite</function> request. - See <xref linkend="wal-configuration"/> for more information about - the internal WAL function <function>XLogWrite</function>. - </para></entry> - </row> - - <row> - <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>wal_sync</structfield> <type>bigint</type> - </para> - <para> - Number of times WAL files were synced to disk via - <function>issue_xlog_fsync</function> request - (if <xref linkend="guc-fsync"/> is <literal>on</literal> and - <xref linkend="guc-wal-sync-method"/> is either - <literal>fdatasync</literal>, <literal>fsync</literal> or - <literal>fsync_writethrough</literal>, otherwise zero). - See <xref linkend="wal-configuration"/> for more information about - the internal WAL function <function>issue_xlog_fsync</function>. - </para></entry> - </row> - - <row> - <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>wal_write_time</structfield> <type>double precision</type> - </para> - <para> - Total amount of time spent writing WAL buffers to disk via - <function>XLogWrite</function> request, in milliseconds - (if <xref linkend="guc-track-wal-io-timing"/> is enabled, - otherwise zero). This includes the sync time when - <varname>wal_sync_method</varname> is either - <literal>open_datasync</literal> or <literal>open_sync</literal>. - </para></entry> - </row> - - <row> - <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>wal_sync_time</structfield> <type>double precision</type> - </para> - <para> - Total amount of time spent syncing WAL files to disk via - <function>issue_xlog_fsync</function> request, in milliseconds - (if <varname>track_wal_io_timing</varname> is enabled, - <varname>fsync</varname> is <literal>on</literal>, and - <varname>wal_sync_method</varname> is either - <literal>fdatasync</literal>, <literal>fsync</literal> or - <literal>fsync_writethrough</literal>, otherwise zero). - </para></entry> - </row> - <row> <entry role="catalog_table_entry"><para role="column_definition"> <structfield>stats_reset</structfield> <type>timestamp with time zone</type> diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml index b908720adea..bb4892413fc 100644 --- a/doc/src/sgml/wal.sgml +++ b/doc/src/sgml/wal.sgml @@ -813,8 +813,8 @@ When <xref linkend="guc-track-wal-io-timing"/> is enabled, the total amounts of time <function>XLogWrite</function> writes and <function>issue_xlog_fsync</function> syncs WAL data to disk are counted as - <literal>wal_write_time</literal> and <literal>wal_sync_time</literal> in - <xref linkend="pg-stat-wal-view"/>, respectively. + <literal>write_time</literal> and <literal>sync_time</literal> in + <xref linkend="pg-stat-io-view"/> for the wal <literal>object</literal>, respectively. <function>XLogWrite</function> is normally called by <function>XLogInsertRecord</function> (when there is no space for the new record in WAL buffers), <function>XLogFlush</function> and the WAL writer, @@ -832,8 +832,9 @@ of the setting of <varname>track_wal_io_timing</varname>, the number of times <function>XLogWrite</function> writes and <function>issue_xlog_fsync</function> syncs WAL data to disk are also - counted as <literal>wal_write</literal> and <literal>wal_sync</literal> - in <structname>pg_stat_wal</structname>, respectively. + counted as <literal>write</literal> and <literal>sync</literal> + in <structname>pg_stat_io</structname> for the <literal>wal</literal> object + respectively. </para> <para> diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c index 25a5c605404..020b99d402c 100644 --- a/src/backend/access/transam/xlog.c +++ b/src/backend/access/transam/xlog.c @@ -2448,20 +2448,6 @@ XLogWrite(XLogwrtRqst WriteRqst, TimeLineID tli, bool flexible) pgstat_count_io_op_time(IOOBJECT_WAL, IOCONTEXT_NORMAL, IOOP_WRITE, start, 1, written); - /* - * Increment the I/O timing and the number of times WAL data - * were written out to disk. - */ - if (track_wal_io_timing) - { - instr_time end; - - INSTR_TIME_SET_CURRENT(end); - INSTR_TIME_ACCUM_DIFF(PendingWalStats.wal_write_time, end, start); - } - - PendingWalStats.wal_write++; - if (written <= 0) { char xlogfname[MAXFNAMELEN]; @@ -8767,21 +8753,8 @@ issue_xlog_fsync(int fd, XLogSegNo segno, TimeLineID tli) pgstat_report_wait_end(); - /* - * Increment the I/O timing and the number of times WAL files were synced. - */ - if (track_wal_io_timing) - { - instr_time end; - - INSTR_TIME_SET_CURRENT(end); - INSTR_TIME_ACCUM_DIFF(PendingWalStats.wal_sync_time, end, start); - } - pgstat_count_io_op_time(IOOBJECT_WAL, IOCONTEXT_NORMAL, IOOP_FSYNC, start, 1, 0); - - PendingWalStats.wal_sync++; } /* diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index eff0990957e..a4d2cfdcaf5 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1189,10 +1189,6 @@ CREATE VIEW pg_stat_wal AS w.wal_fpi, w.wal_bytes, w.wal_buffers_full, - w.wal_write, - w.wal_sync, - w.wal_write_time, - w.wal_sync_time, w.stats_reset FROM pg_stat_get_wal() w; diff --git a/src/backend/utils/activity/pgstat_wal.c b/src/backend/utils/activity/pgstat_wal.c index c1ca65eb991..4dc41a4a590 100644 --- a/src/backend/utils/activity/pgstat_wal.c +++ b/src/backend/utils/activity/pgstat_wal.c @@ -21,8 +21,6 @@ #include "utils/pgstat_internal.h" -PgStat_PendingWalStats PendingWalStats = {0}; - /* * WAL usage counters saved from pgWalUsage at the previous call to * pgstat_report_wal(). This is used to calculate how much WAL usage @@ -118,17 +116,10 @@ pgstat_wal_flush_cb(bool nowait) #define WALSTAT_ACC(fld, var_to_add) \ (stats_shmem->stats.fld += var_to_add.fld) -#define WALSTAT_ACC_INSTR_TIME(fld) \ - (stats_shmem->stats.fld += INSTR_TIME_GET_MICROSEC(PendingWalStats.fld)) WALSTAT_ACC(wal_records, wal_usage_diff); WALSTAT_ACC(wal_fpi, wal_usage_diff); WALSTAT_ACC(wal_bytes, wal_usage_diff); WALSTAT_ACC(wal_buffers_full, wal_usage_diff); - WALSTAT_ACC(wal_write, PendingWalStats); - WALSTAT_ACC(wal_sync, PendingWalStats); - WALSTAT_ACC_INSTR_TIME(wal_write_time); - WALSTAT_ACC_INSTR_TIME(wal_sync_time); -#undef WALSTAT_ACC_INSTR_TIME #undef WALSTAT_ACC LWLockRelease(&stats_shmem->lock); @@ -138,11 +129,6 @@ pgstat_wal_flush_cb(bool nowait) */ prevWalUsage = pgWalUsage; - /* - * Clear out the statistics buffer, so it can be re-used. - */ - MemSet(&PendingWalStats, 0, sizeof(PendingWalStats)); - return false; } @@ -158,18 +144,12 @@ pgstat_wal_init_backend_cb(void) } /* - * To determine whether any WAL activity has occurred since last time, not - * only the number of generated WAL records but also the numbers of WAL - * writes and syncs need to be checked. Because even transaction that - * generates no WAL records can write or sync WAL data when flushing the - * data pages. + * To determine whether WAL usage happened. */ bool pgstat_wal_have_pending_cb(void) { - return pgWalUsage.wal_records != prevWalUsage.wal_records || - PendingWalStats.wal_write != 0 || - PendingWalStats.wal_sync != 0; + return pgWalUsage.wal_records != prevWalUsage.wal_records; } void diff --git a/src/backend/utils/adt/pgstatfuncs.c b/src/backend/utils/adt/pgstatfuncs.c index e9096a88492..68e16e52ab6 100644 --- a/src/backend/utils/adt/pgstatfuncs.c +++ b/src/backend/utils/adt/pgstatfuncs.c @@ -1637,7 +1637,7 @@ pg_stat_get_backend_io(PG_FUNCTION_ARGS) Datum pg_stat_get_wal(PG_FUNCTION_ARGS) { -#define PG_STAT_GET_WAL_COLS 9 +#define PG_STAT_GET_WAL_COLS 5 TupleDesc tupdesc; Datum values[PG_STAT_GET_WAL_COLS] = {0}; bool nulls[PG_STAT_GET_WAL_COLS] = {0}; @@ -1654,15 +1654,7 @@ pg_stat_get_wal(PG_FUNCTION_ARGS) NUMERICOID, -1, 0); TupleDescInitEntry(tupdesc, (AttrNumber) 4, "wal_buffers_full", INT8OID, -1, 0); - TupleDescInitEntry(tupdesc, (AttrNumber) 5, "wal_write", - INT8OID, -1, 0); - TupleDescInitEntry(tupdesc, (AttrNumber) 6, "wal_sync", - INT8OID, -1, 0); - TupleDescInitEntry(tupdesc, (AttrNumber) 7, "wal_write_time", - FLOAT8OID, -1, 0); - TupleDescInitEntry(tupdesc, (AttrNumber) 8, "wal_sync_time", - FLOAT8OID, -1, 0); - TupleDescInitEntry(tupdesc, (AttrNumber) 9, "stats_reset", + TupleDescInitEntry(tupdesc, (AttrNumber) 5, "stats_reset", TIMESTAMPTZOID, -1, 0); BlessTupleDesc(tupdesc); @@ -1682,14 +1674,8 @@ pg_stat_get_wal(PG_FUNCTION_ARGS) Int32GetDatum(-1)); values[3] = Int64GetDatum(wal_stats->wal_buffers_full); - values[4] = Int64GetDatum(wal_stats->wal_write); - values[5] = Int64GetDatum(wal_stats->wal_sync); - - /* Convert counters from microsec to millisec for display */ - values[6] = Float8GetDatum(((double) wal_stats->wal_write_time) / 1000.0); - values[7] = Float8GetDatum(((double) wal_stats->wal_sync_time) / 1000.0); - values[8] = TimestampTzGetDatum(wal_stats->stat_reset_timestamp); + values[4] = TimestampTzGetDatum(wal_stats->stat_reset_timestamp); /* Returns the record as Datum */ PG_RETURN_DATUM(HeapTupleGetDatum(heap_form_tuple(tupdesc, values, nulls))); diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 9e803d610d7..1e1626964e3 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -5950,9 +5950,9 @@ { oid => '1136', descr => 'statistics: information about WAL activity', proname => 'pg_stat_get_wal', proisstrict => 'f', provolatile => 's', proparallel => 'r', prorettype => 'record', proargtypes => '', - proallargtypes => '{int8,int8,numeric,int8,int8,int8,float8,float8,timestamptz}', - proargmodes => '{o,o,o,o,o,o,o,o,o}', - proargnames => '{wal_records,wal_fpi,wal_bytes,wal_buffers_full,wal_write,wal_sync,wal_write_time,wal_sync_time,stats_reset}', + proallargtypes => '{int8,int8,numeric,int8,timestamptz}', + proargmodes => '{o,o,o,o,o}', + proargnames => '{wal_records,wal_fpi,wal_bytes,wal_buffers_full,stats_reset}', prosrc => 'pg_stat_get_wal' }, { oid => '6248', descr => 'statistics: information about WAL prefetching', proname => 'pg_stat_get_recovery_prefetch', prorows => '1', proretset => 't', diff --git a/src/include/pgstat.h b/src/include/pgstat.h index 53f2a8458e6..a3a341cc604 100644 --- a/src/include/pgstat.h +++ b/src/include/pgstat.h @@ -480,28 +480,9 @@ typedef struct PgStat_WalStats PgStat_Counter wal_fpi; uint64 wal_bytes; PgStat_Counter wal_buffers_full; - PgStat_Counter wal_write; - PgStat_Counter wal_sync; - PgStat_Counter wal_write_time; - PgStat_Counter wal_sync_time; TimestampTz stat_reset_timestamp; } PgStat_WalStats; -/* - * This struct stores wal-related durations as instr_time, which makes it - * cheaper and easier to accumulate them, by not requiring type - * conversions. During stats flush instr_time will be converted into - * microseconds. - */ -typedef struct PgStat_PendingWalStats -{ - PgStat_Counter wal_write; - PgStat_Counter wal_sync; - instr_time wal_write_time; - instr_time wal_sync_time; -} PgStat_PendingWalStats; - - /* * Functions in pgstat.c */ @@ -834,13 +815,4 @@ extern PGDLLIMPORT PgStat_Counter pgStatTransactionIdleTime; /* updated by the traffic cop and in errfinish() */ extern PGDLLIMPORT SessionEndType pgStatSessionEndCause; - -/* - * Variables in pgstat_wal.c - */ - -/* updated directly by backends and background processes */ -extern PGDLLIMPORT PgStat_PendingWalStats PendingWalStats; - - #endif /* PGSTAT_H */ diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index 5baba8d39ff..62f69ac20b2 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -2259,12 +2259,8 @@ pg_stat_wal| SELECT wal_records, wal_fpi, wal_bytes, wal_buffers_full, - wal_write, - wal_sync, - wal_write_time, - wal_sync_time, stats_reset - FROM pg_stat_get_wal() w(wal_records, wal_fpi, wal_bytes, wal_buffers_full, wal_write, wal_sync, wal_write_time, wal_sync_time, stats_reset); + FROM pg_stat_get_wal() w(wal_records, wal_fpi, wal_bytes, wal_buffers_full, stats_reset); pg_stat_wal_receiver| SELECT pid, status, receive_start_lsn, diff --git a/src/tools/pgindent/typedefs.list b/src/tools/pgindent/typedefs.list index bce4214503d..740777127e9 100644 --- a/src/tools/pgindent/typedefs.list +++ b/src/tools/pgindent/typedefs.list @@ -2163,7 +2163,6 @@ PgStat_KindInfo PgStat_LocalState PgStat_PendingDroppedStatsItem PgStat_PendingIO -PgStat_PendingWalStats PgStat_SLRUStats PgStat_ShmemControl PgStat_Snapshot -- 2.34.1
--n09zli6rpHChdwJ/ Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="v7-0002-Extract-logic-filling-pg_stat_get_wal-s-tuple-int.patch" ^ permalink raw reply [nested|flat] 10+ messages in thread

* [PATCH v1 2/3] Remove wal_[sync|write][_time] from pg_stat_wal and track_wal_io_timing
@ 2025-02-18 07:58  Bertrand Drouvot <bertranddrouvot.pg@gmail.com>
  0 siblings, 0 replies; 10+ messages in thread

From: Bertrand Drouvot @ 2025-02-18 07:58 UTC (permalink / raw)

a051e71e28a added this information into pg_stat_io (with more details and
granularity), so there is no need to keep it in pg_stat_wal. This also
allows to remove PendingWalStats and simplifies up coming commits related
to per backend WAL statistics. Once done, track_wal_io_timing becomes useless
so it is also removed.
---
 doc/src/sgml/config.sgml                      | 22 -------
 doc/src/sgml/monitoring.sgml                  | 62 -------------------
 doc/src/sgml/wal.sgml                         | 12 ++--
 src/backend/access/transam/xlog.c             | 38 ++----------
 src/backend/catalog/system_views.sql          |  4 --
 src/backend/utils/activity/pgstat_wal.c       | 24 +------
 src/backend/utils/adt/pgstatfuncs.c           | 20 +-----
 src/backend/utils/misc/guc_tables.c           |  9 ---
 src/backend/utils/misc/postgresql.conf.sample |  1 -
 src/include/access/xlog.h                     |  1 -
 src/include/catalog/pg_proc.dat               |  6 +-
 src/include/pgstat.h                          | 28 ---------
 src/test/regress/expected/rules.out           |  6 +-
 src/tools/pgindent/typedefs.list              |  1 -
 14 files changed, 19 insertions(+), 215 deletions(-)
  48.6% doc/src/sgml/
  12.7% src/backend/access/transam/
  11.1% src/backend/utils/activity/
  10.6% src/backend/utils/adt/
   3.4% src/backend/
   3.2% src/include/catalog/
   7.9% src/include/

inline patch 1: doc/src/sgml/config.sgml, doc/src/sgml/monitoring.sgml, doc/src/sgml/wal.sgml and 11 more (+19/-215 lines) download inline-1.patchdiff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index 336630ce417..05760241174 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -8327,28 +8327,6 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; </listitem> </varlistentry> - <varlistentry id="guc-track-wal-io-timing" xreflabel="track_wal_io_timing"> - <term><varname>track_wal_io_timing</varname> (<type>boolean</type>) - <indexterm> - <primary><varname>track_wal_io_timing</varname> configuration parameter</primary> - </indexterm> - </term> - <listitem> - <para> - Enables timing of WAL I/O calls. This parameter is off by default, - as it will repeatedly query the operating system for the current time, - which may cause significant overhead on some platforms. - You can use the <application>pg_test_timing</application> tool to - measure the overhead of timing on your system. - I/O timing information is - displayed in <link linkend="monitoring-pg-stat-wal-view"> - <structname>pg_stat_wal</structname></link>. - Only superusers and users with the appropriate <literal>SET</literal> - privilege can change this setting. - </para> - </listitem> - </varlistentry> - <varlistentry id="guc-track-functions" xreflabel="track_functions"> <term><varname>track_functions</varname> (<type>enum</type>) <indexterm> diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index 2c61c0d1e50..8cbc89aa797 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -183,11 +183,6 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser of block read, write, extend, and fsync times. </para> - <para> - The parameter <xref linkend="guc-track-wal-io-timing"/> enables monitoring - of WAL write and fsync times. - </para> - <para> Normally these parameters are set in <filename>postgresql.conf</filename> so that they apply to all server processes, but it is possible to turn @@ -3297,63 +3292,6 @@ description | Waiting for a newly initialized WAL file to reach durable storage </para></entry> </row> - <row> - <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>wal_write</structfield> <type>bigint</type> - </para> - <para> - Number of times WAL buffers were written out to disk via - <function>XLogWrite</function> request. - See <xref linkend="wal-configuration"/> for more information about - the internal WAL function <function>XLogWrite</function>. - </para></entry> - </row> - - <row> - <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>wal_sync</structfield> <type>bigint</type> - </para> - <para> - Number of times WAL files were synced to disk via - <function>issue_xlog_fsync</function> request - (if <xref linkend="guc-fsync"/> is <literal>on</literal> and - <xref linkend="guc-wal-sync-method"/> is either - <literal>fdatasync</literal>, <literal>fsync</literal> or - <literal>fsync_writethrough</literal>, otherwise zero). - See <xref linkend="wal-configuration"/> for more information about - the internal WAL function <function>issue_xlog_fsync</function>. - </para></entry> - </row> - - <row> - <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>wal_write_time</structfield> <type>double precision</type> - </para> - <para> - Total amount of time spent writing WAL buffers to disk via - <function>XLogWrite</function> request, in milliseconds - (if <xref linkend="guc-track-wal-io-timing"/> is enabled, - otherwise zero). This includes the sync time when - <varname>wal_sync_method</varname> is either - <literal>open_datasync</literal> or <literal>open_sync</literal>. - </para></entry> - </row> - - <row> - <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>wal_sync_time</structfield> <type>double precision</type> - </para> - <para> - Total amount of time spent syncing WAL files to disk via - <function>issue_xlog_fsync</function> request, in milliseconds - (if <varname>track_wal_io_timing</varname> is enabled, - <varname>fsync</varname> is <literal>on</literal>, and - <varname>wal_sync_method</varname> is either - <literal>fdatasync</literal>, <literal>fsync</literal> or - <literal>fsync_writethrough</literal>, otherwise zero). - </para></entry> - </row> - <row> <entry role="catalog_table_entry"><para role="column_definition"> <structfield>stats_reset</structfield> <type>timestamp with time zone</type> diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml index b908720adea..8f3ac982b0e 100644 --- a/doc/src/sgml/wal.sgml +++ b/doc/src/sgml/wal.sgml @@ -810,11 +810,11 @@ <para> There are two internal functions to write WAL data to disk: <function>XLogWrite</function> and <function>issue_xlog_fsync</function>. - When <xref linkend="guc-track-wal-io-timing"/> is enabled, the total + When <xref linkend="guc-track-io-timing"/> is enabled, the total amounts of time <function>XLogWrite</function> writes and <function>issue_xlog_fsync</function> syncs WAL data to disk are counted as - <literal>wal_write_time</literal> and <literal>wal_sync_time</literal> in - <xref linkend="pg-stat-wal-view"/>, respectively. + <literal>write_time</literal> and <literal>sync_time</literal> in + <xref linkend="pg-stat-io-view"/> for the wal <literal>object</literal>, respectively. <function>XLogWrite</function> is normally called by <function>XLogInsertRecord</function> (when there is no space for the new record in WAL buffers), <function>XLogFlush</function> and the WAL writer, @@ -829,11 +829,11 @@ <literal>fsync</literal>, or <literal>fsync_writethrough</literal>, the write operation moves WAL buffers to kernel cache and <function>issue_xlog_fsync</function> syncs them to disk. Regardless - of the setting of <varname>track_wal_io_timing</varname>, the number + of the setting of <varname>track_io_timing</varname>, the number of times <function>XLogWrite</function> writes and <function>issue_xlog_fsync</function> syncs WAL data to disk are also - counted as <literal>wal_write</literal> and <literal>wal_sync</literal> - in <structname>pg_stat_wal</structname>, respectively. + counted as <literal>writes</literal> and <literal>fsyncs</literal> + in <structname>pg_stat_io</structname> for the wal <literal>object</literal>, respectively. </para> <para> diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c index 25a5c605404..5a1940a42f5 100644 --- a/src/backend/access/transam/xlog.c +++ b/src/backend/access/transam/xlog.c @@ -134,7 +134,6 @@ int CommitSiblings = 5; /* # concurrent xacts needed to sleep */ int wal_retrieve_retry_interval = 5000; int max_slot_wal_keep_size_mb = -1; int wal_decode_buffer_size = 512 * 1024; -bool track_wal_io_timing = false; #ifdef WAL_DEBUG bool XLOG_DEBUG = false; @@ -2436,10 +2435,9 @@ XLogWrite(XLogwrtRqst WriteRqst, TimeLineID tli, bool flexible) errno = 0; /* - * Measure I/O timing to write WAL data, for pg_stat_io and/or - * pg_stat_wal. + * Measure I/O timing to write WAL data, for pg_stat_io. */ - start = pgstat_prepare_io_time(track_io_timing || track_wal_io_timing); + start = pgstat_prepare_io_time(track_io_timing); pgstat_report_wait_start(WAIT_EVENT_WAL_WRITE); written = pg_pwrite(openLogFile, from, nleft, startoffset); @@ -2448,20 +2446,6 @@ XLogWrite(XLogwrtRqst WriteRqst, TimeLineID tli, bool flexible) pgstat_count_io_op_time(IOOBJECT_WAL, IOCONTEXT_NORMAL, IOOP_WRITE, start, 1, written); - /* - * Increment the I/O timing and the number of times WAL data - * were written out to disk. - */ - if (track_wal_io_timing) - { - instr_time end; - - INSTR_TIME_SET_CURRENT(end); - INSTR_TIME_ACCUM_DIFF(PendingWalStats.wal_write_time, end, start); - } - - PendingWalStats.wal_write++; - if (written <= 0) { char xlogfname[MAXFNAMELEN]; @@ -8718,10 +8702,9 @@ issue_xlog_fsync(int fd, XLogSegNo segno, TimeLineID tli) return; /* - * Measure I/O timing to sync the WAL file for pg_stat_io and/or - * pg_stat_wal. + * Measure I/O timing to sync the WAL file for pg_stat_io. */ - start = pgstat_prepare_io_time(track_io_timing || track_wal_io_timing); + start = pgstat_prepare_io_time(track_io_timing); pgstat_report_wait_start(WAIT_EVENT_WAL_SYNC); switch (wal_sync_method) @@ -8767,21 +8750,8 @@ issue_xlog_fsync(int fd, XLogSegNo segno, TimeLineID tli) pgstat_report_wait_end(); - /* - * Increment the I/O timing and the number of times WAL files were synced. - */ - if (track_wal_io_timing) - { - instr_time end; - - INSTR_TIME_SET_CURRENT(end); - INSTR_TIME_ACCUM_DIFF(PendingWalStats.wal_sync_time, end, start); - } - pgstat_count_io_op_time(IOOBJECT_WAL, IOCONTEXT_NORMAL, IOOP_FSYNC, start, 1, 0); - - PendingWalStats.wal_sync++; } /* diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index eff0990957e..a4d2cfdcaf5 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1189,10 +1189,6 @@ CREATE VIEW pg_stat_wal AS w.wal_fpi, w.wal_bytes, w.wal_buffers_full, - w.wal_write, - w.wal_sync, - w.wal_write_time, - w.wal_sync_time, w.stats_reset FROM pg_stat_get_wal() w; diff --git a/src/backend/utils/activity/pgstat_wal.c b/src/backend/utils/activity/pgstat_wal.c index c1ca65eb991..4dc41a4a590 100644 --- a/src/backend/utils/activity/pgstat_wal.c +++ b/src/backend/utils/activity/pgstat_wal.c @@ -21,8 +21,6 @@ #include "utils/pgstat_internal.h" -PgStat_PendingWalStats PendingWalStats = {0}; - /* * WAL usage counters saved from pgWalUsage at the previous call to * pgstat_report_wal(). This is used to calculate how much WAL usage @@ -118,17 +116,10 @@ pgstat_wal_flush_cb(bool nowait) #define WALSTAT_ACC(fld, var_to_add) \ (stats_shmem->stats.fld += var_to_add.fld) -#define WALSTAT_ACC_INSTR_TIME(fld) \ - (stats_shmem->stats.fld += INSTR_TIME_GET_MICROSEC(PendingWalStats.fld)) WALSTAT_ACC(wal_records, wal_usage_diff); WALSTAT_ACC(wal_fpi, wal_usage_diff); WALSTAT_ACC(wal_bytes, wal_usage_diff); WALSTAT_ACC(wal_buffers_full, wal_usage_diff); - WALSTAT_ACC(wal_write, PendingWalStats); - WALSTAT_ACC(wal_sync, PendingWalStats); - WALSTAT_ACC_INSTR_TIME(wal_write_time); - WALSTAT_ACC_INSTR_TIME(wal_sync_time); -#undef WALSTAT_ACC_INSTR_TIME #undef WALSTAT_ACC LWLockRelease(&stats_shmem->lock); @@ -138,11 +129,6 @@ pgstat_wal_flush_cb(bool nowait) */ prevWalUsage = pgWalUsage; - /* - * Clear out the statistics buffer, so it can be re-used. - */ - MemSet(&PendingWalStats, 0, sizeof(PendingWalStats)); - return false; } @@ -158,18 +144,12 @@ pgstat_wal_init_backend_cb(void) } /* - * To determine whether any WAL activity has occurred since last time, not - * only the number of generated WAL records but also the numbers of WAL - * writes and syncs need to be checked. Because even transaction that - * generates no WAL records can write or sync WAL data when flushing the - * data pages. + * To determine whether WAL usage happened. */ bool pgstat_wal_have_pending_cb(void) { - return pgWalUsage.wal_records != prevWalUsage.wal_records || - PendingWalStats.wal_write != 0 || - PendingWalStats.wal_sync != 0; + return pgWalUsage.wal_records != prevWalUsage.wal_records; } void diff --git a/src/backend/utils/adt/pgstatfuncs.c b/src/backend/utils/adt/pgstatfuncs.c index e9096a88492..68e16e52ab6 100644 --- a/src/backend/utils/adt/pgstatfuncs.c +++ b/src/backend/utils/adt/pgstatfuncs.c @@ -1637,7 +1637,7 @@ pg_stat_get_backend_io(PG_FUNCTION_ARGS) Datum pg_stat_get_wal(PG_FUNCTION_ARGS) { -#define PG_STAT_GET_WAL_COLS 9 +#define PG_STAT_GET_WAL_COLS 5 TupleDesc tupdesc; Datum values[PG_STAT_GET_WAL_COLS] = {0}; bool nulls[PG_STAT_GET_WAL_COLS] = {0}; @@ -1654,15 +1654,7 @@ pg_stat_get_wal(PG_FUNCTION_ARGS) NUMERICOID, -1, 0); TupleDescInitEntry(tupdesc, (AttrNumber) 4, "wal_buffers_full", INT8OID, -1, 0); - TupleDescInitEntry(tupdesc, (AttrNumber) 5, "wal_write", - INT8OID, -1, 0); - TupleDescInitEntry(tupdesc, (AttrNumber) 6, "wal_sync", - INT8OID, -1, 0); - TupleDescInitEntry(tupdesc, (AttrNumber) 7, "wal_write_time", - FLOAT8OID, -1, 0); - TupleDescInitEntry(tupdesc, (AttrNumber) 8, "wal_sync_time", - FLOAT8OID, -1, 0); - TupleDescInitEntry(tupdesc, (AttrNumber) 9, "stats_reset", + TupleDescInitEntry(tupdesc, (AttrNumber) 5, "stats_reset", TIMESTAMPTZOID, -1, 0); BlessTupleDesc(tupdesc); @@ -1682,14 +1674,8 @@ pg_stat_get_wal(PG_FUNCTION_ARGS) Int32GetDatum(-1)); values[3] = Int64GetDatum(wal_stats->wal_buffers_full); - values[4] = Int64GetDatum(wal_stats->wal_write); - values[5] = Int64GetDatum(wal_stats->wal_sync); - - /* Convert counters from microsec to millisec for display */ - values[6] = Float8GetDatum(((double) wal_stats->wal_write_time) / 1000.0); - values[7] = Float8GetDatum(((double) wal_stats->wal_sync_time) / 1000.0); - values[8] = TimestampTzGetDatum(wal_stats->stat_reset_timestamp); + values[4] = TimestampTzGetDatum(wal_stats->stat_reset_timestamp); /* Returns the record as Datum */ PG_RETURN_DATUM(HeapTupleGetDatum(heap_form_tuple(tupdesc, values, nulls))); diff --git a/src/backend/utils/misc/guc_tables.c b/src/backend/utils/misc/guc_tables.c index cce73314609..6d4cf7609a7 100644 --- a/src/backend/utils/misc/guc_tables.c +++ b/src/backend/utils/misc/guc_tables.c @@ -1499,15 +1499,6 @@ struct config_bool ConfigureNamesBool[] = false, NULL, NULL, NULL }, - { - {"track_wal_io_timing", PGC_SUSET, STATS_CUMULATIVE, - gettext_noop("Collects timing statistics for WAL I/O activity."), - NULL - }, - &track_wal_io_timing, - false, - NULL, NULL, NULL - }, { {"update_process_title", PGC_SUSET, PROCESS_TITLE, diff --git a/src/backend/utils/misc/postgresql.conf.sample b/src/backend/utils/misc/postgresql.conf.sample index d472987ed46..c64b3e8a0e6 100644 --- a/src/backend/utils/misc/postgresql.conf.sample +++ b/src/backend/utils/misc/postgresql.conf.sample @@ -637,7 +637,6 @@ #track_counts = on #track_cost_delay_timing = off #track_io_timing = off -#track_wal_io_timing = off #track_functions = none # none, pl, all #stats_fetch_consistency = cache # cache, none, snapshot diff --git a/src/include/access/xlog.h b/src/include/access/xlog.h index 4411c1468ac..bd18d95a6cf 100644 --- a/src/include/access/xlog.h +++ b/src/include/access/xlog.h @@ -54,7 +54,6 @@ extern PGDLLIMPORT char *wal_consistency_checking_string; extern PGDLLIMPORT bool log_checkpoints; extern PGDLLIMPORT int CommitDelay; extern PGDLLIMPORT int CommitSiblings; -extern PGDLLIMPORT bool track_wal_io_timing; extern PGDLLIMPORT int wal_decode_buffer_size; extern PGDLLIMPORT int CheckPointSegments; diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 9e803d610d7..1e1626964e3 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -5950,9 +5950,9 @@ { oid => '1136', descr => 'statistics: information about WAL activity', proname => 'pg_stat_get_wal', proisstrict => 'f', provolatile => 's', proparallel => 'r', prorettype => 'record', proargtypes => '', - proallargtypes => '{int8,int8,numeric,int8,int8,int8,float8,float8,timestamptz}', - proargmodes => '{o,o,o,o,o,o,o,o,o}', - proargnames => '{wal_records,wal_fpi,wal_bytes,wal_buffers_full,wal_write,wal_sync,wal_write_time,wal_sync_time,stats_reset}', + proallargtypes => '{int8,int8,numeric,int8,timestamptz}', + proargmodes => '{o,o,o,o,o}', + proargnames => '{wal_records,wal_fpi,wal_bytes,wal_buffers_full,stats_reset}', prosrc => 'pg_stat_get_wal' }, { oid => '6248', descr => 'statistics: information about WAL prefetching', proname => 'pg_stat_get_recovery_prefetch', prorows => '1', proretset => 't', diff --git a/src/include/pgstat.h b/src/include/pgstat.h index 53f2a8458e6..a3a341cc604 100644 --- a/src/include/pgstat.h +++ b/src/include/pgstat.h @@ -480,28 +480,9 @@ typedef struct PgStat_WalStats PgStat_Counter wal_fpi; uint64 wal_bytes; PgStat_Counter wal_buffers_full; - PgStat_Counter wal_write; - PgStat_Counter wal_sync; - PgStat_Counter wal_write_time; - PgStat_Counter wal_sync_time; TimestampTz stat_reset_timestamp; } PgStat_WalStats; -/* - * This struct stores wal-related durations as instr_time, which makes it - * cheaper and easier to accumulate them, by not requiring type - * conversions. During stats flush instr_time will be converted into - * microseconds. - */ -typedef struct PgStat_PendingWalStats -{ - PgStat_Counter wal_write; - PgStat_Counter wal_sync; - instr_time wal_write_time; - instr_time wal_sync_time; -} PgStat_PendingWalStats; - - /* * Functions in pgstat.c */ @@ -834,13 +815,4 @@ extern PGDLLIMPORT PgStat_Counter pgStatTransactionIdleTime; /* updated by the traffic cop and in errfinish() */ extern PGDLLIMPORT SessionEndType pgStatSessionEndCause; - -/* - * Variables in pgstat_wal.c - */ - -/* updated directly by backends and background processes */ -extern PGDLLIMPORT PgStat_PendingWalStats PendingWalStats; - - #endif /* PGSTAT_H */ diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index 5baba8d39ff..62f69ac20b2 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -2259,12 +2259,8 @@ pg_stat_wal| SELECT wal_records, wal_fpi, wal_bytes, wal_buffers_full, - wal_write, - wal_sync, - wal_write_time, - wal_sync_time, stats_reset - FROM pg_stat_get_wal() w(wal_records, wal_fpi, wal_bytes, wal_buffers_full, wal_write, wal_sync, wal_write_time, wal_sync_time, stats_reset); + FROM pg_stat_get_wal() w(wal_records, wal_fpi, wal_bytes, wal_buffers_full, stats_reset); pg_stat_wal_receiver| SELECT pid, status, receive_start_lsn, diff --git a/src/tools/pgindent/typedefs.list b/src/tools/pgindent/typedefs.list index bce4214503d..740777127e9 100644 --- a/src/tools/pgindent/typedefs.list +++ b/src/tools/pgindent/typedefs.list @@ -2163,7 +2163,6 @@ PgStat_KindInfo PgStat_LocalState PgStat_PendingDroppedStatsItem PgStat_PendingIO -PgStat_PendingWalStats PgStat_SLRUStats PgStat_ShmemControl PgStat_Snapshot -- 2.34.1
--cVb/prkuj9W16mit Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="v1-0003-remove-the-pgstat_prepare_io_time-parameter.patch" ^ permalink raw reply [nested|flat] 10+ messages in thread

* [PATCH v2 2/2] Remove wal_[sync|write][_time] from pg_stat_wal and track_wal_io_timing
@ 2025-02-18 07:58  Bertrand Drouvot <bertranddrouvot.pg@gmail.com>
  0 siblings, 0 replies; 10+ messages in thread

From: Bertrand Drouvot @ 2025-02-18 07:58 UTC (permalink / raw)

a051e71e28a added this information into pg_stat_io (with more details and
granularity), so there is no need to keep it in pg_stat_wal. This also
allows to remove PendingWalStats and simplifies up coming commits related
to per backend WAL statistics. Once done, track_wal_io_timing becomes useless
so it is also removed.

In passing remove the pgstat_prepare_io_time() parameter now that
track_wal_io_timing is gone.
---
 doc/src/sgml/config.sgml                      | 22 -------
 doc/src/sgml/monitoring.sgml                  | 62 -------------------
 doc/src/sgml/wal.sgml                         | 12 ++--
 src/backend/access/transam/xlog.c             | 42 ++-----------
 src/backend/access/transam/xlogreader.c       |  2 +-
 src/backend/access/transam/xlogrecovery.c     |  2 +-
 src/backend/catalog/system_views.sql          |  4 --
 src/backend/storage/buffer/bufmgr.c           | 10 +--
 src/backend/storage/buffer/localbuf.c         |  4 +-
 src/backend/storage/smgr/md.c                 |  4 +-
 src/backend/utils/activity/pgstat_io.c        |  7 +--
 src/backend/utils/activity/pgstat_wal.c       | 24 +------
 src/backend/utils/adt/pgstatfuncs.c           | 20 +-----
 src/backend/utils/misc/guc_tables.c           |  9 ---
 src/backend/utils/misc/postgresql.conf.sample |  1 -
 src/include/access/xlog.h                     |  1 -
 src/include/catalog/pg_proc.dat               |  6 +-
 src/include/pgstat.h                          | 30 +--------
 src/test/regress/expected/rules.out           |  6 +-
 src/tools/pgindent/typedefs.list              |  1 -
 20 files changed, 36 insertions(+), 233 deletions(-)
  41.6% doc/src/sgml/
  14.0% src/backend/access/transam/
   6.0% src/backend/storage/buffer/
  11.9% src/backend/utils/activity/
   9.0% src/backend/utils/adt/
   4.6% src/backend/
  10.6% src/include/

inline patch 1: doc/src/sgml/config.sgml, doc/src/sgml/monitoring.sgml, doc/src/sgml/wal.sgml and 17 more (+36/-233 lines) download inline-1.patchdiff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index 9eedcf6f0f4..6d7b15d9f1e 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -8367,28 +8367,6 @@ COPY postgres_log FROM '/full/path/to/logfile.csv' WITH csv; </listitem> </varlistentry> - <varlistentry id="guc-track-wal-io-timing" xreflabel="track_wal_io_timing"> - <term><varname>track_wal_io_timing</varname> (<type>boolean</type>) - <indexterm> - <primary><varname>track_wal_io_timing</varname> configuration parameter</primary> - </indexterm> - </term> - <listitem> - <para> - Enables timing of WAL I/O calls. This parameter is off by default, - as it will repeatedly query the operating system for the current time, - which may cause significant overhead on some platforms. - You can use the <application>pg_test_timing</application> tool to - measure the overhead of timing on your system. - I/O timing information is - displayed in <link linkend="monitoring-pg-stat-wal-view"> - <structname>pg_stat_wal</structname></link>. - Only superusers and users with the appropriate <literal>SET</literal> - privilege can change this setting. - </para> - </listitem> - </varlistentry> - <varlistentry id="guc-track-functions" xreflabel="track_functions"> <term><varname>track_functions</varname> (<type>enum</type>) <indexterm> diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml index 151d69cd0b3..0a0f2a56ea4 100644 --- a/doc/src/sgml/monitoring.sgml +++ b/doc/src/sgml/monitoring.sgml @@ -183,11 +183,6 @@ postgres 27093 0.0 0.0 30096 2752 ? Ss 11:34 0:00 postgres: ser of block read, write, extend, and fsync times. </para> - <para> - The parameter <xref linkend="guc-track-wal-io-timing"/> enables monitoring - of WAL write and fsync times. - </para> - <para> Normally these parameters are set in <filename>postgresql.conf</filename> so that they apply to all server processes, but it is possible to turn @@ -3264,63 +3259,6 @@ description | Waiting for a newly initialized WAL file to reach durable storage </para></entry> </row> - <row> - <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>wal_write</structfield> <type>bigint</type> - </para> - <para> - Number of times WAL buffers were written out to disk via - <function>XLogWrite</function> request. - See <xref linkend="wal-configuration"/> for more information about - the internal WAL function <function>XLogWrite</function>. - </para></entry> - </row> - - <row> - <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>wal_sync</structfield> <type>bigint</type> - </para> - <para> - Number of times WAL files were synced to disk via - <function>issue_xlog_fsync</function> request - (if <xref linkend="guc-fsync"/> is <literal>on</literal> and - <xref linkend="guc-wal-sync-method"/> is either - <literal>fdatasync</literal>, <literal>fsync</literal> or - <literal>fsync_writethrough</literal>, otherwise zero). - See <xref linkend="wal-configuration"/> for more information about - the internal WAL function <function>issue_xlog_fsync</function>. - </para></entry> - </row> - - <row> - <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>wal_write_time</structfield> <type>double precision</type> - </para> - <para> - Total amount of time spent writing WAL buffers to disk via - <function>XLogWrite</function> request, in milliseconds - (if <xref linkend="guc-track-wal-io-timing"/> is enabled, - otherwise zero). This includes the sync time when - <varname>wal_sync_method</varname> is either - <literal>open_datasync</literal> or <literal>open_sync</literal>. - </para></entry> - </row> - - <row> - <entry role="catalog_table_entry"><para role="column_definition"> - <structfield>wal_sync_time</structfield> <type>double precision</type> - </para> - <para> - Total amount of time spent syncing WAL files to disk via - <function>issue_xlog_fsync</function> request, in milliseconds - (if <varname>track_wal_io_timing</varname> is enabled, - <varname>fsync</varname> is <literal>on</literal>, and - <varname>wal_sync_method</varname> is either - <literal>fdatasync</literal>, <literal>fsync</literal> or - <literal>fsync_writethrough</literal>, otherwise zero). - </para></entry> - </row> - <row> <entry role="catalog_table_entry"><para role="column_definition"> <structfield>stats_reset</structfield> <type>timestamp with time zone</type> diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml index b908720adea..8a5ef49c1b5 100644 --- a/doc/src/sgml/wal.sgml +++ b/doc/src/sgml/wal.sgml @@ -810,11 +810,11 @@ <para> There are two internal functions to write WAL data to disk: <function>XLogWrite</function> and <function>issue_xlog_fsync</function>. - When <xref linkend="guc-track-wal-io-timing"/> is enabled, the total + When <xref linkend="guc-track-io-timing"/> is enabled, the total amounts of time <function>XLogWrite</function> writes and <function>issue_xlog_fsync</function> syncs WAL data to disk are counted as - <literal>wal_write_time</literal> and <literal>wal_sync_time</literal> in - <xref linkend="pg-stat-wal-view"/>, respectively. + <literal>write_time</literal> and <literal>sync_time</literal> in + <xref linkend="pg-stat-io-view"/> for the WAL <literal>object</literal>, respectively. <function>XLogWrite</function> is normally called by <function>XLogInsertRecord</function> (when there is no space for the new record in WAL buffers), <function>XLogFlush</function> and the WAL writer, @@ -829,11 +829,11 @@ <literal>fsync</literal>, or <literal>fsync_writethrough</literal>, the write operation moves WAL buffers to kernel cache and <function>issue_xlog_fsync</function> syncs them to disk. Regardless - of the setting of <varname>track_wal_io_timing</varname>, the number + of the setting of <varname>track_io_timing</varname>, the number of times <function>XLogWrite</function> writes and <function>issue_xlog_fsync</function> syncs WAL data to disk are also - counted as <literal>wal_write</literal> and <literal>wal_sync</literal> - in <structname>pg_stat_wal</structname>, respectively. + counted as <literal>writes</literal> and <literal>fsyncs</literal> + in <structname>pg_stat_io</structname> for the WAL <literal>object</literal>, respectively. </para> <para> diff --git a/src/backend/access/transam/xlog.c b/src/backend/access/transam/xlog.c index f9bf5ba7509..f1516664f5f 100644 --- a/src/backend/access/transam/xlog.c +++ b/src/backend/access/transam/xlog.c @@ -134,7 +134,6 @@ int CommitSiblings = 5; /* # concurrent xacts needed to sleep */ int wal_retrieve_retry_interval = 5000; int max_slot_wal_keep_size_mb = -1; int wal_decode_buffer_size = 512 * 1024; -bool track_wal_io_timing = false; #ifdef WAL_DEBUG bool XLOG_DEBUG = false; @@ -2436,10 +2435,9 @@ XLogWrite(XLogwrtRqst WriteRqst, TimeLineID tli, bool flexible) errno = 0; /* - * Measure I/O timing to write WAL data, for pg_stat_io and/or - * pg_stat_wal. + * Measure I/O timing to write WAL data, for pg_stat_io. */ - start = pgstat_prepare_io_time(track_io_timing || track_wal_io_timing); + start = pgstat_prepare_io_time(); pgstat_report_wait_start(WAIT_EVENT_WAL_WRITE); written = pg_pwrite(openLogFile, from, nleft, startoffset); @@ -2448,20 +2446,6 @@ XLogWrite(XLogwrtRqst WriteRqst, TimeLineID tli, bool flexible) pgstat_count_io_op_time(IOOBJECT_WAL, IOCONTEXT_NORMAL, IOOP_WRITE, start, 1, written); - /* - * Increment the I/O timing and the number of times WAL data - * were written out to disk. - */ - if (track_wal_io_timing) - { - instr_time end; - - INSTR_TIME_SET_CURRENT(end); - INSTR_TIME_ACCUM_DIFF(PendingWalStats.wal_write_time, end, start); - } - - PendingWalStats.wal_write++; - if (written <= 0) { char xlogfname[MAXFNAMELEN]; @@ -3264,7 +3248,7 @@ XLogFileInitInternal(XLogSegNo logsegno, TimeLineID logtli, errmsg("could not create file \"%s\": %m", tmppath))); /* Measure I/O timing when initializing segment */ - io_start = pgstat_prepare_io_time(track_io_timing); + io_start = pgstat_prepare_io_time(); pgstat_report_wait_start(WAIT_EVENT_WAL_INIT_WRITE); save_errno = 0; @@ -3326,7 +3310,7 @@ XLogFileInitInternal(XLogSegNo logsegno, TimeLineID logtli, } /* Measure I/O timing when flushing segment */ - io_start = pgstat_prepare_io_time(track_io_timing); + io_start = pgstat_prepare_io_time(); pgstat_report_wait_start(WAIT_EVENT_WAL_INIT_SYNC); if (pg_fsync(fd) != 0) @@ -8718,10 +8702,9 @@ issue_xlog_fsync(int fd, XLogSegNo segno, TimeLineID tli) return; /* - * Measure I/O timing to sync the WAL file for pg_stat_io and/or - * pg_stat_wal. + * Measure I/O timing to sync the WAL file for pg_stat_io. */ - start = pgstat_prepare_io_time(track_io_timing || track_wal_io_timing); + start = pgstat_prepare_io_time(); pgstat_report_wait_start(WAIT_EVENT_WAL_SYNC); switch (wal_sync_method) @@ -8767,21 +8750,8 @@ issue_xlog_fsync(int fd, XLogSegNo segno, TimeLineID tli) pgstat_report_wait_end(); - /* - * Increment the I/O timing and the number of times WAL files were synced. - */ - if (track_wal_io_timing) - { - instr_time end; - - INSTR_TIME_SET_CURRENT(end); - INSTR_TIME_ACCUM_DIFF(PendingWalStats.wal_sync_time, end, start); - } - pgstat_count_io_op_time(IOOBJECT_WAL, IOCONTEXT_NORMAL, IOOP_FSYNC, start, 1, 0); - - PendingWalStats.wal_sync++; } /* diff --git a/src/backend/access/transam/xlogreader.c b/src/backend/access/transam/xlogreader.c index 31bffc6f501..995e4f7c26f 100644 --- a/src/backend/access/transam/xlogreader.c +++ b/src/backend/access/transam/xlogreader.c @@ -1557,7 +1557,7 @@ WALRead(XLogReaderState *state, #ifndef FRONTEND /* Measure I/O timing when reading segment */ - io_start = pgstat_prepare_io_time(track_io_timing); + io_start = pgstat_prepare_io_time(); pgstat_report_wait_start(WAIT_EVENT_WAL_READ); #endif diff --git a/src/backend/access/transam/xlogrecovery.c b/src/backend/access/transam/xlogrecovery.c index 473de6710d7..ac70b73749c 100644 --- a/src/backend/access/transam/xlogrecovery.c +++ b/src/backend/access/transam/xlogrecovery.c @@ -3401,7 +3401,7 @@ retry: readOff = targetPageOff; /* Measure I/O timing when reading segment */ - io_start = pgstat_prepare_io_time(track_io_timing); + io_start = pgstat_prepare_io_time(); pgstat_report_wait_start(WAIT_EVENT_WAL_READ); r = pg_pread(readFile, readBuf, XLOG_BLCKSZ, (off_t) readOff); diff --git a/src/backend/catalog/system_views.sql b/src/backend/catalog/system_views.sql index eff0990957e..a4d2cfdcaf5 100644 --- a/src/backend/catalog/system_views.sql +++ b/src/backend/catalog/system_views.sql @@ -1189,10 +1189,6 @@ CREATE VIEW pg_stat_wal AS w.wal_fpi, w.wal_bytes, w.wal_buffers_full, - w.wal_write, - w.wal_sync, - w.wal_write_time, - w.wal_sync_time, w.stats_reset FROM pg_stat_get_wal() w; diff --git a/src/backend/storage/buffer/bufmgr.c b/src/backend/storage/buffer/bufmgr.c index 75cfc2b6fe9..d3216ef6ba7 100644 --- a/src/backend/storage/buffer/bufmgr.c +++ b/src/backend/storage/buffer/bufmgr.c @@ -1509,7 +1509,7 @@ WaitReadBuffers(ReadBuffersOperation *operation) io_pages[io_buffers_len++] = BufferGetBlock(buffers[i]); } - io_start = pgstat_prepare_io_time(track_io_timing); + io_start = pgstat_prepare_io_time(); smgrreadv(operation->smgr, forknum, io_first_block, io_pages, io_buffers_len); pgstat_count_io_op_time(io_object, io_context, IOOP_READ, io_start, 1, io_buffers_len * BLCKSZ); @@ -2401,7 +2401,7 @@ ExtendBufferedRelShared(BufferManagerRelation bmr, } } - io_start = pgstat_prepare_io_time(track_io_timing); + io_start = pgstat_prepare_io_time(); /* * Note: if smgrzeroextend fails, we will end up with buffers that are @@ -3858,7 +3858,7 @@ FlushBuffer(BufferDesc *buf, SMgrRelation reln, IOObject io_object, */ bufToWrite = PageSetChecksumCopy((Page) bufBlock, buf->tag.blockNum); - io_start = pgstat_prepare_io_time(track_io_timing); + io_start = pgstat_prepare_io_time(); /* * bufToWrite is either the shared buffer or a copy, as appropriate. @@ -4460,7 +4460,7 @@ FlushRelationBuffers(Relation rel) PageSetChecksumInplace(localpage, bufHdr->tag.blockNum); - io_start = pgstat_prepare_io_time(track_io_timing); + io_start = pgstat_prepare_io_time(); smgrwrite(srel, BufTagGetForkNum(&bufHdr->tag), @@ -5917,7 +5917,7 @@ IssuePendingWritebacks(WritebackContext *wb_context, IOContext io_context) sort_pending_writebacks(wb_context->pending_writebacks, wb_context->nr_pending); - io_start = pgstat_prepare_io_time(track_io_timing); + io_start = pgstat_prepare_io_time(); /* * Coalesce neighbouring writes, but nothing else. For that we iterate diff --git a/src/backend/storage/buffer/localbuf.c b/src/backend/storage/buffer/localbuf.c index 64931efaa75..78b65fb160a 100644 --- a/src/backend/storage/buffer/localbuf.c +++ b/src/backend/storage/buffer/localbuf.c @@ -244,7 +244,7 @@ GetLocalVictimBuffer(void) PageSetChecksumInplace(localpage, bufHdr->tag.blockNum); - io_start = pgstat_prepare_io_time(track_io_timing); + io_start = pgstat_prepare_io_time(); /* And write... */ smgrwrite(oreln, @@ -414,7 +414,7 @@ ExtendBufferedRelLocal(BufferManagerRelation bmr, } } - io_start = pgstat_prepare_io_time(track_io_timing); + io_start = pgstat_prepare_io_time(); /* actually extend relation */ smgrzeroextend(bmr.smgr, fork, first_block, extend_by, false); diff --git a/src/backend/storage/smgr/md.c b/src/backend/storage/smgr/md.c index 7bf0b45e2c3..298754d1b64 100644 --- a/src/backend/storage/smgr/md.c +++ b/src/backend/storage/smgr/md.c @@ -1381,7 +1381,7 @@ register_dirty_segment(SMgrRelation reln, ForkNumber forknum, MdfdVec *seg) ereport(DEBUG1, (errmsg_internal("could not forward fsync request because request queue is full"))); - io_start = pgstat_prepare_io_time(track_io_timing); + io_start = pgstat_prepare_io_time(); if (FileSync(seg->mdfd_vfd, WAIT_EVENT_DATA_FILE_SYNC) < 0) ereport(data_sync_elevel(ERROR), @@ -1786,7 +1786,7 @@ mdsyncfiletag(const FileTag *ftag, char *path) need_to_close = true; } - io_start = pgstat_prepare_io_time(track_io_timing); + io_start = pgstat_prepare_io_time(); /* Sync the file. */ result = FileSync(file, WAIT_EVENT_DATA_FILE_SYNC); diff --git a/src/backend/utils/activity/pgstat_io.c b/src/backend/utils/activity/pgstat_io.c index 28a431084b8..e7362b52a37 100644 --- a/src/backend/utils/activity/pgstat_io.c +++ b/src/backend/utils/activity/pgstat_io.c @@ -83,15 +83,14 @@ pgstat_count_io_op(IOObject io_object, IOContext io_context, IOOp io_op, } /* - * Initialize the internal timing for an IO operation, depending on an - * IO timing GUC. + * Initialize the internal timing for an IO operation. */ instr_time -pgstat_prepare_io_time(bool track_io_guc) +pgstat_prepare_io_time(void) { instr_time io_start; - if (track_io_guc) + if (track_io_timing) INSTR_TIME_SET_CURRENT(io_start); else { diff --git a/src/backend/utils/activity/pgstat_wal.c b/src/backend/utils/activity/pgstat_wal.c index c1ca65eb991..4dc41a4a590 100644 --- a/src/backend/utils/activity/pgstat_wal.c +++ b/src/backend/utils/activity/pgstat_wal.c @@ -21,8 +21,6 @@ #include "utils/pgstat_internal.h" -PgStat_PendingWalStats PendingWalStats = {0}; - /* * WAL usage counters saved from pgWalUsage at the previous call to * pgstat_report_wal(). This is used to calculate how much WAL usage @@ -118,17 +116,10 @@ pgstat_wal_flush_cb(bool nowait) #define WALSTAT_ACC(fld, var_to_add) \ (stats_shmem->stats.fld += var_to_add.fld) -#define WALSTAT_ACC_INSTR_TIME(fld) \ - (stats_shmem->stats.fld += INSTR_TIME_GET_MICROSEC(PendingWalStats.fld)) WALSTAT_ACC(wal_records, wal_usage_diff); WALSTAT_ACC(wal_fpi, wal_usage_diff); WALSTAT_ACC(wal_bytes, wal_usage_diff); WALSTAT_ACC(wal_buffers_full, wal_usage_diff); - WALSTAT_ACC(wal_write, PendingWalStats); - WALSTAT_ACC(wal_sync, PendingWalStats); - WALSTAT_ACC_INSTR_TIME(wal_write_time); - WALSTAT_ACC_INSTR_TIME(wal_sync_time); -#undef WALSTAT_ACC_INSTR_TIME #undef WALSTAT_ACC LWLockRelease(&stats_shmem->lock); @@ -138,11 +129,6 @@ pgstat_wal_flush_cb(bool nowait) */ prevWalUsage = pgWalUsage; - /* - * Clear out the statistics buffer, so it can be re-used. - */ - MemSet(&PendingWalStats, 0, sizeof(PendingWalStats)); - return false; } @@ -158,18 +144,12 @@ pgstat_wal_init_backend_cb(void) } /* - * To determine whether any WAL activity has occurred since last time, not - * only the number of generated WAL records but also the numbers of WAL - * writes and syncs need to be checked. Because even transaction that - * generates no WAL records can write or sync WAL data when flushing the - * data pages. + * To determine whether WAL usage happened. */ bool pgstat_wal_have_pending_cb(void) { - return pgWalUsage.wal_records != prevWalUsage.wal_records || - PendingWalStats.wal_write != 0 || - PendingWalStats.wal_sync != 0; + return pgWalUsage.wal_records != prevWalUsage.wal_records; } void diff --git a/src/backend/utils/adt/pgstatfuncs.c b/src/backend/utils/adt/pgstatfuncs.c index e9096a88492..68e16e52ab6 100644 --- a/src/backend/utils/adt/pgstatfuncs.c +++ b/src/backend/utils/adt/pgstatfuncs.c @@ -1637,7 +1637,7 @@ pg_stat_get_backend_io(PG_FUNCTION_ARGS) Datum pg_stat_get_wal(PG_FUNCTION_ARGS) { -#define PG_STAT_GET_WAL_COLS 9 +#define PG_STAT_GET_WAL_COLS 5 TupleDesc tupdesc; Datum values[PG_STAT_GET_WAL_COLS] = {0}; bool nulls[PG_STAT_GET_WAL_COLS] = {0}; @@ -1654,15 +1654,7 @@ pg_stat_get_wal(PG_FUNCTION_ARGS) NUMERICOID, -1, 0); TupleDescInitEntry(tupdesc, (AttrNumber) 4, "wal_buffers_full", INT8OID, -1, 0); - TupleDescInitEntry(tupdesc, (AttrNumber) 5, "wal_write", - INT8OID, -1, 0); - TupleDescInitEntry(tupdesc, (AttrNumber) 6, "wal_sync", - INT8OID, -1, 0); - TupleDescInitEntry(tupdesc, (AttrNumber) 7, "wal_write_time", - FLOAT8OID, -1, 0); - TupleDescInitEntry(tupdesc, (AttrNumber) 8, "wal_sync_time", - FLOAT8OID, -1, 0); - TupleDescInitEntry(tupdesc, (AttrNumber) 9, "stats_reset", + TupleDescInitEntry(tupdesc, (AttrNumber) 5, "stats_reset", TIMESTAMPTZOID, -1, 0); BlessTupleDesc(tupdesc); @@ -1682,14 +1674,8 @@ pg_stat_get_wal(PG_FUNCTION_ARGS) Int32GetDatum(-1)); values[3] = Int64GetDatum(wal_stats->wal_buffers_full); - values[4] = Int64GetDatum(wal_stats->wal_write); - values[5] = Int64GetDatum(wal_stats->wal_sync); - - /* Convert counters from microsec to millisec for display */ - values[6] = Float8GetDatum(((double) wal_stats->wal_write_time) / 1000.0); - values[7] = Float8GetDatum(((double) wal_stats->wal_sync_time) / 1000.0); - values[8] = TimestampTzGetDatum(wal_stats->stat_reset_timestamp); + values[4] = TimestampTzGetDatum(wal_stats->stat_reset_timestamp); /* Returns the record as Datum */ PG_RETURN_DATUM(HeapTupleGetDatum(heap_form_tuple(tupdesc, values, nulls))); diff --git a/src/backend/utils/misc/guc_tables.c b/src/backend/utils/misc/guc_tables.c index 3cde94a1759..e323b75379a 100644 --- a/src/backend/utils/misc/guc_tables.c +++ b/src/backend/utils/misc/guc_tables.c @@ -1499,15 +1499,6 @@ struct config_bool ConfigureNamesBool[] = false, NULL, NULL, NULL }, - { - {"track_wal_io_timing", PGC_SUSET, STATS_CUMULATIVE, - gettext_noop("Collects timing statistics for WAL I/O activity."), - NULL - }, - &track_wal_io_timing, - false, - NULL, NULL, NULL - }, { {"update_process_title", PGC_SUSET, PROCESS_TITLE, diff --git a/src/backend/utils/misc/postgresql.conf.sample b/src/backend/utils/misc/postgresql.conf.sample index 415f253096c..bd03540bcef 100644 --- a/src/backend/utils/misc/postgresql.conf.sample +++ b/src/backend/utils/misc/postgresql.conf.sample @@ -638,7 +638,6 @@ #track_counts = on #track_cost_delay_timing = off #track_io_timing = off -#track_wal_io_timing = off #track_functions = none # none, pl, all #stats_fetch_consistency = cache # cache, none, snapshot diff --git a/src/include/access/xlog.h b/src/include/access/xlog.h index 4411c1468ac..bd18d95a6cf 100644 --- a/src/include/access/xlog.h +++ b/src/include/access/xlog.h @@ -54,7 +54,6 @@ extern PGDLLIMPORT char *wal_consistency_checking_string; extern PGDLLIMPORT bool log_checkpoints; extern PGDLLIMPORT int CommitDelay; extern PGDLLIMPORT int CommitSiblings; -extern PGDLLIMPORT bool track_wal_io_timing; extern PGDLLIMPORT int wal_decode_buffer_size; extern PGDLLIMPORT int CheckPointSegments; diff --git a/src/include/catalog/pg_proc.dat b/src/include/catalog/pg_proc.dat index 9e803d610d7..1e1626964e3 100644 --- a/src/include/catalog/pg_proc.dat +++ b/src/include/catalog/pg_proc.dat @@ -5950,9 +5950,9 @@ { oid => '1136', descr => 'statistics: information about WAL activity', proname => 'pg_stat_get_wal', proisstrict => 'f', provolatile => 's', proparallel => 'r', prorettype => 'record', proargtypes => '', - proallargtypes => '{int8,int8,numeric,int8,int8,int8,float8,float8,timestamptz}', - proargmodes => '{o,o,o,o,o,o,o,o,o}', - proargnames => '{wal_records,wal_fpi,wal_bytes,wal_buffers_full,wal_write,wal_sync,wal_write_time,wal_sync_time,stats_reset}', + proallargtypes => '{int8,int8,numeric,int8,timestamptz}', + proargmodes => '{o,o,o,o,o}', + proargnames => '{wal_records,wal_fpi,wal_bytes,wal_buffers_full,stats_reset}', prosrc => 'pg_stat_get_wal' }, { oid => '6248', descr => 'statistics: information about WAL prefetching', proname => 'pg_stat_get_recovery_prefetch', prorows => '1', proretset => 't', diff --git a/src/include/pgstat.h b/src/include/pgstat.h index 53f2a8458e6..030b101028f 100644 --- a/src/include/pgstat.h +++ b/src/include/pgstat.h @@ -480,28 +480,9 @@ typedef struct PgStat_WalStats PgStat_Counter wal_fpi; uint64 wal_bytes; PgStat_Counter wal_buffers_full; - PgStat_Counter wal_write; - PgStat_Counter wal_sync; - PgStat_Counter wal_write_time; - PgStat_Counter wal_sync_time; TimestampTz stat_reset_timestamp; } PgStat_WalStats; -/* - * This struct stores wal-related durations as instr_time, which makes it - * cheaper and easier to accumulate them, by not requiring type - * conversions. During stats flush instr_time will be converted into - * microseconds. - */ -typedef struct PgStat_PendingWalStats -{ - PgStat_Counter wal_write; - PgStat_Counter wal_sync; - instr_time wal_write_time; - instr_time wal_sync_time; -} PgStat_PendingWalStats; - - /* * Functions in pgstat.c */ @@ -583,7 +564,7 @@ extern bool pgstat_bktype_io_stats_valid(PgStat_BktypeIO *backend_io, BackendType bktype); extern void pgstat_count_io_op(IOObject io_object, IOContext io_context, IOOp io_op, uint32 cnt, uint64 bytes); -extern instr_time pgstat_prepare_io_time(bool track_io_guc); +extern instr_time pgstat_prepare_io_time(void); extern void pgstat_count_io_op_time(IOObject io_object, IOContext io_context, IOOp io_op, instr_time start_time, uint32 cnt, uint64 bytes); @@ -834,13 +815,4 @@ extern PGDLLIMPORT PgStat_Counter pgStatTransactionIdleTime; /* updated by the traffic cop and in errfinish() */ extern PGDLLIMPORT SessionEndType pgStatSessionEndCause; - -/* - * Variables in pgstat_wal.c - */ - -/* updated directly by backends and background processes */ -extern PGDLLIMPORT PgStat_PendingWalStats PendingWalStats; - - #endif /* PGSTAT_H */ diff --git a/src/test/regress/expected/rules.out b/src/test/regress/expected/rules.out index 5baba8d39ff..62f69ac20b2 100644 --- a/src/test/regress/expected/rules.out +++ b/src/test/regress/expected/rules.out @@ -2259,12 +2259,8 @@ pg_stat_wal| SELECT wal_records, wal_fpi, wal_bytes, wal_buffers_full, - wal_write, - wal_sync, - wal_write_time, - wal_sync_time, stats_reset - FROM pg_stat_get_wal() w(wal_records, wal_fpi, wal_bytes, wal_buffers_full, wal_write, wal_sync, wal_write_time, wal_sync_time, stats_reset); + FROM pg_stat_get_wal() w(wal_records, wal_fpi, wal_bytes, wal_buffers_full, stats_reset); pg_stat_wal_receiver| SELECT pid, status, receive_start_lsn, diff --git a/src/tools/pgindent/typedefs.list b/src/tools/pgindent/typedefs.list index 64c6bf7a891..c86156d4718 100644 --- a/src/tools/pgindent/typedefs.list +++ b/src/tools/pgindent/typedefs.list @@ -2164,7 +2164,6 @@ PgStat_KindInfo PgStat_LocalState PgStat_PendingDroppedStatsItem PgStat_PendingIO -PgStat_PendingWalStats PgStat_SLRUStats PgStat_ShmemControl PgStat_Snapshot -- 2.34.1
--jGJx/gZCINp6OCld-- ^ permalink raw reply [nested|flat] 10+ messages in thread

* COPY TO: provide hint when WHERE clause is used
@ 2025-08-19 01:35  torikoshia <torikoshia@oss.nttdata.com>
  0 siblings, 1 reply; 10+ messages in thread

From: torikoshia @ 2025-08-19 01:35 UTC (permalink / raw)
  To: pgsql-hackers@lists.postgresql.org

Hi,

I saw a user wanted to restrict the rows copied by COPY TO using a WHERE 
clause, but ran into an error.

As you know, COPY FROM supports WHERE, but COPY TO does not:

   =# copy t1 to stdout where i > 5;
   ERROR:  WHERE clause not allowed with COPY TO
   LINE 1: copy t1 to stdout where i > 5;
                           ^

In such cases, we can do with specifying a query as the target of COPY:

   =# copy (select i from t1 where i > 5) to stdout;

However, as shown in the first example, no hint is provided in the error 
message.

For views or others, COPY TO already provides a helpful hint message:

   =# copy v1 to stdout;
   ERROR:  cannot copy from view "v1"
   HINT:  Try the COPY (SELECT ...) TO variant.

Considering what the user was trying to do, it might be helpful to 
provide a similar hint in this case as well.
I’ve attached a patch that adds such a hint.

What do you think?


-- 
Regards,

--
Atsushi Torikoshi
Seconded from NTT DATA Japan Corporation to SRA OSS K.K.

Attachments:

v1-0001-provide_hint_when_WHERE_is_used.patch (text/x-diff, 945B) download From d1b4e23a1b24782e9de16d748508c46354e42423 Mon Sep 17 00:00:00 2001 From: Atsushi Torikoshi <torikoshia@oss.nttdata.com> Date: Sun, 3 Aug 2025 17:55:09 +0900 Subject: [PATCH v1] COPY TO: provide hint when WHERE clause is used Provide a hint suggesting COPY query TO when a WHERE clause is specified, similar to the hint already given for views or others. --- src/backend/parser/gram.y | 1 + 1 file changed, 1 insertion(+) diff --git a/src/backend/parser/gram.y b/src/backend/parser/gram.y index db43034b9db..9fd48acb1f8 100644 --- a/src/backend/parser/gram.y +++ b/src/backend/parser/gram.y @@ -3442,6 +3442,7 @@ CopyStmt: COPY opt_binary qualified_name opt_column_list ereport(ERROR, (errcode(ERRCODE_SYNTAX_ERROR), errmsg("WHERE clause not allowed with COPY TO"), + errhint("Try the COPY (SELECT ... WHERE ...) TO variant."), parser_errposition(@11))); n->options = NIL; -- 2.48.1
^ permalink raw reply [nested|flat] 10+ messages in thread

* Re: COPY TO: provide hint when WHERE clause is used
@ 2025-08-30 18:14  Jim Jones <jim.jones@uni-muenster.de>
  parent: torikoshia <torikoshia@oss.nttdata.com>
  0 siblings, 1 reply; 10+ messages in thread

From: Jim Jones @ 2025-08-30 18:14 UTC (permalink / raw)
  To: torikoshia <torikoshia@oss.nttdata.com>; pgsql-hackers@lists.postgresql.org

Hi

On 19.08.25 03:35, torikoshia wrote:
> Considering what the user was trying to do, it might be helpful to
> provide a similar hint in this case as well.
> I’ve attached a patch that adds such a hint.
>
> What do you think?
>

+1

I tested the patch and the error message now has the intended HINT ...

postgres=# COPY t1 TO STDOUT WHERE i > 5;
ERROR:  WHERE clause not allowed with COPY TO
LINE 1: COPY t1 TO STDOUT WHERE i > 5;
                          ^
HINT:  Try the COPY (SELECT ... WHERE ...) TO variant.

... which aligns with the HINT from COPY TO from views

postgres=# COPY v1 TO STDOUT;
ERROR:  cannot copy from view "v1"
HINT:  Try the COPY (SELECT ...) TO variant.

Best, Jim





^ permalink  raw  reply  [nested|flat] 10+ messages in thread

* Re: COPY TO: provide hint when WHERE clause is used
@ 2025-08-31 22:58  Atsushi Torikoshi <torikoshia.tech@gmail.com>
  parent: Jim Jones <jim.jones@uni-muenster.de>
  0 siblings, 1 reply; 10+ messages in thread

From: Atsushi Torikoshi @ 2025-08-31 22:58 UTC (permalink / raw)
  To: Jim Jones <jim.jones@uni-muenster.de>; +Cc: torikoshia <torikoshia@oss.nttdata.com>; pgsql-hackers@lists.postgresql.org

On Sun, Aug 31, 2025 at 3:14 AM Jim Jones <jim.jones@uni-muenster.de> wrote:
>
> Hi
>
> On 19.08.25 03:35, torikoshia wrote:
> > Considering what the user was trying to do, it might be helpful to
> > provide a similar hint in this case as well.
> > I’ve attached a patch that adds such a hint.
> >
> > What do you think?
> >
>
> +1
>
> I tested the patch and the error message now has the intended HINT ...
>
> postgres=# COPY t1 TO STDOUT WHERE i > 5;
> ERROR:  WHERE clause not allowed with COPY TO
> LINE 1: COPY t1 TO STDOUT WHERE i > 5;
>                           ^
> HINT:  Try the COPY (SELECT ... WHERE ...) TO variant.
>
> ... which aligns with the HINT from COPY TO from views
>
> postgres=# COPY v1 TO STDOUT;
> ERROR:  cannot copy from view "v1"
> HINT:  Try the COPY (SELECT ...) TO variant.

Thanks for your review!

Updated the patch to pass regression tests.

Attachments:

v2-0001-COPY-TO-provide-hint-when-WHERE-clause-is-used.patch (application/x-patch, 1.5K) download From 90cbddde61c4028a44654005a4e417c74e303d16 Mon Sep 17 00:00:00 2001 From: Atsushi Torikoshi <torikoshia@oss.nttdata.com> Date: Mon, 1 Sep 2025 07:35:12 +0900 Subject: [PATCH v2] COPY TO: provide hint when WHERE clause is used Provide a hint suggesting COPY TO when a WHERE clause is specified, similar to the hint already given for views or others. --- src/backend/parser/gram.y | 1 + src/test/regress/expected/copy2.out | 1 + 2 files changed, 2 insertions(+) diff --git a/src/backend/parser/gram.y b/src/backend/parser/gram.y index db43034b9db..9fd48acb1f8 100644 --- a/src/backend/parser/gram.y +++ b/src/backend/parser/gram.y @@ -3442,6 +3442,7 @@ CopyStmt: COPY opt_binary qualified_name opt_column_list ereport(ERROR, (errcode(ERRCODE_SYNTAX_ERROR), errmsg("WHERE clause not allowed with COPY TO"), + errhint("Try the COPY (SELECT ... WHERE ...) TO variant."), parser_errposition(@11))); n->options = NIL; diff --git a/src/test/regress/expected/copy2.out b/src/test/regress/expected/copy2.out index caa3c44f0d0..f3fdce23459 100644 --- a/src/test/regress/expected/copy2.out +++ b/src/test/regress/expected/copy2.out @@ -163,6 +163,7 @@ COPY x TO stdout WHERE a = 1; ERROR: WHERE clause not allowed with COPY TO LINE 1: COPY x TO stdout WHERE a = 1; ^ +HINT: Try the COPY (SELECT ... WHERE ...) TO variant. COPY x from stdin WHERE a = 50004; COPY x from stdin WHERE a > 60003; COPY x from stdin WHERE f > 60003; -- 2.48.1
^ permalink raw reply [nested|flat] 10+ messages in thread

* Re: COPY TO: provide hint when WHERE clause is used
@ 2025-09-01 09:09  Fujii Masao <masao.fujii@gmail.com>
  parent: Atsushi Torikoshi <torikoshia.tech@gmail.com>
  0 siblings, 1 reply; 10+ messages in thread

From: Fujii Masao @ 2025-09-01 09:09 UTC (permalink / raw)
  To: Atsushi Torikoshi <torikoshia.tech@gmail.com>; +Cc: Jim Jones <jim.jones@uni-muenster.de>; torikoshia <torikoshia@oss.nttdata.com>; pgsql-hackers@lists.postgresql.org

On Mon, Sep 1, 2025 at 7:58 AM Atsushi Torikoshi
<torikoshia.tech@gmail.com> wrote:
>
>
>
> On Sun, Aug 31, 2025 at 3:14 AM Jim Jones <jim.jones@uni-muenster.de> wrote:
> >
> > Hi
> >
> > On 19.08.25 03:35, torikoshia wrote:
> > > Considering what the user was trying to do, it might be helpful to
> > > provide a similar hint in this case as well.
> > > I’ve attached a patch that adds such a hint.
> > >
> > > What do you think?
> > >
> >
> > +1

+1


> > I tested the patch and the error message now has the intended HINT ...
> >
> > postgres=# COPY t1 TO STDOUT WHERE i > 5;
> > ERROR:  WHERE clause not allowed with COPY TO
> > LINE 1: COPY t1 TO STDOUT WHERE i > 5;
> >                           ^
> > HINT:  Try the COPY (SELECT ... WHERE ...) TO variant.
> >
> > ... which aligns with the HINT from COPY TO from views
> >
> > postgres=# COPY v1 TO STDOUT;
> > ERROR:  cannot copy from view "v1"
> > HINT:  Try the COPY (SELECT ...) TO variant.
>
> Thanks for your review!
>
> Updated the patch to pass regression tests.

The patch looks good to me. Barring any objections, I'm thinking to
commit the patch.

Regards,

-- 
Fujii Masao





^ permalink  raw  reply  [nested|flat] 10+ messages in thread

* Re: COPY TO: provide hint when WHERE clause is used
@ 2025-09-01 10:12  Jim Jones <jim.jones@uni-muenster.de>
  parent: Fujii Masao <masao.fujii@gmail.com>
  0 siblings, 1 reply; 10+ messages in thread

From: Jim Jones @ 2025-09-01 10:12 UTC (permalink / raw)
  To: Fujii Masao <masao.fujii@gmail.com>; Atsushi Torikoshi <torikoshia.tech@gmail.com>; +Cc: torikoshia <torikoshia@oss.nttdata.com>; pgsql-hackers@lists.postgresql.org



On 01.09.25 11:09, Fujii Masao wrote:
> The patch looks good to me. Barring any objections, I'm thinking to
> commit the patch.

LGTM.

The HINT was added to copy2's test output and check-world passes.

Thanks!

Best, Jim





^ permalink  raw  reply  [nested|flat] 10+ messages in thread

* Re: COPY TO: provide hint when WHERE clause is used
@ 2025-09-02 23:38  Fujii Masao <masao.fujii@gmail.com>
  parent: Jim Jones <jim.jones@uni-muenster.de>
  0 siblings, 1 reply; 10+ messages in thread

From: Fujii Masao @ 2025-09-02 23:38 UTC (permalink / raw)
  To: Jim Jones <jim.jones@uni-muenster.de>; +Cc: Atsushi Torikoshi <torikoshia.tech@gmail.com>; torikoshia <torikoshia@oss.nttdata.com>; pgsql-hackers@lists.postgresql.org

On Mon, Sep 1, 2025 at 7:12 PM Jim Jones <jim.jones@uni-muenster.de> wrote:
>
>
>
> On 01.09.25 11:09, Fujii Masao wrote:
> > The patch looks good to me. Barring any objections, I'm thinking to
> > commit the patch.
>
> LGTM.

I've pushed the patch. Thanks!

Regards,

-- 
Fujii Masao





^ permalink  raw  reply  [nested|flat] 10+ messages in thread

* Re: COPY TO: provide hint when WHERE clause is used
@ 2025-09-03 00:08  torikoshia <torikoshia@oss.nttdata.com>
  parent: Fujii Masao <masao.fujii@gmail.com>
  0 siblings, 0 replies; 10+ messages in thread

From: torikoshia @ 2025-09-03 00:08 UTC (permalink / raw)
  To: Fujii Masao <masao.fujii@gmail.com>; +Cc: Jim Jones <jim.jones@uni-muenster.de>; Atsushi Torikoshi <torikoshia.tech@gmail.com>; pgsql-hackers@lists.postgresql.org

On 2025-09-03 08:38, Fujii Masao wrote:
> On Mon, Sep 1, 2025 at 7:12 PM Jim Jones <jim.jones@uni-muenster.de> 
> wrote:
>> 
>> 
>> 
>> On 01.09.25 11:09, Fujii Masao wrote:
>> > The patch looks good to me. Barring any objections, I'm thinking to
>> > commit the patch.
>> 
>> LGTM.
> 
> I've pushed the patch. Thanks!

Thank you!

-- 
Regards,

--
Atsushi Torikoshi
Seconded from NTT DATA Japan Corporation to SRA OSS K.K.





^ permalink  raw  reply  [nested|flat] 10+ messages in thread


end of thread, other threads:[~2025-09-03 00:08 UTC | newest]

Thread overview: 10+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2025-02-17 07:17 [PATCH v7 1/4] Remove wal_[sync|write][_time] from pg_stat_wal Bertrand Drouvot <bertranddrouvot.pg@gmail.com>
2025-02-18 07:58 [PATCH v1 2/3] Remove wal_[sync|write][_time] from pg_stat_wal and track_wal_io_timing Bertrand Drouvot <bertranddrouvot.pg@gmail.com>
2025-02-18 07:58 [PATCH v2 2/2] Remove wal_[sync|write][_time] from pg_stat_wal and track_wal_io_timing Bertrand Drouvot <bertranddrouvot.pg@gmail.com>
2025-08-19 01:35 COPY TO: provide hint when WHERE clause is used torikoshia <torikoshia@oss.nttdata.com>
2025-08-30 18:14 ` Re: COPY TO: provide hint when WHERE clause is used Jim Jones <jim.jones@uni-muenster.de>
2025-08-31 22:58   ` Re: COPY TO: provide hint when WHERE clause is used Atsushi Torikoshi <torikoshia.tech@gmail.com>
2025-09-01 09:09     ` Re: COPY TO: provide hint when WHERE clause is used Fujii Masao <masao.fujii@gmail.com>
2025-09-01 10:12       ` Re: COPY TO: provide hint when WHERE clause is used Jim Jones <jim.jones@uni-muenster.de>
2025-09-02 23:38         ` Re: COPY TO: provide hint when WHERE clause is used Fujii Masao <masao.fujii@gmail.com>
2025-09-03 00:08           ` Re: COPY TO: provide hint when WHERE clause is used torikoshia <torikoshia@oss.nttdata.com>

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox