PMDARESCTRL(1)

💖 PMDARESCTRL 💖

okay bestie, so this is the manual for pmdaresctrl(1) — that's a General Commands Manual page, in case you were wondering, and no i will NOT be reading you the header line twice, i folded it in already. let's go ✨

---

🌸 NAME 🌸

pmdaresctrl — the resctrl performance metrics domain agent, aka a PMDA. it's giving agent behavior. 💅

---

🎀 SYNOPSIS 🎀

$PCP_PMDAS_DIR/pmdaresctrl [-D debug] [-d domain] [-l logfile]

look at her. tiny. powerful. 🫶

---

✨ DESCRIPTION ✨

so pmdaresctrl is a resctrl Performance Metrics Domain Agent (PMDA, keep up 🧚), and what she does is expose performance metrics values from the /sys/fs/resctrl interface so you can get info about the last level cache. that's the vibe. that's the whole job.

if you want even more deets on how linux handles last level cache metrics, the link is right here, go read it, i believe in you:

https://github.com/torvalds/linux/tree/master/Documentation/arch/x86/resctrl.rst

---

💜 INSTALLATION 💜

ok so if you want access to the names, help text and values for the resctrl performance metrics, do this as root:

# cd $PCP_PMDAS_DIR/resctrl
# ./Install

and if you want to ✨undo✨ the installation — and heads up, this removes both PMDAs, not just one, i said what i said 😭 — do this as root:

# cd $PCP_PMDAS_DIR/resctrl
# ./Remove

real talk: pmdaresctrl gets launched by pmcd(1) and should never be executed directly. like, never ever. 🙈

also the Install and Remove scripts are the ones that notify pmcd(1) when the agent gets installed or removed. they handle the gossiping, you don't have to. 🎀

---

🦋 FILES 🦋

• $PCP_PMCDCONF_PATH — the command line options used to launch pmdaresctrl
• $PCP_PMDAS_DIR/resctrl/help — the default help text file for the resctrl metrics
• $PCP_PMDAS_DIR/resctrl/Install — installation script for the pmdaresctrl agent
• $PCP_PMDAS_DIR/resctrl/Remove — undo installation script for the pmdaresctrl agent

---

🌈 PCP ENVIRONMENT 🌈

environment variables with the prefix PCP_ are what parameterize the file and directory names that PCP uses. every time you install, the file /etc/pcp.conf holds the local values for these variables. and the $PCP_CONF variable can be used to point at an alternative configuration file, exactly like pcp.conf(5) describes. iykyk. 💅

specifically speaking: $PCP_RESCTRL_DIR can be set to change the default directory away from /sys/fs/resctrl. yes, that default. that one right there. 🍓

---

🔥 DEBUGGING OPTIONS 🔥

the -D or --debug option turns on extra diagnostics output on stderr to help triage problems. lowkey though, that info is sometimes cryptic, and it's primarily meant to give guidance to developers rather than end-users. so like... it's not for the girlies, it's for the engineers. 😭

debug is a comma separated list of debugging options. and to get the full list of available debugging options plus what they mean, use pmdbg(1) with the -l option. go off, pmdbg(1). 👑

---

⭐ SEE ALSO ⭐

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

---

and that's the whole page bestie, no cap, ate and left no crumbs. this one's brought to you by Performance Co-Pilot, PCP version, and it's dated — mwah. 💖🎀🦋 slay, go read the other manpages, i'm obsessed with you.