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, and
18 to this end the source code is shipped on both Irix, where it is
19 included in the pcp.sw.demo images of the Performance Co-Pilot (PCP)
20 product (see PCPIntro(1)), and on Linux, where it is included into the
21 PCP Source RPM.
22 Normally pmclient operates on the distributed Performance Metrics Name
24 Space (PMNS), however if the -n option is specified an alternative
25 local PMNS is loaded from the file pmnsfile.
26 Unless directed to another host by the -h option, or to an archive by
28 the -a option, pmclient will contact the Performance Metrics Collector
29 Daemon (PMCD) on the local host to obtain the required information.
30 The -a and -h options are mutually exclusive.
31 By default, pmclient reports the time of day according to the local
33 timezone on the system where pmclient is run. The -Z option changes
34 the timezone to timezone in the format of the environment variable TZ
35 as described in environ(5). The -z option changes the timezone to the
36 local timezone at the host that is the source of the performance met‐
37 rics, as identified via either the -h or -a options.
38 Other options control the specific information to be reported.
40 -p The default behavior for replaying an archive, is to replay at
42 full speed. The -p option may be used in conjunction with an
43 archive, to request that the prevailing real-time delay be
44 applied between samples (see -t) to effect a pause.
45 -S numsec
47 The -S option may be used in conjunction with an archive to
48 request that display start at the time numsec seconds from the
49 start of the archive.
50 -s samples
52 The argument samples defines the number of samples to be
53 retrieved and reported. If samples is 0 or -s is not specified,
54 pmclient will sample and report continuously (in real time mode)
55 or until the end of the PCP archive (in archive mode).
56 -t interval
58 The default update interval may be set to something other than
59 the default 5 seconds. The interval argument follows the syntax
60 described in PCPIntro(1), and in the simplest form may be an
61 unsigned integer (the implied units in this case are seconds).
62 The output from pmclient is directed to standard output, and lists
64 + Aggregate CPU utilization, in the range 0 to 1.
66 + If the system has more than 1 CPU, the ordinal number of the busiest
68 CPU, in the range 0 to ...
69 + If the system has more than 1 CPU, the CPU utilization for the
71 busiest CPU.
72 + Real free memory in Mbytes.
74 + Aggregate physical disk I/O operations per second (IOPS).
76 + Load average over the last 1 minute and over the last 15 minutes.
78
80 $PCP_VAR_DIR/pmns/*
81 default PMNS specification files
82 $PCP_DEMOS_DIR/pmclient
83 source code and Makefiles when pcp.sw.demo is installed
84 $PCP_VAR_DIR/config/pmlogger/config.pmclient
85 pmlogger(1) configuration for creating an archive suitable
86 for replay with pmclient
87
89 Environment variables with the prefix PCP_ are used to parameterize the
90 file and directory names used by PCP. On each installation, the file
91 /etc/pcp.conf contains the local values for these variables. The
92 $PCP_CONF variable may be used to specify an alternative configuration
93 file, as described in pcp.conf(4).
94
96 PCPIntro(1), pmcd(1), pmchart(1), pmgenmap(1), pmstat(1), PMAPI(3),
97 pcp.conf(4) and pcp.env(4).
98
100 All are generated on standard error, and are intended to be self-
101 explanatory.
102Performance Co-Pilot SGI PMCLIENT(1)