Add the xmin horizon to running query display

The xmin horizon was added in 9.4 in commit [1].
[1] postgres/postgres@dd1a3bc

CHANGELOG.md

@@ -11,6 +11,7 @@
   configuration.
 * Add a `y` command to copy focused query to the system clipboard, using
   OSC 52 escape sequence (#311).
+* Add the `xmin` column to the query display (#425).
 
 ### Fixed
 

docs/man/pg_activity.1

@@ -182,6 +182,8 @@ The running queries panel shows all running queries, transactions or backends
 .IP "\- \fBPID\fR: process id of the backend which executes the query;" 2
 .IX Item "- PID: process id of the backend which executes the query;"
 .PD 0
+.IP "\- \fBXMIN\fR: xmin horizon of the backend;" 2
+.IX Item "- XMIN: xmin horizon of the backend;"
 .IP "\- \fBDATABASE\fR: database specified in the connection string;" 2
 .IX Item "- DATABASE: database specified in the connection string;"
 .IP "\- \fBAPP\fR: application name specified in the connection string;" 2
@@ -364,6 +366,11 @@ required by another session. It shows following information:
 .Vb 1
 \&        Enable/disable PID.
 .Ve
+.IP "\fB\-\-xmin\fR, \fB\-\-no\-xmin\fR" 2
+.IX Item "--xmin, --no-xmin"
+.Vb 1
+\&        Enable/disable XMIN.
+.Ve
 .IP "\fB\-\-database\fR, \fB\-\-no\-database\fR" 2
 .IX Item "--database, --no-database"
 .Vb 1

docs/man/pg_activity.pod

@@ -136,6 +136,8 @@ B<min duration> seconds. It displays the following information:
 
 =item - B<PID>: process id of the backend which executes the query;
 
+=item - B<XMIN>: xmin horizon of the backend;
+
 =item - B<DATABASE>: database specified in the connection string;
 
 =item - B<APP>: application name specified in the connection string;
@@ -322,6 +324,10 @@ required by another session. It shows following information:
 
 	Enable/disable PID.
 
+=item B<--xmin>, B<--no-xmin>
+
+	Enable/disable XMIN.
+
 =item B<--database>, B<--no-database>
 
 	Enable/disable DATABASE.

pgactivity/activities.py

@@ -151,6 +151,7 @@ def sorted(processes: list[T], *, key: SortKey, reverse: bool = False) -> list[T
     >>> processes = [
     ...     LocalRunningProcess(
     ...         pid="6240",
+    ...         xmin="1234",
     ...         application_name="pgbench",
     ...         database="pgbench",
     ...         user="postgres",
@@ -170,6 +171,7 @@ def sorted(processes: list[T], *, key: SortKey, reverse: bool = False) -> list[T
     ...     ),
     ...     LocalRunningProcess(
     ...         pid="6239",
+    ...         xmin="2345",
     ...         application_name="pgbench",
     ...         database="pgbench",
     ...         user="postgres",
@@ -189,6 +191,7 @@ def sorted(processes: list[T], *, key: SortKey, reverse: bool = False) -> list[T
     ...     ),
     ...     LocalRunningProcess(
     ...         pid="6228",
+    ...         xmin="3456",
     ...         application_name="pgbench",
     ...         database="pgbench",
     ...         user="postgres",
@@ -225,6 +228,7 @@ def sorted(processes: list[T], *, key: SortKey, reverse: bool = False) -> list[T
     >>> processes = [
     ...     LocalRunningProcess(
     ...         pid="6240",
+    ...         xmin="1234",
     ...         application_name="pgbench",
     ...         database="pgbench",
     ...         user="postgres",
@@ -244,6 +248,7 @@ def sorted(processes: list[T], *, key: SortKey, reverse: bool = False) -> list[T
     ...     ),
     ...     LocalRunningProcess(
     ...         pid="6239",
+    ...         xmin="2345",
     ...         application_name="pgbench",
     ...         database="pgbench",
     ...         user="postgres",
@@ -263,6 +268,7 @@ def sorted(processes: list[T], *, key: SortKey, reverse: bool = False) -> list[T
     ...     ),
     ...     LocalRunningProcess(
     ...         pid="6228",
+    ...         xmin="3456",
     ...         application_name="pgbench",
     ...         database="pgbench",
     ...         user="postgres",

pgactivity/cli.py

@@ -221,6 +221,7 @@ def get_parser() -> argparse.ArgumentParser:
         "These options may be used hide some columns from the processes table.",
     )
     flag(group, "--pid", dest="pid", feature="PID")
+    flag(group, "--xmin", dest="xmin", feature="XMIN")
     flag(group, "--database", dest="database", feature="DATABASE")
     flag(group, "--user", dest="user", feature="USER")
     flag(group, "--client", dest="client", feature="CLIENT")

pgactivity/config.py

@@ -62,9 +62,9 @@ class Flag(enum.Flag):
     """Column flag.
 
     >>> Flag.names()
-    ['database', 'appname', 'client', 'user', 'cpu', 'mem', 'read', 'write', 'time', 'wait', 'relation', 'type', 'mode', 'iowait', 'pid']
+    ['database', 'appname', 'client', 'user', 'cpu', 'mem', 'read', 'write', 'time', 'wait', 'relation', 'type', 'mode', 'iowait', 'pid', 'xmin']
     >>> Flag.all()  # doctest: +ELLIPSIS
-    <Flag...: 32767>
+    <Flag...: 65535>
     """
 
     DATABASE = enum.auto()
@@ -82,6 +82,7 @@ class Flag(enum.Flag):
     MODE = enum.auto()
     IOWAIT = enum.auto()
     PID = enum.auto()
+    XMIN = enum.auto()
 
     @classmethod
     def names(cls) -> list[str]:
@@ -131,6 +132,7 @@ def load(
         user: bool | None,
         wait: bool | None,
         write: bool | None,
+        xmin: bool | None,
         **kwargs: Any,
     ) -> Flag:
         """Build a Flag value from command line options."""
@@ -150,6 +152,7 @@ def load(
             (user, cls.USER),
             (wait, cls.WAIT),
             (write, cls.WRITE),
+            (xmin, cls.XMIN),
         ):
             if opt is True:
                 flag |= value

pgactivity/profiles/minimal.conf

@@ -3,6 +3,9 @@ show_instance = no
 show_system = no
 show_workers = no
 
+[xmin]
+hidden = yes
+
 [database]
 hidden = yes
 

pgactivity/profiles/narrow.conf

@@ -1,3 +1,6 @@
+[xmin]
+hidden = yes
+
 [database]
 hidden = yes
 

pgactivity/profiles/wide.conf

@@ -1,3 +1,6 @@
+[xmin]
+hidden = no
+
 [database]
 hidden = no
 

pgactivity/queries/get_pg_activity_oldest.sql

@@ -1,6 +1,7 @@
 -- Get data from pg_activity before pg 9.2
 SELECT
       a.procpid AS pid,
+      NULL AS xmin,
       '<unknown>' AS application_name,
       a.datname AS database,
       a.client_addr AS client,

pgactivity/queries/get_pg_activity_post_090200.sql

@@ -3,6 +3,7 @@
 -- NEW pg_stat_activity.procpid => pg_stat_activity.pid
 SELECT
       a.pid AS pid,
+      NULL AS xmin,
       a.application_name AS application_name,
       a.datname AS database,
       a.client_addr AS client,

pgactivity/queries/get_pg_activity_post_090400.sql

@@ -0,0 +1,31 @@
+-- Get data from pg_activity from pg 9.4 to 9.6
+-- NEW pg_stat_activity.backend_xmin
+SELECT
+      a.pid AS pid,
+      a.backend_xmin AS xmin,
+      a.application_name AS application_name,
+      a.datname AS database,
+      a.client_addr AS client,
+      EXTRACT(epoch FROM (NOW() - a.{duration_column})) AS duration,
+      a.wait_event AS wait,
+      a.usename AS user,
+      a.state AS state,
+      a.query AS query,
+      pg_catalog.pg_encoding_to_char(b.encoding) AS encoding,
+      NULL AS query_leader_pid,
+      false AS is_parallel_worker
+  FROM
+      pg_stat_activity a
+      LEFT OUTER JOIN pg_database b ON a.datid = b.oid
+ WHERE
+      state <> 'idle'
+  AND pid <> pg_backend_pid()
+  AND CASE WHEN {min_duration} = 0
+          THEN true
+          ELSE extract(epoch from now() - {duration_column}) > %(min_duration)s
+      END
+  AND CASE WHEN {dbname_filter} IS NULL THEN true
+      ELSE a.datname ~* %(dbname_filter)s
+      END
+ORDER BY
+      EXTRACT(epoch FROM (NOW() - a.{duration_column})) DESC;

pgactivity/queries/get_pg_activity_post_090600.sql

@@ -3,6 +3,7 @@
 -- NEW pg_stat_activity.waiting => pg_stat_activity.wait_event
 SELECT
       a.pid AS pid,
+      a.backend_xmin AS xmin,
       a.application_name AS application_name,
       a.datname AS database,
       a.client_addr AS client,

pgactivity/queries/get_pg_activity_post_100000.sql

@@ -3,6 +3,7 @@
 -- NEW pg_activity.backend_type
 SELECT
       a.pid AS pid,
+      a.backend_xmin AS xmin,
       a.application_name AS application_name,
       a.datname AS database,
       a.client_addr AS client,

pgactivity/queries/get_pg_activity_post_110000.sql

@@ -2,6 +2,7 @@
 -- NEW pg_activity.backend_type value for 'parallel worker'
 SELECT
       a.pid AS pid,
+      a.backend_xmin AS xmin,
       a.application_name AS application_name,
       a.datname AS database,
       a.client_addr AS client,

pgactivity/queries/get_pg_activity_post_130000.sql

@@ -2,6 +2,7 @@
 -- NEW pg_activity.leader_pid
 SELECT
       a.pid AS pid,
+      a.backend_xmin AS xmin,
       a.application_name AS application_name,
       a.datname AS database,
       a.client_addr AS client,

pgactivity/types.py

@@ -465,10 +465,17 @@ def add_column(
             sort_key=SortKey.write,
             transform=utils.naturalsize,
         )
+        add_column(
+            Flag.XMIN,
+            key="xmin",
+            min_width=8,
+            default_color="cyan",
+        )
 
         columns_key_by_querymode: Mapping[QueryMode, list[str]] = {
             QueryMode.activities: [
                 "pid",
+                "xmin",
                 "database",
                 "application_name",
                 "user",
@@ -916,6 +923,7 @@ def from_bytes(
 class RunningProcess(BaseProcess):
     """Process for a running query."""
 
+    xmin: int
     wait: bool | None | str
     query_leader_pid: int | None
     is_parallel_worker: bool

pgactivity/utils.py

@@ -221,24 +221,24 @@ def csv_write(
     """Store process list into CSV file.
 
     >>> processes = [
-    ...     {'pid': 25199, 'application_name': '', 'database': 'pgbench', 'user': None,
+    ...     {'pid': 25199, 'xmin': 1234, 'application_name': '', 'database': 'pgbench', 'user': None,
     ...      'client': 'local', 'cpu': 0.0, 'mem': 0.6504979545924837,
     ...      'read': 0.0, 'write': 0.0, 'state': 'active',
     ...      'query': 'autovacuum: VACUUM ANALYZE public.pgbench_tellers',
     ...      'duration': 0.348789, 'wait': False,
     ...      'io_wait': False, 'is_parallel_worker': False},
-    ...     {'pid': 25068, 'application_name': 'pgbench', 'database': None,
+    ...     {'pid': 25068, 'xmin': 2345, 'application_name': 'pgbench', 'database': None,
     ...      'user': 'postgres', 'client': 'local', 'cpu': 0.0, 'mem': 2.4694780629380646,
     ...      'read': 278536.76590087387, 'write': 835610.2977026217,
     ...      'state': 'idle in transaction',
     ...      'query': 'INSERT INTO pgbench_history (tid, bid, aid, delta, mtime) VALUES (625, 87, 4368910, -341, CURRENT_TIMESTAMP);',
     ...      'duration': 0.000105, 'wait': False, 'io_wait': False,
     ...      'is_parallel_worker': False},
-    ...     {'pid': 25379, 'application_name': 'pgbench', 'database': 'pgbench',
+    ...     {'pid': 25379, 'xmin': 3456, 'application_name': 'pgbench', 'database': 'pgbench',
     ...      'user': 'postgres', 'client': 'local', 'state': 'active',
     ...      'query': 'UPDATE pgbench_branches SET bbalance = bbalance + -49 WHERE bid = 73;',
     ...      'duration': 0, 'wait': False},
-    ...     {'pid': 25392, 'application_name': 'pgbench', 'database': 'pgbench',
+    ...     {'pid': 25392, 'xmin': 4567, 'application_name': 'pgbench', 'database': 'pgbench',
     ...      'user': 'postgres', 'client': 'local', 'state': 'active',
     ...      'query': 'BEGIN;', 'duration': 0, 'wait': False}
     ... ]
@@ -249,11 +249,11 @@ def csv_write(
     ...     _ = f.seek(0)
     ...     content = f.read()
     >>> print(content, end="")  # doctest: +ELLIPSIS
-    datetimeutc;pid;database;appname;user;client;cpu;memory;read;write;duration;wait;io_wait;state;query
-    "...-...-...T...Z";"25199";"pgbench";"";"None";"local";"0.0";"0.6504979545924837";"0.0";"0.0";"0.348789";"N";"N";"active";"autovacuum: VACUUM ANALYZE public.pgbench_tellers"
-    "...-...-...T...Z";"25068";"";"pgbench";"postgres";"local";"0.0";"2.4694780629380646";"278536.76590087387";"835610.2977026217";"0.000105";"N";"N";"idle in transaction";"INSERT INTO pgbench_history (tid, bid, aid, delta, mtime) VALUES (625, 87, 4368910, -341, CURRENT_TIMESTAMP);"
-    "...-...-...T...Z";"25379";"pgbench";"pgbench";"postgres";"local";"N/A";"N/A";"N/A";"N/A";"0";"N";"N/A";"active";"UPDATE pgbench_branches SET bbalance = bbalance + -49 WHERE bid = 73;"
-    "...-...-...T...Z";"25392";"pgbench";"pgbench";"postgres";"local";"N/A";"N/A";"N/A";"N/A";"0";"N";"N/A";"active";"BEGIN;"
+    datetimeutc;pid;xmin;database;appname;user;client;cpu;memory;read;write;duration;wait;io_wait;state;query
+    "...-...-...T...Z";"25199";"1234";"pgbench";"";"None";"local";"0.0";"0.6504979545924837";"0.0";"0.0";"0.348789";"N";"N";"active";"autovacuum: VACUUM ANALYZE public.pgbench_tellers"
+    "...-...-...T...Z";"25068";"2345";"";"pgbench";"postgres";"local";"0.0";"2.4694780629380646";"278536.76590087387";"835610.2977026217";"0.000105";"N";"N";"idle in transaction";"INSERT INTO pgbench_history (tid, bid, aid, delta, mtime) VALUES (625, 87, 4368910, -341, CURRENT_TIMESTAMP);"
+    "...-...-...T...Z";"25379";"3456";"pgbench";"pgbench";"postgres";"local";"N/A";"N/A";"N/A";"N/A";"0";"N";"N/A";"active";"UPDATE pgbench_branches SET bbalance = bbalance + -49 WHERE bid = 73;"
+    "...-...-...T...Z";"25392";"4567";"pgbench";"pgbench";"postgres";"local";"N/A";"N/A";"N/A";"N/A";"0";"N";"N/A";"active";"BEGIN;"
     """
 
     def clean_str_csv(s: str) -> str:
@@ -266,6 +266,7 @@ def clean_str_csv(s: str) -> str:
                 [
                     "datetimeutc",
                     "pid",
+                    "xmin",
                     "database",
                     "appname",
                     "user",
@@ -292,6 +293,7 @@ def yn_na(value: bool | None) -> str:
     for p in procs:
         dt = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
         pid = p.get("pid", "N/A")
+        xmin = p.get("xmin", "N/A")
         database = p.get("database", "N/A") or ""
         appname = p.get("application_name", "N/A")
         user = p.get("user", "N/A")
@@ -310,6 +312,7 @@ def yn_na(value: bool | None) -> str:
                 [
                     f'"{dt}"',
                     f'"{pid}"',
+                    f'"{xmin}"',
                     f'"{database}"',
                     f'"{appname}"',
                     f'"{user}"',