1PMINFO(1) General Commands Manual PMINFO(1)
2
6 pminfo - display information about performance metrics
7
9 pminfo [-dfFIlLmMstTvxz?] [-a archive] [-b batchsize] [-c dmfile] [-h
10 hostname] [-K spec] [-[n|N] pmnsfile] [-O time] [-Z timezone] [--con‐
11 tainer] [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
27 directly. This latter mode can be used to report the instance domain
28 ``one line'' and long form help text summaries.
29
31 Unless directed to another host by the -h option, by default pminfo
32 will contact the Performance Metrics Collector Daemon (PMCD) on the
33 local host. The connection to a PMCD is only required if pminfo
34 requires distributed PMNS information, and/or meta-data describing met‐
35 rics, and/or metric values, and/or help text.
36 The -a option causes pminfo to use the specified set of archives rather
38 than connecting to a PMCD.
39 The -L option causes pminfo to use a local context to collect metrics
41 from PMDAs on the local host without PMCD. Only some metrics are
42 available in this mode.
43 The -a, -h and -L options are mutually exclusive.
45 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 log files identified by the archive
51 argument, which is a comma-separated list of names, each of which
52 may be the base name of an archive or the name of a directory con‐
53 taining 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
58 default 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
65 PCP_DERIVED_CONFIG environment variable as described in PCPIn‐
66 tro(1). Using the -c option and the PCP_DERIVED_CONFIG environ‐
67 ment variable to specify the same configuration is a bad idea, so
68 choose one or the other method.
69 -d, --desc
71 Metric descriptions detailing the PMID, data type, data semantics,
72 units, scale and associated instance domain.
73 -f, --fetch
75 Fetch and print values for all instances. When fetching from a
76 set of archives, only those instances present in the first archive
77 record for a metric will be displayed; see also the -O option,
78 else use pmdumplog(1) which may be a better tool for examining ar‐
79 chives.
80 -F, --fetchall
82 Same as -f but try harder to fetch instances for metrics which
83 have non-enumerable instance domains (e.g. metrics in the ``proc''
84 subtree of the default PMNS on some platforms).
85 -h host, --host=host
87 Fetch performance metrics from pmcd(1) on host, rather than from
88 the default localhost.
89 -I, --fullindom
91 Print the InDom in verbose mode.
92 -K spec, --spec-local=spec
94 When using the -L/ option to fetch metrics from a local context,
95 this option controls the DSO PMDAs that should be made accessible.
96 The spec argument conforms to the syntax described in pmSpecLo‐
97 calPMDA(3). More than one -K option may be used.
98 -l, --labels
100 Print label sets associated with metrics and instances. Labels
101 are optional metric metadata described in detail in pmLookupLa‐
102 bels(3).
103 -m, --pmid
105 Print the PMID in terse mode.
106 -M, --fullpmid
108 Print the PMID in verbose mode.
109 -n pmnsfile, --namespace=pmnsfile
111 Normally pminfo operates on the distributed Performance Metrics
112 Name Space (PMNS), however if the -n option is specified an alter‐
113 native local PMNS is loaded from the file pmnsfile.
114 -N pmnsfile, --uniqnames=pmnsfile
116 The -N option supports the same function as -n, except for the
117 handling of duplicate names for the same Performance Metric Iden‐
118 tifier (PMID) in pmnsfile - duplicate names are allowed with -n
119 but they are not allowed with -N.
120 -O time, --origin=time
122 When used in conjunction with an archive source of metrics and the
123 options -f/, the time argument defines a time origin at which the
124 metrics should be fetched from the set of archives. Refer to
125 PCPIntro(1) for a complete description of this option, and the
126 syntax for the time argument.
127 -s, --series
129 Print time series identifiers associated with metrics, instances
130 and sources. These unique identifiers are calculated from intrin‐
131 sic (non-optional) labels and other metric metadata associated
132 with each PMAPI context (sources), metrics and instances. Ar‐
133 chive, local context or pmcd(1) connections for the same host all
134 produce the same source identifier. See also pmLookupLabels(3)
135 and the -l option.
136 -t, --oneline
138 Print the ``one line'' help summary, if available.
139 -T, --helptext
141 Print the help text, if available.
142 -v, --verify
144 Verify mode in which descriptions and values are retrieved, but
145 only error conditions are reported. This option silently disables
146 any output from the options -f/--fetch, -l/--labels,
147 -I/--fullindom, -M/--fullpmid, -m/--pmid, -t/--oneline and
148 -T/--helptext.
149 -x, --events
151 Like the -f/--fetch option, but with the additional functionality
152 that if a value is processed that is of type PM_TYPE_EVENT or
153 PM_TYPE_HIGHRES_EVENT, then the event records will be unpacked and
154 the details of each event record reported.
155 -?, --help
157 Display usage message and exit.
158 --container=container
160 Specify an individual container to be queried.
161
163 $PCP_VAR_DIR/pmns/*
164 default local PMNS specification files
165
167 Environment variables with the prefix PCP_ are used to parameterize the
168 file and directory names used by PCP. On each installation, the file
169 /etc/pcp.conf contains the local values for these variables. The
170 $PCP_CONF variable may be used to specify an alternative configuration
171 file, as described in pcp.conf(5).
172 For environment variables affecting PCP tools, see pmGetOptions(3).
174
176 PCPIntro(1), pmcd(1), pmchart(1), pmdumplog(1), pmprobe(1), pmrep(1),
177 pmval(1), PMAPI(3), pmGetOptions(3), pmLookupLabels(3), pmLoadDerived‐
178 Config(3), pmSpecLocalPMDA(3), pcp.conf(5), pcp.env(5) and PMNS(5).
179Performance Co-Pilot PCP PMINFO(1)