PCP-XSOS(1)

💖 pcp-xsos — high-level summary reports for a system 💖

okay bestie, welcome to pcp-xsos, from the General Commands Manual section of your friendly neighbourhood manual pages. this is the girl who gives you the ✨vibe check✨ on an entire system. let's gooo 🦋

🌸 SYNOPSIS 🌸

pcp [pcp options] xsos [--all] [-dmnNopx] [-u units]

✨ DESCRIPTION ✨

okay so pcp-xsos hands you a summary report of a system, and it'll do it either from a PCP archive or from live metric values straight off that system. no cap. 💅

she's built to be fast and she does a single-sample only, just like her besties ps(1) and friends. so yeah, the level of detail in reporting is lowkey traded off in favour of execution speed — that's the whole deal. pcp-xsos is designed as an initial performance triage tool 🩺, the kind that quickly tells an operator which avenues of investigation might actually prove more fruitful. right now the focus is entirely on operating system metrics, but like… that's not a requirement, bestie, and in time it may be extended to report on any performance domain with associated PCP metrics. the future is bright ✨

when you invoke her via the pcp(1) command, the -h/--host, -a/--archive, and -O/--origin pcp options become indirectly available — peep PCPIntro(1) for their descriptions, iykyk 🫶

and the default report, with no command line options presented at all? it's the operating system overview. iconic. 👑

🎀 OPTIONS 🎀

the available command line options are:

• --all — iteratively report each subsection, one after the other. the full tour, bestie 🧚
• -o, --os — display the default report with high level kernel information, including version, uptime, number of users, process states and aggregated processor utilisation. 💻
• -d, --disks — report storage information from the archive or live host, including the total capacity for each block device as well as available filesystem space for each mounted filesystem. 🍓
• -m, --memory — detailed memory report, including percentage of total memory used for various operating system functions, swap use, and optionally hugepages and virtual machine balloon information. 🎈
• -n, --netdev — statistics for each configured network interface, including packet and byte transfer rates (since boot), errors, drops, and so on. additionally, socket statistics are also reported with this command line option, for raw, UDP and TCP (IPv4 and IPv6). 🌐
• -N, --netstats — report aggregate network statistics such as various ICMP and TCP error and timeout counters. 📡
• -p, --ps — inspect running processes in a style similar to ps. these are grouped and filtered to show the most important processes in terms of resource use (CPU, memory) as well as processes in zombie or blocked states. 🧟 (not me listing the zombies 💀)
• *-u *unit, --units=unit — change the byte display for various reports. valid values for unit are "b" (bytes), "k" (kibibytes), "m" (mibibytes), "g" (gibibytes) or "t" (tebibytes). 📏
• -x, --nocolor — display reports without using colors to highlight various aspects of each subsystem. (a crime, honestly, but valid 🙈)
• -?, --help — display usage message and exit. the classic. ✌️

📝 NOTES 📝

pcp-xsos is inspired by the xsos utility, aims to be command line compatible with it where possible, and also wants to provide a consistent output style. slay. 💅✨

🌈 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). 🔧

for environment variables affecting PCP tools, peep pmGetOptions(3), which provides pmgetopt(1) functionality used by pcp-xsos. 🫶

👀 SEE ALSO 👀

PCPIntro(1), pcp(1), ps(1), pmgetopt(1), pmGetOptions(3) and environ(7).

and that's the whole page, bestie!! this lil manual page came to you from Performance Co-Pilot (that's the source, and PCP is the version, for the PCP-XSOS(1) page) 💖 mwah, go run some reports, ily, bye!! 🎀🦋💅