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] [metric‐
11 name | 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 Normally pminfo operates on the distributed Performance Metrics Name
18 Space (PMNS), however if the -n/--namespace option is specified an
19 alternative local PMNS is loaded from the file pmnsfile. The
20 -N/--uniqnames option supports the same function as -n/--namespace,
21 except for the handling of duplicate names for the same Performance
22 Metric Identifier (PMID) in pmnsfile - duplicate names are allowed with
23 -n/--namespace but they are not allowed with -N/--uniqnames.
24 The metrics of interest are named in the metricname arguments. If met‐
26 ricname is a non-leaf node in the PMNS, then pminfo will recursively
27 descend the PMNS and report on all leaf nodes. If no metricname argu‐
28 ment is given, the root of the PMNS is used.
29 If the metricname argument is in numeric dotted notation, it is inter‐
31 preted as either a 3-dotted pmid (metric identifier - domain, cluster,
32 item numbers) or a 2-dotted indom (instance domain identifier - domain,
33 serial number). In the pmid case, a reverse PMID-to-name lookup is
34 performed, and in the indom case, the instance domain is reported
35 directly. This latter mode can be used to report the instance domain
36 ``one line'' and long form help text summaries.
37 Unless directed to another host by the -h/--host option, by default
39 pminfo will contact the Performance Metrics Collector Daemon (PMCD) on
40 the local host. The connection to a PMCD is only required if pminfo
41 requires distributed PMNS information, and/or meta-data describing met‐
42 rics, and/or metric values, and/or help text.
43 The -a/--archive option causes pminfo to use the specified set of ar‐
45 chives rather than connecting to a PMCD. The argument to -a/--archive
46 is a comma-separated list of names, each of which may be the base name
47 of an archive or the name of a directory containing one or more ar‐
48 chives.
49 The -L/--local-PMDA option causes pminfo to use a local context to col‐
51 lect metrics from PMDAs on the local host without PMCD. Only some met‐
52 rics are available in this mode.
53 The -a/--archive, -h/--host and -L/--local-PMDA options are mutually
55 exclusive.
56 The -b/--batch option may be used to define the maximum size of the
58 group of metrics to be fetched in a single request for the -f/--fetch
59 and -v/--verify options. The default value for batchsize is 128.
60 Other options control the specific information to be reported.
62 -c dmfile, --derived=dmfile
64 The dmfile argument specifies a file that contains derived metric
65 definitions in the format described for pmLoadDerivedConfig(3).
66 The -c/--derived option provides a way to load derived metric def‐
67 initions that is an alternative to the more generic use of the
68 PCP_DERIVED_CONFIG environment variable as described in PCPIn‐
69 tro(1). Using the -c/--derived option and the PCP_DERIVED_CONFIG
70 environment variable to specify the same configuration is a bad
71 idea, so choose one or the other method.
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/--origin
81 option, else use pmdumplog(1) which may be a better tool for exam‐
82 ining archives.
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 -I, --fullindom
90 Print the InDom in verbose mode.
91 -K spec, --spec-local=spec
93 When using the -L/--local-PMDA option to fetch metrics from a
94 local context, this option controls the DSO PMDAs that should be
95 made accessible. The spec argument conforms to the syntax
96 described in pmSpecLocalPMDA(3). More than one -K/--spec-local
97 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 -O time, --origin=time
111 When used in conjunction with an archive source of metrics and the
112 options -f/--fetch, the time argument defines a time origin at
113 which the metrics should be fetched from the set of archives.
114 Refer to PCPIntro(1) for a complete description of this option,
115 and the syntax for the time argument.
116 -s, --series
118 Print time series identifiers associated with metrics, instances
119 and sources. These unique identifiers are calculated from intrin‐
120 sic (non-optional) labels and other metric metadata associated
121 with each PMAPI context (sources), metrics and instances. Ar‐
122 chive, local context or pmcd(1) connections for the same host all
123 produce the same source identifier. See also pmLookupLabels(3)
124 and the -l/--labels option.
125 -t, --oneline
127 Print the ``one line'' help summary, if available.
128 -T, --helptext
130 Print the help text, if available.
131 -v, --verify
133 Verify mode in which descriptions and values are retrieved, but
134 only error conditions are reported. This option silently disables
135 any output from the options -f/--fetch, -l/--labels,
136 -I/--fullindom, -M/--fullpmid, -m/--pmid, -t/--oneline and
137 -T/--helptext.
138 -x, --events
140 Like the -f/--fetch option, but with the additional functionality
141 that if a value is processed that is of type PM_TYPE_EVENT or
142 PM_TYPE_HIGHRES_EVENT, then the event records will be unpacked and
143 the details of each event record reported.
144
146 $PCP_VAR_DIR/pmns/*
147 default local PMNS specification files
148
150 Environment variables with the prefix PCP_ are used to parameterize the
151 file and directory names used by PCP. On each installation, the file
152 /etc/pcp.conf contains the local values for these variables. The
153 $PCP_CONF variable may be used to specify an alternative configuration
154 file, as described in pcp.conf(5).
155
157 PCPIntro(1), pmcd(1), pmchart(1), pmdumplog(1), pmprobe(1), pmrep(1),
158 pmval(1), PMAPI(3), pmLookupLabels(3), pmLoadDerivedConfig(3),
159 pmSpecLocalPMDA(3), pcp.conf(5), pcp.env(5) and pmns(5).
160Performance Co-Pilot PCP PMINFO(1)