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 [bpftrace] and  [dynamic_scripts]  sections.   If
18       you   enable   the  dynamic  scripts  functionality,  please  refer  to
19       https://pcp.io/docs/lab.auth.html on how to setup authentication.  This
20       is  highly  recommended,  as otherwise anyone could run any bpftrace(8)
21       script as root.
22
23       [bpftrace] section specifies values for the following  settings  (their
24       default values are shown in parenthesis):
25
26       bpftrace_path (bpftrace)
27                      Path to the bpftrace(8) executable.
28
29       script_expiry_time (60)
30                      Unnamed  scripts  are  removed after this period of time
31                      (in seconds) in case there  has  been  no  requests  for
32                      their values.
33
34       max_throughput (2097152)
35                      Maximum throughput of bpftrace scripts in bytes.
36
37       [dynamic_scripts]  section  specifies values for the following settings
38       (their default values are shown in parenthesis):
39
40       enabled (false)
41                      A boolean value to  specify  whether  script  should  be
42                      started   on  demand,  by  executing  pmStore  (3)  bpf‐
43                      trace.control.register.  This feature needs  to  be  en‐
44                      abled for the PCP bpftrace datasource in grafana-pcp.
45
46       auth_enabled (true)
47                      A boolean value to specify whether authentication is re‐
48                      quired or not.  Please see the note above on authentica‐
49                      tion setup.
50
51       allowed_users (root)
52                      A comma-separated list of usernames which are allowed to
53                      register bpftrace(8) scripts.
54

INSTALLATION

56       To install, the following must be done as root:
57
58           # cd $PCP_PMDAS_DIR/bpftrace
59           # ./Install
60
61       To uninstall, the following must be done as root:
62
63           # cd $PCP_PMDAS_DIR/bpftrace
64           # ./Remove
65
66       pmdabpftrace is launched by pmcd(1) and should never  be  executed  di‐
67       rectly.   The  Install and Remove scripts notify pmcd(1) when the agent
68       is installed or removed.
69

FILES

71       $PCP_PMDAS_DIR/bpftrace/bpftrace.conf
72            configuration file for the pmdabpftrace agent
73
74       $PCP_PMDAS_DIR/bpftrace/Install
75            installation script for the pmdabpftrace agent
76
77       $PCP_PMDAS_DIR/bpftrace/Remove
78            undo installation script for the pmdabpftrace agent
79
80       $PCP_LOG_DIR/pmcd/bpftrace.log
81            default log file for messages from the pmdabpftrace agent
82
83       Note   that   the   usual/default   value   for    $PCP_PMDAS_DIR    is
84       /var/lib/pcp/pmdas and the default for $PCP_LOG_DIR is /var/log/pcp but
85       these settings are platform dependent.
86

PCP ENVIRONMENT

88       Environment variables with the prefix PCP_ are used to parameterize the
89       file  and  directory names used by PCP.  On each installation, the file
90       /etc/pcp.conf contains the  local  values  for  these  variables.   The
91       $PCP_CONF  variable may be used to specify an alternative configuration
92       file, as described in pcp.conf(5).
93

SEE ALSO

95       PCPIntro(1), pmcd(1) and bpftrace(8).
96
97
98
99Performance Co-Pilot                  PCP                      PMDABPFTRACE(1)
Impressum