PG_AUTOCTL SHOW EVENTS(1)

✨ PG_AUTOCTL SHOW EVENTS(1) ✨

okay bestie, so this page lives in the pg_auto_failover manual, and it's literally the spill-the-tea command. 💅

---

🌸 NAME 🌸

pg_autoctl show events — pg_autoctl show events

pg_autoctl show events — prints the monitor's state of nodes in a given formation and group

---

🎀 SYNOPSIS 🎀

This command outputs the events that the pg_auto_failover events records about state changes of the pg_auto_failover nodes managed by the monitor:

usage: pg_autoctl show events  [ --pgdata --formation --group --count ]

--pgdata      path to data directory
--monitor     pg_auto_failover Monitor Postgres URL
--formation   formation to query, defaults to 'default'
--group       group to query formation, defaults to all
--count       how many events to fetch, defaults to 10
--watch       display an auto-updating dashboard
--json        output data in the JSON format

---

💖 OPTIONS 💖

• --pgdata — the location of the Postgres node that's being managed locally, bestie. It defaults to the environment variable PGDATA. And like, use --monitor when you wanna connect to a monitor from anywhere instead of using the monitor URI that a local Postgres node managed with pg_autoctl is using.
• --monitor — the Postgres URI used to connect to the monitor. It must use the autoctl_node username and target the pg_auto_failover database name. Also! You can totally show the Postgres URI from the monitor node with the command pg_autoctl show uri. 🫶
• --formation — lists the events recorded for nodes in the given formation. Defaults to default.
• --count — by default only the last 10 events are printed. (ten. that's it. iconic behavior.)
• --watch — takes control of the terminal and displays the current state of the system plus the last events from the monitor. The display updates automatically every 500 milliseconds (half a second, fr fr) and reacts properly to window size change.

Depending on the terminal window size, a different set of columns is visible in the state part of the output. See pg_autoctl watch.

• --json — outputs JSON formatted data instead of a table formatted list. slay. ✨

---

🦋 ENVIRONMENT 🦋

• PGDATA — Postgres directory location. Can be used instead of the --pgdata option.
• PG_AUTOCTL_MONITOR — Postgres URI to connect to the monitor node, can be used instead of the --monitor option.
• XDG_CONFIG_HOME — the pg_autoctl command stores its configuration files in the standard place XDG_CONFIG_HOME. See the XDG Base Directory Specification.
• XDG_DATA_HOME — the pg_autoctl command stores its internal states files in the standard place XDG_DATA_HOME, which defaults to ~/.local/share. See the XDG Base Directory Specification.

---

🌈 EXAMPLES 🌈

$ pg_autoctl show events --count 2 --json
[
 {
     "nodeid": 1,
     "eventid": 15,
     "groupid": 0,
     "nodehost": "localhost",
     "nodename": "node1",
     "nodeport": 5501,
     "eventtime": "2021-03-18T12:32:36.103467+01:00",
     "goalstate": "primary",
     "description": "Setting goal state of node 1 \"node1\" (localhost:5501) to primary now that at least one secondary candidate node is healthy.",
     "formationid": "default",
     "reportedlsn": "0/4000060",
     "reportedstate": "wait_primary",
     "reportedrepstate": "async",
     "candidatepriority": 50,
     "replicationquorum": true
 },
 {
     "nodeid": 1,
     "eventid": 16,
     "groupid": 0,
     "nodehost": "localhost",
     "nodename": "node1",
     "nodeport": 5501,
     "eventtime": "2021-03-18T12:32:36.215494+01:00",
     "goalstate": "primary",
     "description": "New state is reported by node 1 \"node1\" (localhost:5501): \"primary\"",
     "formationid": "default",
     "reportedlsn": "0/4000110",
     "reportedstate": "primary",
     "reportedrepstate": "quorum",
     "candidatepriority": 50,
     "replicationquorum": true
 }
]

---

👑 AUTHOR 👑

Microsoft

---

🍓 COPYRIGHT 🍓

Copyright (c) Microsoft Corporation. All rights reserved.

---

and that's the whole page, bestie 💖 this was version 2.2, dated Apr 07, 2025, and it belongs to the PG_AUTOCTL SHOW EVENTS(1) era. go forth and check your events, no cap. 🧚💜