---
name: "pmdanutcracker"
section: "1"
platform: "linux"
package: "pcp-pmda-nutcracker"
version: "7.2.2-2"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/pmdanutcracker"
---

# pmdanutcracker(1)

NutCracker performance metrics domain agent (PMDA)

## NAME

**pmdanutcracker** - NutCracker performance metrics domain agent (PMDA)

## DESCRIPTION

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

## INSTALLATION

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)](/pmcd/1.md) and should never be executed directly. The Install and Remove scripts notify [*pmcd*(1)](/pmcd/1.md) when the agent is installed or removed.

## FILES

- **$PCP\_PMDAS\_DIR/nutcracker/nutcracker.conf**

  mandatory configuration file listing monitored memcache or Redis instances

- **$PCP\_PMDAS\_DIR/nutcracker/Install**

  installation script for the **pmdanutcracker** agent

- **$PCP\_PMDAS\_DIR/nutcracker/Remove**

  undo installation script for the **pmdanutcracker** agent

- **$PCP\_LOG\_DIR/pmcd/nutcracker.log**

  default log file for error messages from **pmdanutcracker**

## PCP ENVIRONMENT

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)](/pcp.conf/5.md).

## SEE ALSO

[**PCPIntro**(1)](/PCPIntro/1.md), [**pmcd**(1)](/pmcd/1.md), [**pmdamemcache**(1)](/pmdamemcache/1.md) and [**pmdaredis**(1)](/pmdaredis/1.md).