1PMINFO(1) General Commands Manual PMINFO(1)
2
6 pminfo - display information about performance metrics
7
9 pminfo [-dfFIlLmMstTvVxz?] [-a archive] [-b batchsize] [-c dmfile]
10 [--container name] [-h hostname] [-K spec] [-[n|N] pmnsfile] [-O time]
11 [-Z timezone] [metricname | pmid | indom]...
12
14 pminfo displays various types of information about performance metrics
15 available through the facilities of the Performance Co-Pilot (PCP).
16 The metrics of interest are named in the metricname arguments. If met‐
18 ricname is a non-leaf node in the PMNS, then pminfo will recursively
19 descend the PMNS and report on all leaf nodes. If no metricname argu‐
20 ment is given, the root of the PMNS is used.
21 If the metricname argument is in numeric dotted notation, it is inter‐
23 preted as either a 3-dotted pmid (metric identifier - domain, cluster,
24 item numbers) or a 2-dotted indom (instance domain identifier - domain,
25 serial number). In the pmid case, a reverse PMID-to-name lookup is
26 performed, and in the indom case, the instance domain is reported di‐
27 rectly. This latter mode can be used to report the instance domain
28 ``one line'' and long form help text summaries.
29 Unless directed to another host by the -h option, by default pminfo
31 will contact the Performance Metrics Collector Daemon (PMCD) on the lo‐
32 cal host. The connection to a PMCD is only required if pminfo requires
33 distributed PMNS information, and/or meta-data describing metrics,
34 and/or metric values, and/or help text.
35 The -a option causes pminfo to use the specified set of archives rather
37 than connecting to a PMCD.
38 The -L option causes pminfo to use a local context to collect metrics
40 from PMDAs on the local host without PMCD. Only some metrics are
41 available in this mode.
42 The -a, -h and -L options are mutually exclusive.
44
46 The available command line options are:
47 -a archive, --archive=archive
49 Performance metric values are retrieved from the set of Perfor‐
50 mance Co-Pilot (PCP) archive files identified by the archive argu‐
51 ment, which is a comma-separated list of names, each of which may
52 be the base name of an archive or the name of a directory contain‐
53 ing one or more archives.
54 -b, --batch
56 This option may be used to define the maximum number of metrics to
57 be fetched in a single request for the -f and -v options. The de‐
58 fault value for batchsize is 128.
59 -c dmfile, --derived=dmfile
61 The dmfile argument specifies a file that contains derived metric
62 definitions in the format described for pmLoadDerivedConfig(3).
63 The -c option provides a way to load derived metric definitions
64 that is an alternative to the more generic use of the PCP_DE‐
65 RIVED_CONFIG environment variable as described in PCPIntro(1).
66 Using the -c option and the PCP_DERIVED_CONFIG environment vari‐
67 able to specify the same configuration is a bad idea, so choose
68 one or the other method.
69 --container=container
71 Specify an individual container to be queried.
72 -d, --desc
74 Metric descriptions detailing the PMID, data type, data semantics,
75 units, scale and associated instance domain.
76 -f, --fetch
78 Fetch and print values for all instances. When fetching from a
79 set of archives, only those instances present in the first archive
80 record for a metric will be displayed; see also the -O option,
81 else use pmdumplog(1) which may be a better tool for examining ar‐
82 chives.
83 -F, --fetchall
85 Same as -f but try harder to fetch instances for metrics which
86 have non-enumerable instance domains (e.g. metrics in the ``proc''
87 subtree of the default PMNS on some platforms).
88 -h host, --host=host
90 Fetch performance metrics from pmcd(1) on host, rather than from
91 the default localhost.
92 -I, --fullindom
94 Print the InDom in verbose mode.
95 -K spec, --spec-local=spec
97 When using the -L/ option to fetch metrics from a local context,
98 this option controls the DSO PMDAs that should be made accessible.
99 The spec argument conforms to the syntax described in pmSpecLo‐
100 calPMDA(3). More than one -K option may be used.
101 -l, --labels
103 Print label sets associated with metrics and instances. Labels
104 are optional metric metadata described in detail in pmLookupLa‐
105 bels(3).
106 -L, --local-PMDA
108 Use a local context to collect metrics from DSO PMDAs on the local
109 host without PMCD. See also -K.
110 -m, --pmid
112 Print the PMID in terse mode.
113 -M, --fullpmid
115 Print the PMID in verbose mode.
116 -n pmnsfile, --namespace=pmnsfile
118 Normally pminfo operates on the distributed Performance Metrics
119 Name Space (PMNS), however if the -n option is specified an alter‐
120 native local PMNS is loaded from the file pmnsfile.
121 -N pmnsfile, --uniqnames=pmnsfile
123 The -N option supports the same function as -n, except for the
124 handling of duplicate names for the same Performance Metric Iden‐
125 tifier (PMID) in pmnsfile - duplicate names are allowed with -n
126 but they are not allowed with -N.
127 -O time, --origin=time
129 When used in conjunction with an archive source of metrics and the
130 options -f/, the time argument defines a time origin at which the
131 metrics should be fetched from the set of archives. Refer to
132 PCPIntro(1) for a complete description of this option, and the
133 syntax for the time argument.
134 -s, --series
136 Print time series identifiers associated with metrics, instances
137 and sources. These unique identifiers are calculated from intrin‐
138 sic (non-optional) labels and other metric metadata associated
139 with each PMAPI context (sources), metrics and instances. Ar‐
140 chive, local context or pmcd(1) connections for the same host all
141 produce the same source identifier. See also pmLookupLabels(3)
142 and the -l option.
143 -t, --oneline
145 Print the ``one line'' help summary, if available.
146 -T, --helptext
148 Print the help text, if available.
149 -v, --verify
151 Verify mode in which descriptions and values are retrieved, but
152 only error conditions are reported. This option silently disables
153 any output from the options -f/--fetch, -l/--labels,
154 -I/--fullindom, -M/--fullpmid, -m/--pmid, -t/--oneline and
155 -T/--helptext.
156 -V, --version
158 Display version number and exit.
159 -x, --events
161 Like the -f/--fetch option, but with the additional functionality
162 that if a value is processed that is of type PM_TYPE_EVENT or
163 PM_TYPE_HIGHRES_EVENT, then the event records will be unpacked and
164 the details of each event record reported.
165 -z, --hostzone
167 Change the reporting timezone to the local timezone at the host
168 that is the source of the performance metrics, as identified via
169 either the -h or -a options.
170 -Z timezone, --timezone=timezone
172 By default, pminfo reports the time of day according to the local
173 timezone on the system where pminfo is run. The -Z option changes
174 the timezone to timezone in the format of the environment variable
175 TZ as described in environ(7).
176 -?, --help
178 Display usage message and exit.
179
181 $PCP_VAR_DIR/pmns/*
182 default local PMNS specification files
183
185 Environment variables with the prefix PCP_ are used to parameterize the
186 file and directory names used by PCP. On each installation, the file
187 /etc/pcp.conf contains the local values for these variables. The
188 $PCP_CONF variable may be used to specify an alternative configuration
189 file, as described in pcp.conf(5).
190 For environment variables affecting PCP tools, see pmGetOptions(3).
192
194 PCPIntro(1), pmcd(1), pmchart(1), pmdumplog(1), pmprobe(1), pmrep(1),
195 pmval(1), PMAPI(3), pmGetOptions(3), pmLookupLabels(3), pmLoadDerived‐
196 Config(3), pmSpecLocalPMDA(3), pcp.conf(5), pcp.env(5) and PMNS(5).
197Performance Co-Pilot PCP PMINFO(1)