pmdazfs - Man Page

ZFS filesystem performance metrics domain agent (PMDA) for Linux

Synopsis

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

Description

pmdazfs is a Performance Metrics Domain Agent (PMDA) which extracts performance metrics describing the state of the ZFS filesystem from the stats files located in /proc.

The zfs PMDA exports metrics that measure information about caching (ARC, L2ARC, ZIL, VDEV), buffering, RAIDZ, dnode operations and pools IO.

A brief description of the pmdazfs command line options follows:

-d

The performance metrics domain number must be set to a unique value.

-l

Location of the log file. By default, a log file named zfs.log is written in the current directory of pmcd(1) when pmdazfs is started, i.e. $PCP_LOG_DIR/pmcd. If the log file cannot be created or is not writable, output is written to the standard error instead.

Installation

OpenZFS is not included in PCP, and 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 PMDA can be added to PMCD using the Install script:

# cd $PCP_PMDAS_DIR/zfs
# ./Install

To remove PMDA use the Remove script:

# cd $PCP_PMDAS_DIR/zfs
# ./Remove

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 end-users. 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.

Debugging options specific to pmdazfs are as follows:

OptionDescription
appl0warn if any of the ZFS stats files cannot be found

See Also

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

Info

PCP Performance Co-Pilot