1PCP(1) General Commands Manual PCP(1)
2
6 pcp, pcp-summary - run a command or summarize an installation
7
9 pcp [pcp options...] pcp-command [command options...]
10 pcp [-P] [-a archive] [-h host] [-n pmnsfile]
11
13 The pcp command is used in one of two modes. By default, it summarizes
14 the Performance Co-Pilot (PCP) installation on the local host. This
15 mode can also be used to summarize the installation from a remote host,
16 or a historical installation from a PCP archive. This mode indirectly
17 invokes the pcp-summary command (in the absence of any other requested
18 command).
19 Alternatively, a command can be passed to pcp to run, again possibly in
21 the context of a remote host or historical archive.
22
24 When pcp is invoked with a command to run, it will search for the named
25 command in $PCP_BINADM_DIR and also $HOME/.pcp/bin (these are usually
26 scripts, and are installed with a "pcp-" prefix). This mode of opera‐
27 tion allows system performance tools to be implemented using PMAPI(3)
28 services, while still preserving all of their usual command line
29 options. These options are thus (indirectly) augmented with the stan‐
30 dard PCP option set, as described in PCPIntro(1).
31 This provides a convenient mechanism for obtaining retrospective or
33 remote monitoring capabilities while preserving the behaviour of the
34 system tools.
35 For example, the pcp-free(1) utility can be invoked as follows, for
37 recorded data from host munch:
38 $ pcp -a $PCP_LOG_DIR/pmlogger/munch/20140317 -O 11:35:50am free -m
40 total used free shared buffers cached
41 Mem: 23960 14554 9406 0 176 2137
42 -/+ buffers/cache: 12240 11720
43 Swap 12047 0 12047
44 A complete list of the available and installed tools is provided along
46 with the pcp(1) usage message, but some examples include: pcp-free(1),
47 pcp-uptime(1) and pcp-numastat(1).
48
50 The summary report includes: the OS version, a summary of the hardware
51 inventory, the local timezone, the PCP software version, the state of
52 the pmcd(1) process and associated Performance Metrics Domain Agents
53 (PMDAs), as well as information about any PCP archive loggers (pmlog‐
54 ger(1)) and PCP inference engines (pmie(1)) that are running.
55 With no arguments, pcp reports on the local host, however the following
57 options are accepted:
58 -a archive
60 Report the PCP configuration as described in the PCP archive log
61 archive.
62 -h host
64 Report the PCP configuration on host rather than the local host.
65 -n pmnsfile
67 Load an alternative Performance Metrics Name Space (pmns(5))
68 from the file pmnsfile.
69 -P Display pmie performance information - counts of rules evaluat‐
71 ing to true, false, or indeterminate, as well as the expected
72 rate of rule calculation, for each pmie process running on the
73 default host. Refer to the individual metric help text for full
74 details on these values.
75 All of the displayed values are performance metric values and further
77 information for each can be obtained using the command:
78 $ pminfo -dtT metric
80 The complete set of metrics required by pcp to produce its output is
82 contained in $PCP_VAR_DIR/config/pmlogconf/tools/pcp-summary.
83
85 $HOME/.pcp/bin
86 Per-user location for command scripts.
87 $PCP_BINADM_DIR
88 System location for installed command scripts.
89 $PCP_VAR_DIR/config/pmlogconf/tools/pcp-summary
90 pmlogconf(1) configuration file for collecting all of the
91 metrics required by pcp.
92
94 Environment variables with the prefix PCP_ are used to parameterize the
95 file and directory names used by PCP. On each installation, the file
96 /etc/pcp.conf contains the local values for these variables. The
97 $PCP_CONF variable may be used to specify an alternative configuration
98 file, as described in pcp.conf(5).
99
101 PCPIntro(1), pcp-free(1), pcp-numastat(1), pcp-python(1), pcp-
102 uptime(1), pcp-verify(1), pmcd(1), pmie(1), pmlogconf(1), pmlogger(1),
103 pcp.conf(5) and pcp.env(5).
104
106 pcp will terminate with an exit status of 1 if pmcd on the target host
107 could not be reached or the archive could not be opened, or 2 for any
108 other error.
109Performance Co-Pilot PCP PCP(1)