Remove the tuples returned/s metric from the header (#447)

blogh · web-flow · commit 7f2274de4629 · 2025-10-27T16:56:25.000+01:00
The metric was a bit misleader because it does not show the actual row counts
returned to the calling applications as users might assume.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,8 @@
 ### Fixed
 
 * Strip comments from SQL queries emitted by pg\_activity (#442).
+* Remove the "tuples returned/s" metric from the header, it provided misleading 
+  information (#441, reported by @kmoppel)
 
 ## pg\_activity 3.6.1 - 2025-06-03
 
diff --git a/docs/man/pg_activity.1 b/docs/man/pg_activity.1
@@ -58,7 +58,7 @@
 .\" ========================================================================
 .\"
 .IX Title "PG_ACTIVITY 1"
-.TH PG_ACTIVITY 1 2025-06-03 "pg_activity 3.6.1" "Command line tool for PostgreSQL server activity monitoring."
+.TH PG_ACTIVITY 1 2025-10-27 "pg_activity 3.6.1" "Command line tool for PostgreSQL server activity monitoring."
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -127,8 +127,6 @@ Activity :
 .IX Item "- updates/s: number of updates per second (filtered);"
 .IP "\- \fBdelete/s\fR: number of deletes per second (filtered);" 2
 .IX Item "- delete/s: number of deletes per second (filtered);"
-.IP "\- \fBtuples returned/s\fR: number of tuples returned per second (filtered);" 2
-.IX Item "- tuples returned/s: number of tuples returned per second (filtered);"
 .IP "\- \fBtemp files\fR: number of temporary files created on the instance;" 2
 .IX Item "- temp files: number of temporary files created on the instance;"
 .IP "\- \fBtemp size\fR: total temporary file size on the instance." 2
diff --git a/docs/man/pg_activity.pod b/docs/man/pg_activity.pod
@@ -72,8 +72,6 @@ Activity :
 
 =item - B<delete/s>: number of deletes per second (filtered);
 
-=item - B<tuples returned/s>: number of tuples returned per second (filtered);
-
 =item - B<temp files>: number of temporary files created on the instance;
 
 =item - B<temp size>: total temporary file size on the instance.
diff --git a/pgactivity/data.py b/pgactivity/data.py
@@ -351,7 +351,7 @@ def pg_get_server_information(
 
         hr: Pct | None = None
         rr: Pct | None = None
-        tps, ips, ups, dps, rps = 0, 0, 0, 0, 0
+        tps, ips, ups, dps = 0, 0, 0, 0
         size_ev = 0.0
         if prev_server_info is not None:
             dt = float(ret["epoch"] - prev_server_info.epoch)
@@ -362,9 +362,6 @@ def pg_get_server_information(
                 ips = int((ret["insert"] - prev_server_info.insert) / dt)
                 ups = int((ret["update"] - prev_server_info.update) / dt)
                 dps = int((ret["delete"] - prev_server_info.delete) / dt)
-                rps = int(
-                    (ret["tuples_returned"] - prev_server_info.tuples_returned) / dt
-                )
                 deltaread = ret["blks_read"] - prev_server_info.blks_read
                 deltahit = ret["blks_hit"] - prev_server_info.blks_hit
                 if deltaread + deltahit != 0:
@@ -382,7 +379,6 @@ def pg_get_server_information(
             insert_per_second=ips,
             update_per_second=ups,
             delete_per_second=dps,
-            tuples_returned_per_second=rps,
             cache_hit_ratio_last_snap=hr,
             rollback_ratio_last_snap=rr,
             temporary_file=temporary_file_info,
diff --git a/pgactivity/queries/get_server_info_oldest.sql b/pgactivity/queries/get_server_info_oldest.sql
@@ -6,7 +6,6 @@ WITH dbinfo AS(
                COALESCE(SUM(tup_inserted)::BIGINT, 0) AS insert,
                COALESCE(SUM(tup_updated)::BIGINT, 0) AS update,
                COALESCE(SUM(tup_deleted)::BIGINT, 0) AS delete,
-               COALESCE(SUM(tup_returned)::BIGINT, 0) AS tuples_returned,
                COALESCE(CASE
                    WHEN %(skip_db_size)s THEN %(prev_total_size)s
                    ELSE SUM(pg_database_size(d.datname))
diff --git a/pgactivity/queries/get_server_info_post_090100.sql b/pgactivity/queries/get_server_info_post_090100.sql
@@ -7,7 +7,6 @@ WITH dbinfo AS(
                COALESCE(SUM(tup_inserted)::BIGINT, 0) AS insert,
                COALESCE(SUM(tup_updated)::BIGINT, 0) AS update,
                COALESCE(SUM(tup_deleted)::BIGINT, 0) AS delete,
-               COALESCE(SUM(tup_returned)::BIGINT, 0) AS tuples_returned,
                COALESCE(CASE
                    WHEN %(skip_db_size)s THEN %(prev_total_size)s
                    ELSE SUM(pg_database_size(d.datname))
diff --git a/pgactivity/queries/get_server_info_post_090200.sql b/pgactivity/queries/get_server_info_post_090200.sql
@@ -7,7 +7,6 @@ WITH dbinfo AS(
                COALESCE(SUM(tup_inserted)::BIGINT, 0) AS insert,
                COALESCE(SUM(tup_updated)::BIGINT, 0) AS update,
                COALESCE(SUM(tup_deleted)::BIGINT, 0) AS delete,
-               COALESCE(SUM(tup_returned)::BIGINT, 0) AS tuples_returned,
                COALESCE(CASE
                    WHEN %(skip_db_size)s THEN %(prev_total_size)s
                    ELSE SUM(pg_database_size(d.datname))
diff --git a/pgactivity/queries/get_server_info_post_090400.sql b/pgactivity/queries/get_server_info_post_090400.sql
@@ -10,7 +10,6 @@ WITH dbinfo AS(
                COALESCE(SUM(tup_inserted)::BIGINT, 0) AS insert,
                COALESCE(SUM(tup_updated)::BIGINT, 0) AS update,
                COALESCE(SUM(tup_deleted)::BIGINT, 0) AS delete,
-               COALESCE(SUM(tup_returned)::BIGINT, 0) AS tuples_returned,
                COALESCE(CASE
                    WHEN %(skip_db_size)s THEN %(prev_total_size)s
                    ELSE SUM(pg_database_size(d.datname))
diff --git a/pgactivity/queries/get_server_info_post_090600.sql b/pgactivity/queries/get_server_info_post_090600.sql
@@ -8,7 +8,6 @@ WITH dbinfo AS(
                COALESCE(SUM(tup_inserted)::BIGINT, 0) AS insert,
                COALESCE(SUM(tup_updated)::BIGINT, 0) AS update,
                COALESCE(SUM(tup_deleted)::BIGINT, 0) AS delete,
-               COALESCE(SUM(tup_returned)::BIGINT, 0) AS tuples_returned,
                COALESCE(CASE
                    WHEN %(skip_db_size)s THEN %(prev_total_size)s
                    ELSE SUM(pg_database_size(d.datname))
diff --git a/pgactivity/queries/get_server_info_post_100000.sql b/pgactivity/queries/get_server_info_post_100000.sql
@@ -9,7 +9,6 @@ WITH dbinfo AS(
                COALESCE(SUM(tup_inserted)::BIGINT, 0) AS insert,
                COALESCE(SUM(tup_updated)::BIGINT, 0) AS update,
                COALESCE(SUM(tup_deleted)::BIGINT, 0) AS delete,
-               COALESCE(SUM(tup_returned)::BIGINT, 0) AS tuples_returned,
                COALESCE(CASE
                    WHEN %(skip_db_size)s THEN %(prev_total_size)s
                    ELSE SUM(pg_database_size(d.datname))
diff --git a/pgactivity/queries/get_server_info_post_110000.sql b/pgactivity/queries/get_server_info_post_110000.sql
@@ -7,7 +7,6 @@ WITH dbinfo AS(
                COALESCE(SUM(tup_inserted)::BIGINT, 0) AS insert,
                COALESCE(SUM(tup_updated)::BIGINT, 0) AS update,
                COALESCE(SUM(tup_deleted)::BIGINT, 0) AS delete,
-               COALESCE(SUM(tup_returned)::BIGINT, 0) AS tuples_returned,
                COALESCE(CASE
                    WHEN %(skip_db_size)s THEN %(prev_total_size)s
                    ELSE SUM(pg_database_size(d.datname))
diff --git a/pgactivity/types.py b/pgactivity/types.py
@@ -798,7 +798,6 @@ class ServerInformation:
     insert: int
     update: int
     delete: int
-    tuples_returned: int
     total_size: int
     blks_read: int
     blks_hit: int
@@ -833,7 +832,6 @@ class ServerInformation:
     insert_per_second: int
     update_per_second: int
     delete_per_second: int
-    tuples_returned_per_second: int
     cache_hit_ratio_last_snap: Pct | None = attr.ib(
         converter=attr.converters.optional(Pct)
     )
diff --git a/pgactivity/views.py b/pgactivity/views.py
@@ -267,7 +267,6 @@ def indent(text: str) -> str:
             [f"{render(si.insert_per_second)} insert/s"],
             [f"{render(si.update_per_second)} update/s"],
             [f"{render(si.delete_per_second)} delete/s"],
-            [f"{render(si.tuples_returned_per_second)} tuples returned/s"],
             [f"{render(temp_files)} temp files"],
             [f"{render(temp_size)} temp size"],
         ]
diff --git a/tests/test_ui.txt b/tests/test_ui.txt
@@ -149,11 +149,9 @@ Force local mode and mock server and system info
 ...             insert=100,
 ...             update=200,
 ...             delete=300,
-...             tuples_returned=400,
 ...             insert_per_second=10,
 ...             update_per_second=20,
 ...             delete_per_second=30,
-...             tuples_returned_per_second=40,
 ...             temporary_file=types.TempFileInfo(
 ...                 temp_files=5,
 ...                 temp_bytes=12054865,
@@ -186,7 +184,7 @@ No activity, first screen followed by help screen:
 PostgreSQL ... - test - postgres@127.0.0.1:.../tests - Ref.: 2s - Duration mode: query
  * Global: 132 days, 3 hours and 21 minutes uptime, 19.53M dbs size - 1.00K/s growth, 90.12% cache hit ratio, 32.11% rollback ratio
    Sessions: 6/100 total, 1 active, 1 idle, 10 idle in txn, 0 idle in txn abrt, 3 waiting
-   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 40 tuples returned/s, 5 temp files, 11.50M temp size
+   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 5 temp files, 11.50M temp size
  * Worker processes: 3/8 total, 1/8 logical workers, 2/8 parallel workers
    Other processes & info: 3/3 autovacuum workers, 1/10 wal senders, 0 wal receivers, 10/10 repl. slots
  * Mem.: 8B total, 2B (25.00%) free, 2B (25.00%) used, 4B (50.00%) buff+cached
@@ -213,7 +211,7 @@ PID    DATABASE              USER       CLIENT IOW              state Query
 PostgreSQL ... - test - postgres@127.0.0.1:.../tests - Ref.: 2s - Duration mode: query
  * Global: 132 days, 3 hours and 21 minutes uptime, 19.53M dbs size - 1.00K/s growth, 90.12% cache hit ratio, 32.11% rollback ratio
    Sessions: 6/100 total, 1 active, 1 idle, 10 idle in txn, 0 idle in txn abrt, 3 waiting
-   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 40 tuples returned/s, 5 temp files, 11.50M temp size
+   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 5 temp files, 11.50M temp size
  * Worker processes: 3/8 total, 1/8 logical workers, 2/8 parallel workers
    Other processes & info: 3/3 autovacuum workers, 1/10 wal senders, 0 wal receivers, 10/10 repl. slots
                                 RUNNING QUERIES
@@ -240,7 +238,7 @@ PID    DATABASE              USER       CLIENT IOW              state Query
 PostgreSQL ... - test - postgres@127.0.0.1:.../tests - Ref.: 2s - Duration mode: query
  * Global: 132 days, 3 hours and 21 minutes uptime, 19.53M dbs size - 1.00K/s growth, 90.12% cache hit ratio, 32.11% rollback ratio
    Sessions: 6/100 total, 1 active, 1 idle, 10 idle in txn, 0 idle in txn abrt, 3 waiting
-   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 40 tuples returned/s, 5 temp files, 11.50M temp size
+   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 5 temp files, 11.50M temp size
                                 RUNNING QUERIES
 PID    DATABASE              USER       CLIENT IOW              state Query
 <BLANKLINE>
@@ -361,7 +359,7 @@ Force non-local mode with the same mock data (and reset the term size)
 PostgreSQL ... - test - postgres@127.0.0.1:.../tests - Ref.: 2s - Duration mode: query
  * Global: 132 days, 3 hours and 21 minutes uptime, 19.53M dbs size - 1.00K/s growth, 90.12% cache hit ratio, 32.11% rollback ratio
    Sessions: 6/100 total, 1 active, 1 idle, 10 idle in txn, 0 idle in txn abrt, 3 waiting
-   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 40 tuples returned/s, 5 temp files, 11.50M temp size
+   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 5 temp files, 11.50M temp size
  * Worker processes: 3/8 total, 1/8 logical workers, 2/8 parallel workers
    Other processes & info: 3/3 autovacuum workers, 1/10 wal senders, 0 wal receivers, 10/10 repl. slots
                                 RUNNING QUERIES
@@ -408,7 +406,7 @@ Press any key to exit.
 PostgreSQL ... - test - postgres@127.0.0.1:.../tests - Ref.: 2s - Duration mode: query
  * Global: 132 days, 3 hours and 21 minutes uptime, 19.53M dbs size - 1.00K/s growth, 90.12% cache hit ratio, 32.11% rollback ratio
    Sessions: 6/100 total, 1 active, 1 idle, 10 idle in txn, 0 idle in txn abrt, 3 waiting
-   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 40 tuples returned/s, 5 temp files, 11.50M temp size
+   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 5 temp files, 11.50M temp size
  * Worker processes: 3/8 total, 1/8 logical workers, 2/8 parallel workers
    Other processes & info: 3/3 autovacuum workers, 1/10 wal senders, 0 wal receivers, 10/10 repl. slots
                                 RUNNING QUERIES
diff --git a/tests/test_views.txt b/tests/test_views.txt
@@ -112,11 +112,9 @@ Remote host:
 ...     insert=100,
 ...     update=200,
 ...     delete=300,
-...     tuples_returned=400,
 ...     insert_per_second=10,
 ...     update_per_second=20,
 ...     delete_per_second=30,
-...     tuples_returned_per_second=40,
 ...     temporary_file=TempFileInfo(
 ...        temp_files=5,
 ...        temp_bytes=12054865,
@@ -130,7 +128,7 @@ Remote host:
 PostgreSQL 9.6 - server - pgadm@server.prod.tld:5433/app - Ref.: 10s - Duration mode: backend
  * Global: 132 days, 3 hours and 21 minutes uptime, 19.53M dbs size - 1.00K/s growth, 90.12% cache hit ratio, 12.35% rollback ratio
    Sessions: 6/100 total, 1 active, 1 idle, 10 idle in txn, 0 idle in txn abrt, 3 waiting
-   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 40 tuples returned/s, 5 temp files, 11.50M temp size
+   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 5 temp files, 11.50M temp size
  * Worker processes: 3/8 total, 1/8 logical workers, 2/8 parallel workers
    Other processes & info: 3/3 autovacuum workers, 1/10 wal senders, 0 wal receivers, 10/10 repl. slots
 
@@ -150,7 +148,7 @@ Local host, with privileged access:
 PostgreSQL 9.6 - localhost - tester@host:5432/postgres - Ref.: 10s - Duration mode: backend
  * Global: 132 days, 3 hours and 21 minutes uptime, 19.53M dbs size - 1.00K/s growth, 90.12% cache hit ratio, 12.35% rollback ratio
    Sessions: 6/100 total, 1 active, 1 idle, 10 idle in txn, 0 idle in txn abrt, 3 waiting
-   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 40 tuples returned/s, 5 temp files, 11.50M temp size
+   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 5 temp files, 11.50M temp size
  * Worker processes: 3/8 total, 1/8 logical workers, 2/8 parallel workers
    Other processes & info: 3/3 autovacuum workers, 1/10 wal senders, 0 wal receivers, 10/10 repl. slots
  * Mem.: 8B total, 2B (25.00%) free, 2B (25.00%) used, 4B (50.00%) buff+cached
@@ -165,7 +163,7 @@ PostgreSQL 9.6 - localhost - tester@host:5432/postgres - Ref.: 10s - Duration mo
 PostgreSQL 9.6 - localhost - tester@host:5432/postgres - Ref.: 10s - Duration mode: backend
  * Global: 132 days, 3 hours and 21 minutes uptime, 19.53M dbs size - 1.00K/s growth, 90.12% cache hit ratio, 12.35% rollback ratio
    Sessions: 6/100 total, 1 active, 1 idle, 10 idle in txn, 0 idle in txn abrt, 3 waiting
-   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 40 tuples returned/s, 5 temp files, 11.50M temp size
+   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 5 temp files, 11.50M temp size
  * Worker processes: 3/8 total, 1/8 logical workers, 2/8 parallel workers
    Other processes & info: 3/3 autovacuum workers, 1/10 wal senders, 0 wal receivers, 10/10 repl. slots
 
@@ -178,7 +176,7 @@ PostgreSQL 9.6 - localhost - tester@host:5432/postgres - Ref.: 10s - Duration mo
 PostgreSQL 9.6 - localhost - tester@host:5432/postgres - Ref.: 10s - Duration mode: query
  * Global: 132 days, 3 hours and 21 minutes uptime, 19.53M dbs size - 1.00K/s growth, 90.12% cache hit ratio, 12.35% rollback ratio
    Sessions: 6/100 total, 1 active, 1 idle, 10 idle in txn, 0 idle in txn abrt, 3 waiting
-   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 40 tuples returned/s, 5 temp files, 11.50M temp size
+   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 5 temp files, 11.50M temp size
 
 >>> ui = UI.make(refresh_time=2, min_duration=1.2, duration_mode=DurationMode.transaction)
 >>> ui.header.toggle_system()
@@ -480,11 +478,9 @@ Tests for screen()
 ...     insert=100,
 ...     update=200,
 ...     delete=300,
-...     tuples_returned=400,
 ...     insert_per_second=10,
 ...     update_per_second=20,
 ...     delete_per_second=30,
-...     tuples_returned_per_second=40,
 ...     temporary_file=TempFileInfo(
 ...         temp_files=5,
 ...         temp_bytes=12054865,
@@ -522,7 +518,7 @@ Tests for screen()
 PostgreSQL 13 - localhost - tester@host:5432/postgres - Ref.: 10s - Duration mode: backend - Min. duration: 1s
  * Global: 132 days, 3 hours and 21 minutes uptime, 19.53M dbs size - 1.00K/s growth, 90.12% cache hit ratio, 0.09% rollback ratio
    Sessions: 6/100 total, 1 active, 1 idle, 10 idle in txn, 0 idle in txn abrt, 3 waiting
-   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 40 tuples returned/s, 5 temp files, 11.50M temp size
+   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 5 temp files, 11.50M temp size
  * Worker processes: 3/8 total, 1/8 logical workers, 2/8 parallel workers
    Other processes & info: 3/3 autovacuum workers, 1/10 wal senders, 0 wal receivers, 10/10 repl. slots
  * Mem.: 8B total, 2B (25.00%) free, 2B (25.00%) used, 4B (50.00%) buff+cached
@@ -558,7 +554,7 @@ F1/1 Running queries    F2/2 Waiting queries    F3/3 Blocking queries   Space Pa
 PostgreSQL 13 - localhost - tester@host:5432/postgres - Ref.: 10s - Duration
  * Global: 132 days, 3 hours and 21 minutes uptime, 19.53M dbs size - 1.00K/s
    Sessions: 6/100 total, 1 active, 1 idle, 10 idle in txn, 0 idle in txn abrt,
-   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 40 tuples
+   Activity: 15 tps, 10 insert/s, 20 update/s, 30 delete/s, 5 temp files, 11.50M
  * Worker processes: 3/8 total, 1/8 logical workers, 2/8 parallel workers
    Other processes & info: 3/3 autovacuum workers, 1/10 wal senders, 0 wal
  * Mem.: 8B total, 2B (25.00%) free, 2B (25.00%) used, 4B (50.00%) buff+cached
