pmdanutcracker(1) — Linux manual page


PMDANUTCRACKER(1)          General Commands Manual         PMDANUTCRACKER(1)

NAME         top

       pmdanutcracker - NutCracker performance metrics domain agent (PMDA)

DESCRIPTION         top

       This PMDA extracts performance data from NutCracker (or TwemProxy), a
       fast and lightweight proxy for memcached and Redis protocol.

INSTALLATION         top

       Configure to export statistics via its stats interface (see --stats-
       port option to the nutcracker server).  The corresponding
       configuration must be reflected in the
       $PCP_PMDAS_DIR/nutcracker/nutcracker.conf file.

           # cd $PCP_PMDAS_DIR/nutcracker
           # [ edit nutcracker.conf ]

       Once this is setup, you can access the names and values for the
       nutcracker performance metrics by doing the following as root:

           # cd $PCP_PMDAS_DIR/nutcracker
           # ./Install

       To uninstall, the following must be done as root:

           # cd $PCP_PMDAS_DIR/nutcracker
           # ./Remove

       pmdanutcracker is launched by pmcd(1) and should never be executed
       directly. The Install and Remove scripts notify pmcd(1) when the
       agent is installed or removed.

FILES         top

           mandatory configuration file listing monitored memcache or Redis

           installation script for the pmdanutcracker agent

           undo installation script for the pmdanutcracker agent

           default log file for error messages from pmdanutcracker


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

SEE ALSO         top

       PCPIntro(1), pmcd(1), pmdamemcache(1) and pmdaredis(1).

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at ⟨⟩.
       If you have a bug report for this manual page, send it to  This page was obtained from the project's upstream
       Git repository ⟨⟩ on
       2020-08-13.  (At that time, the date of the most recent commit that
       was found in the repository was 2020-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

Performance Co-Pilot                 PCP                   PMDANUTCRACKER(1)