1PMCLIENT(1) General Commands Manual PMCLIENT(1)
2
6 pmclient - a simple performance metrics client
7
9 pmclient [-a archive] [-h host] [-n pmnsfile] [-p] [-S numsec] [-s sam‐
10 ples] [-t interval] [-Z timezone] [-z]
11
13 pmclient is a simple client that uses the Performance Metrics Applica‐
14 tion Programming Interface (PMAPI) to report some high-level system
15 performance metrics.
16 The real value of pmclient is as a sample client using the PMAPI(3),
18 interfaces and to this end the source code is included with the Perfor‐
19 mance Co-Pilot (PCP) package (see PCPIntro(1)), and is typically
20 installed in /usr/share/pcp/demos/pmclient.
21 Normally pmclient operates on the distributed Performance Metrics Name
23 Space (PMNS), however if the -n option is specified an alternative
24 local PMNS is loaded from the file pmnsfile.
25 Unless directed to another host by the -h option, or to an archive by
27 the -a option, pmclient will contact the Performance Metrics Collector
28 Daemon (PMCD) on the local host to obtain the required information.
29 The -a and -h options are mutually exclusive.
30 By default, pmclient reports the time of day according to the local
32 timezone on the system where pmclient is run. The -Z option changes
33 the timezone to timezone in the format of the environment variable TZ
34 as described in environ(7). The -z option changes the timezone to the
35 local timezone at the host that is the source of the performance met‐
36 rics, as identified via either the -h or -a options.
37 Other options control the specific information to be reported.
39 -p The default behavior for replaying an archive, is to replay at
41 full speed. The -p option may be used in conjunction with an
42 archive, to request that the prevailing real-time delay be
43 applied between samples (see -t) to effect a pause.
44 -S numsec
46 The -S option may be used in conjunction with an archive to
47 request that display start at the time numsec seconds from the
48 start of the archive.
49 -s samples
51 The argument samples defines the number of samples to be
52 retrieved and reported. If samples is 0 or -s is not specified,
53 pmclient will sample and report continuously (in real time mode)
54 or until the end of the PCP archive (in archive mode).
55 -t interval
57 The default update interval may be set to something other than
58 the default 5 seconds. The interval argument follows the syntax
59 described in PCPIntro(1), and in the simplest form may be an
60 unsigned integer (the implied units in this case are seconds).
61 The output from pmclient is directed to standard output, and lists
63 + Aggregate CPU utilization, in the range 0 to 1.
65 + If the system has more than 1 CPU, the ordinal number of the busiest
67 CPU, in the range 0 to ...
68 + If the system has more than 1 CPU, the CPU utilization for the
70 busiest CPU.
71 + Real free memory in Mbytes.
73 + Aggregate physical disk I/O operations per second (IOPS).
75 + Load average over the last 1 minute and over the last 15 minutes.
77
79 $PCP_DEMOS_DIR/pmclient
80 source code, documentation, configuration files and Makefile
81 when the PCP development package is installed
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), pmchart(1), pmdumptext(1), pmgenmap(1),
92 pminfo(1), pmrep(1), pmstat(1), pmval(1), PMAPI(3), pcp.conf(5) and
93 pcp.env(5).
94
96 All are generated on standard error, and are intended to be self-
97 explanatory.
98Performance Co-Pilot PCP PMCLIENT(1)