pmdazfs(1) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | INSTALLATION | DEBUGGING OPTIONS | SEE ALSO | COLOPHON

PMDAZFS(1)               General Commands Manual               PMDAZFS(1)

NAME         top

       pmdazfs - ZFS filesystem performance metrics domain agent (PMDA)
       for Linux

SYNOPSIS         top

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

DESCRIPTION         top

       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         top

       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         top

       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:
       ┌────────┬────────────────────────────────────────────────────┐
       │ Option Description                                        │
       ├────────┼────────────────────────────────────────────────────┤
       │ appl0  │ warn if any of the ZFS stats files cannot be found │
       └────────┴────────────────────────────────────────────────────┘

SEE ALSO         top

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

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at 
       ⟨http://www.pcp.io/⟩.  If you have a bug report for this manual
       page, send it to [email protected].  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/performancecopilot/pcp.git⟩ on 2025-08-11.
       (At that time, the date of the most recent commit that was found
       in the repository was 2025-08-11.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there is
       a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       [email protected]

Performance Co-Pilot               PCP                         PMDAZFS(1)