Section 1 · User commands

pmdaresctrl.1

Package: pcp-doc

On this page

PMDARESCTRL

NAME
SYNOPSIS
DESCRIPTION
INSTALLATION
FILES
PCP ENVIRONMENT
SEE ALSO

NAME

pmdaresctrl − resctrl performance metrics domain agent (PMDA)

SYNOPSIS

$PCP_PMDAS_DIR/pmdaresctrl [−d domain] [−l logfile]

DESCRIPTION

pmdaresctrl is a resctrl Performance Metrics Domain Agent (PMDA) which exposes performance metrics values from the /sys/fs/resctrl interface to provide information on the last level cache.

Further details on linux support for last level cache metrics can be found at https://github.com/torvalds/linux/tree/master/Documentation/arch/x86/resctrl.rst.

INSTALLATION

If you want access to the names, help text and values for the resctrl performance metrics, do the following as root:

cd $PCP_PMDAS_DIR/resctrl

./Install

If you want to undo the installation (and remove both PMDAs), do the following as root:

cd $PCP_PMDAS_DIR/resctrl

./Remove

pmdaresctrl 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

$PCP_PMCDCONF_PATH

command line options used to launch pmdaresctrl

$PCP_PMDAS_DIR/resctrl/help

default help text file for the resctrl metrics

$PCP_PMDAS_DIR/resctrl/Install

installation script for the pmdaresctrl agent

$PCP_PMDAS_DIR/resctrl/Remove

undo installation script for the pmdaresctrl agent

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). In particular, the $PCP_RESCTRL_DIR may be set to change the default directory from /sys/fs/resctrl.