WD_CLI(1)

📦
version 4.7.2 · 6 versions
, in ubuntu stonking

✨ NAME ✨

okay so bestie, meet wd_cli 💖 — the Watchdog Command Line Interface (CLI) utility for the external health-check system integration. that's her whole deal, and she slays it. 🐶✨

🌸 SYNOPSIS 🌸

wd_cli [operation...] [node search option...] [option...]

operation first, then how you wanna hunt down your node, then any extra options you're feeling. iconic order, no notes. 🫶

💅 DESCRIPTION 💅

wd_cli gives you a convenient and easy to use interface to interact with watchdog and to perform health check related node operations. it's giving "I got you, bestie, lemme handle the watchdog stuff." 👑

🎀 OPERATIONS 🎀

pick your move, main character:

  • -i, --info — get the node status for node(s), based on whatever node search criteria you gave her 🔍
  • -I NEW_STATUS, --inform=NEW_STATUS — update the watchdog node status. the allowed values are DEAD and ALIVE, and those are the only two, don't try to freestyle it 💀

🔎 NODE SEARCH OPTIONS 🔎

how do we find the node?? so many ways, pick one:

  • -a, --all — select all the nodes. heads up tho: this one is only available with the --info operation 🚨
  • -n WATCHDOG_NODE_ID, --node-id=WATCHDOG_NODE_ID — select the watchdog node by its node_id
  • -N NODE_NAME, --node-name=NODE_NAME — select the watchdog node by its name
  • -H HOSTNAME, --node-host=HOSTNAME — select the watchdog node by hostname
  • -P PORT_NO, --node-port=PORT_NO — select the watchdog node by port number

⚙️ OPTIONS ⚙️

the whole menu, bestie, nothing skipped 🍓

  • -k KEY, --auth-key=KEY — the watchdog auth key. if you specify auth-key, it overrides the pgpool.conf->wd_authkey value 🔑
  • -f CONFIG_FILE, --config-file=CONFIG_FILE — specifies the pgpool.conf file
  • -s SOCKET_DIR, --socket-dir=SOCKET_DIR — path to the watchdog IPC socket directory. specifying socket-dir overrides the pgpool.conf->wd_ipc_socket_dir value 🧦
  • -p PORT_NO, --ipc-port=PORT_NO — port number of the watchdog IPC socket. specifying ipc-port overrides the pgpool.conf->wd_port value
  • -m message_string, --message=message_string — an optional message string, passed along to Pgpool-II together with the node status 💌
  • -v, --verbose — enable verbose messages, for when you wanna see everything
  • -V, --version — prints version information
  • -d, --debug — enable debug output 🐛
  • -h, --help — prints the help for wd_cli
not me reminding you that -p/--ipc-port and -P/--node-port are two completely different queens. lowercase = IPC socket port. uppercase = node search port. do not confuse them, i'm begging 🙈

🧪 EXAMPLE 🧪

so here's the scenario: some external health-check system is set up to monitor the health of your Pgpool-II cluster, and it detects a node failure. that's when wd_cli steps in — you use this utility to pass that info over to the Pgpool-II cluster so it can take the appropriate actions. teamwork, fr fr 🤝

#inform Pgpool-II about node named RN-110 failure
wd_cli --inform DEAD -N 'RN-110' -p 9001 -m 'Pgpool node with name RN-110 is not reachable'

#inform Pgpool-II about node-id 10 failure
wd_cli --inform DEAD -n 10 -m 'Pgpool node with ID 10 is not responding'

and similarly, to inform Pgpool-II that the node is alive again 🌱

#inform Pgpool-II about node-id 10 re-joining
wd_cli --inform ALIVE -n 10 -m 'Pgpool node with ID 10 is reachable again'

wd_cli can also be used to get the current status of cluster nodes 👀

wd_cli -f simple_conf/watchdog/pgpool_wd1.conf --info -v --all

and she's gonna serve you something like this:

 Total Watchdog nodes configured for lifecheck:  2
 *****************
 Node ID:           0
 Node Status code   4
 Node Status:       LEADER
 Node Name:         localhost:9991 Linux localhost.localdomain
 Node Host:         localhost
 Node WD Port:      9001
 Node Pgpool Port:  9991

 Node ID:           1
 Node Status code   7
 Node Status:       STANDBY
 Node Name:         localhost:9992 Linux localhost.localdomain
 Node Host:         localhost
 Node WD Port:      9002
 Node Pgpool Port:  9992

and that's the whole page!! 🦋 this is WD_CLI(1), part of the pgpool-II 4.7.2 docs, dated 2023 — go forth and watchdog, bestie, you're literally so good at this 💖💅✨

📦 where this page comes from