1PMDASYSTEMD(1) General Commands Manual PMDASYSTEMD(1)
2
6 pmdasystemd - systemd performance metrics domain agent (PMDA)
7
9 $PCP_PMDAS_DIR/systemd/pmdasystemd [-f] [-d domain] [-l logfile] [-m
10 memory] [-s interval] [-U username]
11
13 pmdasystemd is a systemd log file monitoring Performance Metrics Domain
14 Agent (PMDA). It can be seen as analagous to the -f option to jour‐
15 nalctl(1) and converts each new log line into a performance event,
16 suitable for consumption by PMAPI(3) client tools like pmevent(1).
17 The systemd PMDA exports both event-style metrics reflecting times‐
19 tamped event records for messages logged to the system logs, as well as
20 the more orthodox sample-style metrics such as message counts and
21 throughput size values.
22 A brief description of the pmdasystemd command line options follows:
24 -d It is absolutely crucial that the performance metrics domain num‐
26 ber specified here is unique and consistent. That is, domain
27 should be different for every PMDA on the one host, and the same
28 domain number should be used for the same PMDA on all hosts.
29 -f Disables per-uid/gid record filtering. By default the user and
31 group credentials will be used to filter log records returned to
32 the client tool, preventing information exposure to arbitrary
33 users. This option disables that, so use only with extreme cau‐
34 tion.
35 -l Location of the log file. By default, a log file named sys‐
37 temd.log is written in the current directory of pmcd(1) when pm‐
38 dasystemd is started, i.e. $PCP_LOG_DIR/pmcd. If the log file
39 cannot be created or is not writable, output is written to the
40 standard error instead.
41 -m Limit the physical memory used by the PMDA to buffer event records
43 to maxsize bytes. As log events arrive at the PMDA, they must be
44 buffered until individual client tools request the next batch
45 since their previous batch of events. The default maximum is 2
46 megabytes.
47 -s Sets the polling interval for detecting newly arrived log lines.
49 Mirrors the same option from the tail(1) command.
50 -U User account under which to run the agent. The default is the
52 "adm" user account.
53
55 If you want access to the names, help text and values for the systemd
56 performance metrics, do the following as root:
57 # cd $PCP_PMDAS_DIR/systemd
59 # ./Install
60 If you want to undo the installation, do the following as root:
62 # cd $PCP_PMDAS_DIR/systemd
64 # ./Remove
65 pmdasystemd 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
71 $PCP_PMCDCONF_PATH
72 command line options used to launch pmdasystemd
73 $PCP_PMDAS_DIR/systemd/help
74 default help text file for the systemd metrics
75 $PCP_PMDAS_DIR/systemd/Install
76 installation script for the pmdasystemd agent
77 $PCP_PMDAS_DIR/systemd/Remove
78 undo installation script for the pmdasystemd agent
79 $PCP_LOG_DIR/pmcd/systemd.log
80 default log file for error messages and other information
81 from pmdasystemd
82
84 Environment variables with the prefix PCP_ are used to parameterize the
85 file and directory names used by PCP. On each installation, the file
86 /etc/pcp.conf contains the local values for these variables. The
87 $PCP_CONF variable may be used to specify an alternative configuration
88 file, as described in pcp.conf(5).
89
91 PCPIntro(1), pmcd(1), pmevent(1), journalctl(1), tail(1), PMAPI(3),
92 pcp.conf(5) and pcp.env(5).
93Performance Co-Pilot PCP PMDASYSTEMD(1)