pmdabpftrace(1) — Linux manual page


PMDABPFTRACE(1)            General Commands Manual           PMDABPFTRACE(1)

NAME         top

       pmdabpftrace - bpftrace PMDA

DESCRIPTION         top

       pmdabpftrace is a Performance Co-Pilot (PCP) Performance Metrics
       Domain Agent (PMDA) which exports metrics from bpftrace(8) scripts.


       pmdabpftrace reads an optional ini-style configuration file:


       This file may contain [authentication] and [bpftrace] sections.
       Please refer to on how to setup
       authentication which is highly recommended as otherwise anyone could
       run any bpftrace(8) script as root.

       [authentication] section specifies values for the following settings
       (their default values are shown in parenthesis):

       enabled (True) A boolean value to specify whether authention is
                      required or not.  Please see the note above on
                      authention setup.

       allowed_users (root)
                      A comma-separated list of usernames which are allowed
                      to register bpftrace(8) scripts.

       [bpftrace] section specifies values for the following settings (their
       default values are shown in parenthesis):

       bpftrace_path (bpftrace)
                      Path to the bpftrace(8) executable.

       script_expiry_time (60)
                      Unnamed scripts are removed after this period of time
                      (in seconds) in case there has been no requests for
                      their values.

INSTALLATION         top

       To install, the following must be done as root:

           # cd $PCP_PMDAS_DIR/bpftrace
           # ./Install

       To uninstall, the following must be done as root:

           # cd $PCP_PMDAS_DIR/bpftrace
           # ./Remove

       pmdabpftrace 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

            configuration file for the pmdabpftrace agent

            installation script for the pmdabpftrace agent

            undo installation script for the pmdabpftrace agent

            default log file for messages from the pmdabpftrace 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).

SEE ALSO         top

       PCPIntro(1), pmcd(1) and bpftrace(8).

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                     PMDABPFTRACE(1)

Pages that refer to this page: pcp-collectl(1)pcpcompat(1)PCPCompat(1)pmmgr(1)pmwebd(1)