PMDAZFS(1)

๐Ÿ’– NAME ๐Ÿ’–

pmdazfs โ€” bestie, it's the ZFS filesystem performance metrics domain agent (PMDA) for Linux. Yes, the whole thing. Say it with me ๐Ÿซถ


โœจ SYNOPSIS โœจ

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

That's it, that's the whole summoning ritual ๐Ÿ”ฎ


๐ŸŒธ DESCRIPTION ๐ŸŒธ

Okay so. pmdazfs is a Performance Metrics Domain Agent (PMDA), and what it does is extract performance metrics describing the state of the ZFS filesystem from the stats files chillin' in /proc. That's the vibe. It just. Reads the files. And tells you everything ๐Ÿฆ‹

The zfs PMDA exports metrics that measure info about caching (ARC, L2ARC, ZIL, VDEV), buffering, RAIDZ, dnode operations and pools IO. So like, every little thing your ZFS is doing? It knows. Main character energy fr fr ๐Ÿ‘‘

A brief description of the pmdazfs command line options follows โ€” and yes bestie I'm giving you the full rundown, no skipping:

  • -d โ€” The performance metrics domain number must be set to a unique value. Unique!! Not "eh, close enough". Don't be that girl ๐Ÿ™ˆ
  • -l โ€” Location of the log file. By default, a log file named zfs.log gets written in the current directory of pmcd(1) when pmdazfs is started, i.e. $PCP_LOG_DIR/pmcd. And if the log file can't be created, or isn't writable? Then output goes to standard error instead. It always has a backup plan, we love a resilient queen ๐Ÿ’…

๐ŸŽ€ INSTALLATION ๐ŸŽ€

So here's the thing. OpenZFS is not included in PCP โ€” it's not just gonna appear, babes ๐Ÿ˜ญ โ€” and it has to be installed on the system from the available packages or source.

Once OpenZFS is installed and configured, the stats files should appear in /proc, and the PMDA can be added to PMCD using the Install script:

# cd $PCP_PMDAS_DIR/zfs
# ./Install

And to remove the PMDA, use the Remove script:

# cd $PCP_PMDAS_DIR/zfs
# ./Remove

Install, remove, slay, repeat ๐ŸŒˆ


๐Ÿ”ฅ DEBUGGING OPTIONS ๐Ÿ”ฅ

The -D or --debug option enables the output of additional diagnostics on stderr to help triage problems. Ngl though โ€” the information is sometimes cryptic and primarily intended to provide guidance for developers rather than for end-users. So like, it's giving secret dev language ๐Ÿ’€

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 get the full menu, bestie ๐Ÿ“œ

Debugging options specific to pmdazfs are as follows:

  • appl0 โ€” warn if any of the ZFS stats files cannot be found. It's the "hey girl, something's missing" alarm ๐Ÿšจ

๐ŸŒŸ SEE ALSO ๐ŸŒŸ

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


Okay that's the whole page!! This one comes to you from the Performance Co-Pilot (PCP) girlies, and it's pmdazfs(1) โ€” the Linux ZFS PMDA โ€” and if you take one thing away from this, take the Install script. Periodt ๐Ÿ’–โœจ๐ŸŽ€๐Ÿฆ‹

๐Ÿ“ฆ where this page comes from