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

NAME

6       pcp, pcp-summary - run a command or summarize an installation
7

SYNOPSIS

9       pcp [pcp options...]  pcp-command [command options...]
10       pcp [-P] [-a archive] [-h host] [-n pmnsfile]
11

DESCRIPTION

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 set of  PCP  archives.   This  mode
17       indirectly invokes the pcp-summary command (in the absence of any other
18       requested command).
19
20       Alternatively, a command can be passed to pcp to run, again possibly in
21       the context of a remote host or set of historical archives.
22

COMMAND MODE

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
32       This  provides  a  convenient  mechanism for obtaining retrospective or
33       remote monitoring capabilities while preserving the  behaviour  of  the
34       system tools.
35
36       For  example,  the  pcp-free(1)  utility can be invoked as follows, for
37       recorded data from host munch:
38
39       $ 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
45       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

SUMMARY MODE

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
56       With no arguments, pcp reports on the local host, however the following
57       options are accepted:
58
59       -a archive
60              Report  the PCP configuration as described in the set of PCP ar‐
61              chive logs, archive, which is a comma-separated list  of  names,
62              each  of which may be the base name of an archive or the name of
63              a directory containing one or more archives.
64
65       -h host
66              Report the PCP configuration on host rather than the local host.
67
68       -n pmnsfile
69              Load an alternative Performance  Metrics  Name  Space  (pmns(5))
70              from the file pmnsfile.
71
72       -P     Display  pmie performance information - counts of rules evaluat‐
73              ing to true, false, or indeterminate, as well  as  the  expected
74              rate  of  rule calculation, for each pmie process running on the
75              default host.  Refer to the individual metric help text for full
76              details on these values.
77
78       All  of  the displayed values are performance metric values and further
79       information for each can be obtained using the command:
80
81          $ pminfo -dtT metric
82
83       The complete set of metrics required by pcp to produce  its  output  is
84       contained in $PCP_VAR_DIR/config/pmlogconf/tools/pcp-summary.
85

FILES

87       $HOME/.pcp/bin
88                 Per-user location for command scripts.
89       $PCP_BINADM_DIR
90                 System location for installed command scripts.
91       $PCP_VAR_DIR/config/pmlogconf/tools/pcp-summary
92                 pmlogconf(1)  configuration  file  for  collecting all of the
93                 metrics required by pcp.
94

PCP ENVIRONMENT

96       Environment variables with the prefix PCP_ are used to parameterize the
97       file  and  directory names used by PCP.  On each installation, the file
98       /etc/pcp.conf contains the  local  values  for  these  variables.   The
99       $PCP_CONF  variable may be used to specify an alternative configuration
100       file, as described in pcp.conf(5).
101

SEE ALSO

103       PCPIntro(1),   pcp-free(1),   pcp-numastat(1),   pcp-python(1),    pcp-
104       uptime(1),  pcp-verify(1), pmcd(1), pmie(1), pmlogconf(1), pmlogger(1),
105       pcp.conf(5) and pcp.env(5).
106

DIAGNOSTICS

108       pcp will terminate with an exit status of 1 if pmcd on the target  host
109       could  not  be reached or the set of archives could not be opened, or 2
110       for any other error.
111
112
113
114Performance Co-Pilot                  PCP                               PCP(1)
Impressum