From 4134c047c63f2b6acc3fe119f7fbd3d66c085bea Mon Sep 17 00:00:00 2001 From: Alena Rybakina Date: Sun, 25 Aug 2024 17:47:55 +0300 Subject: [PATCH] Add documentation about the system views that are used in the machinery of vacuum statistics. --- doc/src/sgml/system-views.sgml | 747 ++++++++++++++++++ .../vacuum-extending-in-repetable-read.out | 6 +- .../vacuum-extending-in-repetable-read.spec | 4 +- 3 files changed, 752 insertions(+), 5 deletions(-) diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml index 61d28e701f2..b74c53bb000 100644 --- a/doc/src/sgml/system-views.sgml +++ b/doc/src/sgml/system-views.sgml @@ -5064,4 +5064,751 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx + + <structname>pg_stat_get_vacuum_database</structname> + + + pg_stat_get_vacuum_database + + + + The view pg_stat_get_vacuum_database will contain + one row for each database in the current cluster, showing statistics about + vacuuming that database. + + + + <structname>pg_stat_get_vacuum_database</structname> Columns + + + + + Column Type + + + Description + + + + + + + + dbid oid + + + OID of a database + + + + + + total_blks_read int8 + + + Number of database blocks read by vacuum operations + performed on this database + + + + + + total_blks_hit int8 + + + Number of times database blocks were found in the + buffer cache by vacuum operations + performed on this database + + + + + + total_blks_dirtied int8 + + + Number of database blocks dirtied by vacuum operations + performed on this database + + + + + + total_blks_written int8 + + + Number of database blocks written by vacuum operations + performed on this database + + + + + + wal_records int8 + + + Total number of WAL records generated by vacuum operations + performed on this database + + + + + + wal_fpi int8 + + + Total number of WAL full page images generated by vacuum operations + performed on this database + + + + + + wal_bytes numeric + + + Total amount of WAL bytes generated by vacuum operations + performed on this database + + + + + + blk_read_time float8 + + + Time spent reading database blocks by vacuum operations performed on + this database, in milliseconds (if is enabled, + otherwise zero) + + + + + + blk_write_time float8 + + + Time spent writing database blocks by vacuum operations performed on + this database, in milliseconds (if is enabled, + otherwise zero) + + + + + + delay_time float8 + + + Time spent sleeping in a vacuum delay point by vacuum operations performed on + this database, in milliseconds (see + for details) + + + + + + system_time float8 + + + System CPU time of vacuuming this database, in milliseconds + + + + + + user_time float8 + + + User CPU time of vacuuming this database, in milliseconds + + + + + + total_time float8 + + + Total time of vacuuming this database, in milliseconds + + + + + + interrupts int4 + + + Number of times vacuum operations performed on this database + were interrupted on any errors + + + + +
+ + + + <structname>pg_stat_get_vacuum_indexes</structname> + + + pg_stat_get_vacuum_indexes + + + + The view pg_stat_get_vacuum_indexes will contain + one row for each index in the current database (including TOAST + table indexes), showing statistics about vacuuming that specific index. + + + + <structname>pg_stat_get_vacuum_indexes</structname> Columns + + + + + Column Type + + + Description + + + + + + + + relid oid + + + OID of an index + + + + + + schema name + + + Name of the schema this index is in + + + + + + relname name + + + Name of this index + + + + + + total_blks_read int8 + + + Number of database blocks read by vacuum operations + performed on this index + + + + + + total_blks_hit int8 + + + Number of times database blocks were found in the + buffer cache by vacuum operations + performed on this index + + + + + + total_blks_dirtied int8 + + + Number of database blocks dirtied by vacuum operations + performed on this index + + + + + + total_blks_written int8 + + + Number of database blocks written by vacuum operations + performed on this index + + + + + + rel_blks_read int8 + + + Number of blocks vacuum operations read from this + index + + + + + + rel_blks_hit int8 + + + Number of times blocks of this index were already found + in the buffer cache by vacuum operations, so that a read was not necessary + (this only includes hits in the + project; buffer cache, not the operating system's file system cache) + + + + + + pages_deleted int8 + + + Number of pages deleted by vacuum operations + performed on this index + + + + + + tuples_deleted int8 + + + Number of dead tuples vacuum operations deleted from this index + + + + + + wal_records int8 + + + Total number of WAL records generated by vacuum operations + performed on this index + + + + + + wal_fpi int8 + + + Total number of WAL full page images generated by vacuum operations + performed on this index + + + + + + wal_bytes numeric + + + Total amount of WAL bytes generated by vacuum operations + performed on this index + + + + + + blk_read_time int8 + + + Time spent reading database blocks by vacuum operations performed on + this index, in milliseconds (if is enabled, + otherwise zero) + + + + + + blk_write_time int8 + + + Time spent writing database blocks by vacuum operations performed on + this index, in milliseconds (if is enabled, + otherwise zero) + + + + + + delay_time float8 + + + Time spent sleeping in a vacuum delay point by vacuum operations performed on + this index, in milliseconds (see + for details) + + + + + + system_time float8 + + + System CPU time of vacuuming this index, in milliseconds + + + + + + user_time float8 + + + User CPU time of vacuuming this index, in milliseconds + + + + + + total_time float8 + + + Total time of vacuuming this index, in milliseconds + + + + + + interrupts float8 + + + Number of times vacuum operations performed on this index + were interrupted on any errors + + + + +
+ + + + <structname>pg_stat_get_vacuum_tables</structname> + + + pg_stat_get_vacuum_tables + + + + The view pg_stat_get_vacuum_tables will contain + one row for each table in the current database (including TOAST + tables), showing statistics about vacuuming that specific table. + + + + <structname>pg_stat_get_vacuum_tables</structname> Columns + + + + + Column Type + + + Description + + + + + + + + relid oid + + + OID of a table + + + + + + schema name + + + Name of the schema this table is in + + + + + + relname name + + + Name of this table + + + + + + total_blks_read int8 + + + Number of database blocks read by vacuum operations + performed on this table + + + + + + total_blks_hit int8 + + + Number of times database blocks were found in the + buffer cache by vacuum operations + performed on this table + + + + + + total_blks_dirtied int8 + + + Number of database blocks dirtied by vacuum operations + performed on this table + + + + + + total_blks_written int8 + + + Number of database blocks written by vacuum operations + performed on this table + + + + + + rel_blks_read int8 + + + Number of blocks vacuum operations read from this + table + + + + + + rel_blks_hit int8 + + + Number of times blocks of this table were already found + in the buffer cache by vacuum operations, so that a read was not necessary + (this only includes hits in the + project; buffer cache, not the operating system's file system cache) + + + + + + pages_scanned int8 + + + Number of pages examined by vacuum operations + performed on this table + + + + + + pages_removed int8 + + + Number of pages removed from the physical storage by vacuum operations + performed on this table + + + + + + pages_frozen int8 + + + Number of times vacuum operations marked pages of this table + as all-frozen in the visibility map + + + + + + pages_all_visible int8 + + + Number of times vacuum operations marked pages of this table + as all-visible in the visibility map + + + + + + tuples_deleted int8 + + + Number of dead tuples vacuum operations deleted from this table + + + + + + tuples_frozen int8 + + + Number of tuples of this table that vacuum operations marked as + frozen + + + + + + dead_tuples int8 + + + Number of dead tuples vacuum operations left in this table due + to their visibility in transactions + + + + + + index_vacuum_count int8 + + + Number of times indexes on this table were vacuumed + + + + + + rev_all_frozen_pages int8 + + + Number of times the all-frozen mark in the visibility map + was removed for pages of this table + + + + + + rev_all_visible_pages int8 + + + Number of times the all-visible mark in the visibility map + was removed for pages of this table + + + + + + wal_records int8 + + + Total number of WAL records generated by vacuum operations + performed on this table + + + + + + wal_fpi int8 + + + Total number of WAL full page images generated by vacuum operations + performed on this table + + + + + + wal_bytes numeric + + + Total amount of WAL bytes generated by vacuum operations + performed on this table + + + + + + blk_read_time int8 + + + Time spent reading database blocks by vacuum operations performed on + this table, in milliseconds (if is enabled, + otherwise zero) + + + + + + blk_write_time int8 + + + Time spent writing database blocks by vacuum operations performed on + this table, in milliseconds (if is enabled, + otherwise zero) + + + + + + delay_time float8 + + + Time spent sleeping in a vacuum delay point by vacuum operations performed on + this table, in milliseconds (see + for details) + + + + + + system_time float8 + + + System CPU time of vacuuming this table, in milliseconds + + + + + + user_time float8 + + + User CPU time of vacuuming this table, in milliseconds + + + + + + total_time float8 + + + Total time of vacuuming this table, in milliseconds + + + + + + interrupts float8 + + + Number of times vacuum operations performed on this table + were interrupted on any errors + + + + +
+ Columns total_*, wal_* + and blk_* include data on vacuuming indexes on this table, while columns + system_time and user_time only include data + on vacuuming the heap. + + diff --git a/src/test/isolation/expected/vacuum-extending-in-repetable-read.out b/src/test/isolation/expected/vacuum-extending-in-repetable-read.out index 93fe15c01f9..a7794023508 100644 --- a/src/test/isolation/expected/vacuum-extending-in-repetable-read.out +++ b/src/test/isolation/expected/vacuum-extending-in-repetable-read.out @@ -6,7 +6,7 @@ step s2_insert: INSERT INTO test_vacuum_stat_isolation(id, ival) SELECT ival, iv step s2_print_vacuum_stats_table: SELECT vt.relname, vt.tuples_deleted, vt.dead_tuples, vt.tuples_frozen - FROM pg_stat_vacuum_tables vt, pg_class c + FROM pg_stat_get_vacuum_tables vt, pg_class c WHERE vt.relname = 'test_vacuum_stat_isolation' AND vt.relid = c.oid; relname|tuples_deleted|dead_tuples|tuples_frozen @@ -28,7 +28,7 @@ step s2_vacuum: VACUUM test_vacuum_stat_isolation; step s2_print_vacuum_stats_table: SELECT vt.relname, vt.tuples_deleted, vt.dead_tuples, vt.tuples_frozen - FROM pg_stat_vacuum_tables vt, pg_class c + FROM pg_stat_get_vacuum_tables vt, pg_class c WHERE vt.relname = 'test_vacuum_stat_isolation' AND vt.relid = c.oid; relname |tuples_deleted|dead_tuples|tuples_frozen @@ -42,7 +42,7 @@ step s2_vacuum: VACUUM test_vacuum_stat_isolation; step s2_print_vacuum_stats_table: SELECT vt.relname, vt.tuples_deleted, vt.dead_tuples, vt.tuples_frozen - FROM pg_stat_vacuum_tables vt, pg_class c + FROM pg_stat_get_vacuum_tables vt, pg_class c WHERE vt.relname = 'test_vacuum_stat_isolation' AND vt.relid = c.oid; relname |tuples_deleted|dead_tuples|tuples_frozen diff --git a/src/test/isolation/specs/vacuum-extending-in-repetable-read.spec b/src/test/isolation/specs/vacuum-extending-in-repetable-read.spec index 5facb2c862c..6e33df46480 100644 --- a/src/test/isolation/specs/vacuum-extending-in-repetable-read.spec +++ b/src/test/isolation/specs/vacuum-extending-in-repetable-read.spec @@ -1,4 +1,4 @@ -# Test for checking dead_tuples, tuples_deleted and frozen tuples in pg_stat_vacuum_tables. +# Test for checking dead_tuples, tuples_deleted and frozen tuples in pg_stat_get_vacuum_tables. # Dead_tuples values are counted when vacuum cannot clean up unused tuples while lock is using another transaction. # Dead_tuples aren't increased after releasing lock compared with tuples_deleted, which increased # by the value of the cleared tuples that the vacuum managed to clear. @@ -33,7 +33,7 @@ step s2_print_vacuum_stats_table { SELECT vt.relname, vt.tuples_deleted, vt.dead_tuples, vt.tuples_frozen - FROM pg_stat_vacuum_tables vt, pg_class c + FROM pg_stat_get_vacuum_tables vt, pg_class c WHERE vt.relname = 'test_vacuum_stat_isolation' AND vt.relid = c.oid; } -- 2.34.1