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

NAME

6       pmdabpftrace - bpftrace PMDA
7

DESCRIPTION

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

CONFIGURATION

13       pmdabpftrace reads an optional ini-style configuration file:
14
15              $PCP_PMDAS_DIR/bpftrace/bpftrace.conf
16
17       This file may contain [authentication] and [bpftrace] sections.  Please
18       refer  to ⟨https://pcp.io/docs/lab.auth.html⟩ on how to setup authenti‐
19       cation which is highly recommended as otherwise anyone  could  run  any
20       bpftrace(8) script as root.
21
22       [authentication]  section  specifies  values for the following settings
23       (their default values are shown in parenthesis):
24
25       enabled (True) A  boolean  value  to  specify  whether  authention   is
26                      required  or  not.  Please see the note above on authen‐
27                      tion setup.
28
29       allowed_users (root)
30                      A comma-separated list of usernames which are allowed to
31                      register bpftrace(8) scripts.
32
33       [bpftrace]  section  specifies values for the following settings (their
34       default values are shown in parenthesis):
35
36       bpftrace_path (bpftrace)
37                      Path to the bpftrace(8) executable.
38
39       script_expiry_time (60)
40                      Unnamed scripts are removed after this  period  of  time
41                      (in  seconds)  in  case  there  has been no requests for
42                      their values.
43

INSTALLATION

45       To install, the following must be done as root:
46
47           # cd $PCP_PMDAS_DIR/bpftrace
48           # ./Install
49
50       To uninstall, the following must be done as root:
51
52           # cd $PCP_PMDAS_DIR/bpftrace
53           # ./Remove
54
55       pmdabpftrace is launched  by  pmcd(1)  and  should  never  be  executed
56       directly.  The Install and Remove scripts notify pmcd(1) when the agent
57       is installed or removed.
58

FILES

60       $PCP_PMDAS_DIR/bpftrace/bpftrace.conf
61            configuration file for the pmdabpftrace agent
62
63       $PCP_PMDAS_DIR/bpftrace/Install
64            installation script for the pmdabpftrace agent
65
66       $PCP_PMDAS_DIR/bpftrace/Remove
67            undo installation script for the pmdabpftrace agent
68
69       $PCP_LOG_DIR/pmcd/bpftrace.log
70            default log file for messages from the pmdabpftrace agent
71
72       Note   that   the   usual/default   value   for    $PCP_PMDAS_DIR    is
73       /var/lib/pcp/pmdas and the default for $PCP_LOG_DIR is /var/log/pcp but
74       these settings are platform dependent.
75

PCP ENVIRONMENT

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

SEE ALSO

84       PCPIntro(1), pmcd(1) and bpftrace(8).
85
86
87
88Performance Co-Pilot                  PCP                      PMDABPFTRACE(1)