1PMDABCC(1)                  General Commands Manual                 PMDABCC(1)
2
3
4

NAME

6       pmdabpf - eBPF PMDA
7

DESCRIPTION

9       pmdabpf  is  a  Performance  Co-Pilot  (PCP) Performance Metrics Domain
10       Agent (PMDA) which extracts live performance data  from  eBPF  programs
11       utilizing BPF CO-RE (libbpf and BTF).
12
13       pmdabpf  loads and acts as a bridge for any number of configured, sepa‐
14       rate bpf PMDA modules. Existing libbpf tools should be possible  to  be
15       utilized with the bpf PMDA modules with reasonable effort.
16
17       See  the eBPF, libbpf and BPF CO-RE documentation for detailed descrip‐
18       tions.
19

CONFIGURATION

21       pmdabpf reads a mandatory ini-style configuration file:
22
23              $PCP_PMDAS_DIR/bpf/bpf.conf
24
25       Each section of the file corresponds to one bpf PMDA module.  The  fol‐
26       lowing  global  options  are  available for every module (their default
27       values are shown in parenthesis):
28
29       enabled (unset)
30                      A boolean value to specify whether this bpf PMDA  module
31                      should be started or not.
32
33       Modules  may  also support additional module-specific configuration op‐
34       tions, refer to the default configuration file for their supported  op‐
35       tions.
36

INSTALLATION

38       To install, the following must be done as root:
39
40           # cd $PCP_PMDAS_DIR/bpf
41           # ./Install
42
43       To uninstall, the following must be done as root:
44
45           # cd $PCP_PMDAS_DIR/bpf
46           # ./Remove
47
48       pmdabpf  is  launched by pmcd(1) and should never be executed directly.
49       The Install and Remove scripts notify pmcd(1) when  the  agent  is  in‐
50       stalled or removed.
51
52       Some  modules  will  start providing values only after having collected
53       data from related system activity.
54

FILES

56       $PCP_PMDAS_DIR/bpf/bpf.conf
57            configuration file for the pmdabpf agent
58
59       $PCP_PMDAS_DIR/bpf/modules/*.{o,so}
60            bpf PMDA modules available for the pmdabpf agent
61
62       $PCP_PMDAS_DIR/bpf/Install
63            installation script for the pmdabpf agent
64
65       $PCP_PMDAS_DIR/bpf/Remove
66            undo installation script for the pmdabpf agent
67
68       $PCP_LOG_DIR/pmcd/bpf.log
69            default log file for messages from the pmdabpf agent
70
71       Note   that   the   usual/default   value   for    $PCP_PMDAS_DIR    is
72       /var/lib/pcp/pmdas and the default for $PCP_LOG_DIR is /var/log/pcp but
73       these settings are platform dependent.
74

PCP ENVIRONMENT

76       Environment variables with the prefix PCP_ are used to parameterize the
77       file  and  directory names used by PCP.  On each installation, the file
78       /etc/pcp.conf contains the  local  values  for  these  variables.   The
79       $PCP_CONF  variable may be used to specify an alternative configuration
80       file, as described in pcp.conf(5).
81

SEE ALSO

83       PCPIntro(1), bpf(1) and pmcd(1).
84
85
86
87Performance Co-Pilot                  PCP                           PMDABCC(1)
Impressum