pcp-summary(1)

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 [-LPV?]  [-a archive] [-h host] [-O origin] [-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       All of the displayed values are performance metric values  and  further
57       information for each can be obtained using the command:
58
59          $ pminfo -dtT metric
60
61       The  complete  set  of metrics required by pcp to produce its output is
62       contained in $PCP_VAR_DIR/config/pmlogconf/tools/pcp-summary.
63

SUMMARY MODE OPTIONS

65       With no arguments, pcp reports on the local host, however the following
66       options are accepted:
67
68       -a archive, --archive=archive
69            Report  the  PCP  configuration as described in the set of PCP ar‐
70            chive logs, archive, which is a  comma-separated  list  of  names,
71            each  of which may be the base name of an archive or the name of a
72            directory containing one or more archives.
73
74       -h host, --host=host
75            Report the PCP configuration on host rather than the local host.
76
77       -L, --local-PMDA
78            Use a local context to collect metrics from DSO PMDAs on the local
79            host without PMCD.
80
81       -n pmnsfile, --namespace=pmnsfile
82            Load  an alternative Performance Metrics Name Space (PMNS(5)) from
83            the file pmnsfile.
84
85       -O origin, --origin=origin
86            When reporting archived metrics, start reporting at origin  within
87            the time window.
88
89       -P, --pmie
90            Display pmie(1) performance information - counts of rules evaluat‐
91            ing to true, false, or indeterminate, as well as the expected rate
92            of  rule calculation, for each pmie process running on the default
93            host.  Refer to the individual metric help text for  full  details
94            on these values.
95
96       -V, --version
97            Display version number and exit.
98
99       -?, --help
100            Display usage message and exit.
101

DIAGNOSTICS

103       pcp  will terminate with an exit status of 1 if pmcd on the target host
104       could not be reached or the set of archives could not be opened,  or  2
105       for any other error.
106

FILES

108       $HOME/.pcp/bin
109            Per-user location for command scripts.
110
111       $PCP_BINADM_DIR
112            System location for installed command scripts.
113
114       $PCP_VAR_DIR/config/pmlogconf/tools/pcp-summary
115            pmlogconf(1)  configuration file for collecting all of the metrics
116            required by pcp
117

PCP ENVIRONMENT

119       Environment variables with the prefix PCP_ are used to parameterize the
120       file  and  directory names used by PCP.  On each installation, the file
121       /etc/pcp.conf contains the  local  values  for  these  variables.   The
122       $PCP_CONF  variable may be used to specify an alternative configuration
123       file, as described in pcp.conf(5).
124
125       For environment variables affecting PCP tools, see pmGetOptions(3).
126