|
NAME | SYNOPSIS | DESCRIPTION | CONFIGURATION | INSTALLATION | FILES | PCP ENVIRONMENT | DEBUGGING OPTIONS | SEE ALSO | COLOPHON |
|
|
|
PMDABCC(1) General Commands Manual PMDABCC(1)
pmdabpf - eBPF PMDA
$PCP_PMDAS_DIR/bpf/pmdabpf [-D debug]
pmdabpf is a Performance Co-Pilot (PCP) Performance Metrics Domain
Agent (PMDA) which extracts live performance data from eBPF
programs utilizing BPF CO-RE (libbpf and BTF).
pmdabpf loads and acts as a bridge for any number of configured,
separate bpf PMDA modules. Existing libbpf tools should be
possible to be utilized with the bpf PMDA modules with reasonable
effort.
See the eBPF, libbpf and BPF CO-RE documentation for detailed
descriptions.
pmdabpf reads a mandatory ini-style configuration file:
$PCP_PMDAS_DIR/bpf/bpf.conf
Each section of the file corresponds to one bpf PMDA module. The
following global options are available for every module (their
default values are shown in parenthesis):
enabled (unset)
A boolean value to specify whether this bpf PMDA module
should be started or not.
Modules may also support additional module-specific configuration
options, refer to the default configuration file for their
supported options.
To install, the following must be done as root:
# cd $PCP_PMDAS_DIR/bpf
# ./Install
To uninstall, the following must be done as root:
# cd $PCP_PMDAS_DIR/bpf
# ./Remove
pmdabpf 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.
Some modules will start providing values only after having
collected data from related system activity.
$PCP_PMDAS_DIR/bpf/bpf.conf
configuration file for the pmdabpf agent
$PCP_PMDAS_DIR/bpf/modules/*.{o,so}
bpf PMDA modules available for the pmdabpf agent
$PCP_PMDAS_DIR/bpf/Install
installation script for the pmdabpf agent
$PCP_PMDAS_DIR/bpf/Remove
undo installation script for the pmdabpf agent
$PCP_LOG_DIR/pmcd/bpf.log
default log file for messages from the pmdabpf agent
Note that the usual/default value for $PCP_PMDAS_DIR is
/var/lib/pcp/pmdas and the default for $PCP_LOG_DIR is
/var/log/pcp but these settings are platform dependent.
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).
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.
PCPIntro(1), bpf(1) and pmcd(1).
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 PMDABCC(1)
Pages that refer to this page: pcp-atop(1)