PMCD_WAIT(1)

πŸ’– PMCD_WAIT β€” bestie edition πŸ’–

okay so this is a page from the General Commands Manual section, and it's all about a little tool called pmcd_wait. grab a snack, we're doing this. πŸ“


✨ NAME ✨

pmcd_wait β€” wait for PMCD to accept client connections

lowkey the whole job. she waits. she's patient. she's iconic. πŸ‘‘


🌸 SYNOPSIS 🌸

$PCP_BINADM_DIR/pmcd_wait [-v?]  [-D debug] [-h host] [-t timeout]

πŸ’… DESCRIPTION πŸ’…

pmcd_wait waits for the Performance Metrics Collector Daemon (PMCD) to be running and accepting client connections. that's it, that's the gig. she will literally just stand there at the door until PMCD opens up. πŸšͺ✨

Unless you send her somewhere else with the -h option, pmcd_wait will try to contact pmcd(1) on the local host. homebody behavior, honestly relatable.

pmcd_wait will timeout and abandon the attempt to connect to pmcd after 60 seconds. yes, sixty. this default timeout interval may be changed using the -t option, where the interval argument follows the syntax described in PCPIntro(1) β€” and in the simplest form it may be an unsigned integer (the implied units in this case are seconds). so like, -t 5 means five seconds, no cap. ⏰

On successful connection to pmcd an exit status of zero is returned. we love a clean zero. 🫢

If an error or timeout occurs, then a non-zero exit status is returned as described below. so scroll down, bestie, the receipts are all there. πŸ‘‡


πŸŽ€ OPTIONS πŸŽ€

The available command line options are:

  • -h host, --host=*host* β€” Connect pmcd(1) on host, rather than the one on the default localhost. basically: go talk to that other machine instead of your own. 🌈
  • -t timeout, --interval=*timeout* β€” Timeout after timeout seconds if not connected. The default timeout value is 60 seconds. so if she's still waiting after timeout seconds, she's out. bye. πŸ’€
  • -v, --verbose β€” This option turns the verbose mode on. With the verbose mode off (which is the default), no output will be generated. With verbose mode on, error messages will be output on stderr. so if you want her to actually talk to you about what went wrong, flip this on. she's quiet by default, mysterious main character energy. 🀫
  • -?, --help β€” Display usage message and exit. the classic "what do I do again" button. πŸ™ˆ

πŸ”₯ DIAGNOSTICS πŸ”₯

Error messages will be output to stderr only if the verbose mode is on. no -v, no commentary. she's giving silent treatment.

The following exit status codes are returned:

  1. 0 β€” pmcd_wait was able to successfully connect to pmcd within the timeout period. slay. absolute win. πŸŽ‰
  2. 1 β€” A usage error occurred, use -v for more details. you typed something wrong, bestie, turn on verbose and find out what.
  3. 2 β€” No connection was made in the timeout interval. This will happen if pmcd is running but takes too long to complete the client connection, or if pmcd is not running and all connection attempts in the timeout interval failed with the error ECONNREFUSED. either way: no vibe, no connection. 😭
  4. 3 β€” A UNIX error occurred, use -v for more details. the operating system said no. 🐧
  5. 4 β€” A PCP error occurred, use -v for more details. PCP itself said no. πŸ’”

πŸ’œ PCP ENVIRONMENT πŸ’œ

Environment variables with the prefix PCP_ are used to parameterize the file and directory names used by PCP. On each installation, the file /etc/pcp.conf contains the local values for these variables. The $PCP_CONF variable may be used to specify an alternative configuration file, as described in pcp.conf(5). so yeah β€” if you wanna move your whole setup around, that's the door. πŸšͺ


🧚 DEBUGGING OPTIONS 🧚

The -D or --debug option enables the output of additional diagnostics on stderr to help triage problems, although the information is sometimes cryptic and primarily intended to provide guidance for developers rather than for end-users. fr fr, it's giving developer-only lore. πŸ“œ

debug is a comma separated list of debugging options; use pmdbg(1) with the -l option to obtain a list of the available debugging options and their meaning. go look it up, the list is right there. ⭐


🌟 SEE ALSO 🌟

PCPIntro(1), pmcd(1), pcp.conf(5) and pcp.env(5).


heads up bestie: if you want the actual details and not just my yapping, those pages above are the real ones. iykyk. πŸ’–

and that's the whole page!! πŸ¦‹ this one ships with Performance Co-Pilot β€” the PCP fam β€” and this particular page is PMCD_WAIT(1). mwah, go connect to something. πŸ’…βœ¨

πŸ“¦ where this page comes from