1PCP2XLSX(1) General Commands Manual PCP2XLSX(1)
2
6 pcp2xlsx - pcp-to-xlsx metrics exporter
7
9 pcp2xlsx [-5CGHILmrRvVz?] [-4 action] [-a archive] [-A align] [--ar‐
10 chive-folio folio] [-b|-B space-scale] [-c config] [--container con‐
11 tainer] [--daemonize] [-e derived] [-f format] [-F outfile] [-h host]
12 [-i instances] [-K spec] [-O origin] [-P|-0 precision] [-q|-Q count-
13 scale] [-s samples] [-S starttime] [-t interval] [-T endtime] [-y|-Y
14 time-scale] [-Z timezone] metricspec [...]
15
17 pcp2xlsx is a customizable performance metrics exporter tool from PCP
18 to XLSX. Any available performance metric, live or archived, system
19 and/or application, can be selected for exporting using either command
20 line arguments or a configuration file.
21 pcp2xlsx is a close relative of pmrep(1). Please refer to pmrep(1) for
23 the metricspec description accepted on pcp2xlsx command line and
24 pmrep.conf(5) for description of the pcp2xlsx.conf configuration file
25 overall syntax, this page describes pcp2xlsx specific options and con‐
26 figuration file differences with pmrep.conf(5). pmrep(1) also lists
27 some usage examples of which most are applicable with pcp2xlsx as well.
28 Only the command line options listed on this page are supported, other
30 options recognized by pmrep(1) are not supported.
31 Options via environment values (see pmGetOptions(3)) override the cor‐
33 responding built-in default values (if any). Configuration file
34 options override the corresponding environment variables (if any).
35 Command line options override the corresponding configuration file
36 options (if any).
37
39 pcp2xlsx uses a configuration file with overall syntax described in
40 pmrep.conf(5). The following options are common with pmrep.conf: ver‐
41 sion, source, speclocal, derived, header, globals, samples, interval,
42 type, type_prefer, ignore_incompat, names_change, instances, omit_flat,
43 include_labels, precision, precision_force, count_scale,
44 count_scale_force, space_scale, space_scale_force, time_scale,
45 time_scale_force. The output option is recognized but ignored for
46 pmrep.conf compatibility.
47 There are no pcp2xlsx specific options.
49
51 The available command line options are:
52 -0 precision, --precision-force=precision
54 Like -P but this option will override per-metric specifications.
55 -4 action, --names-change=action
57 Specify which action to take on receiving a metric names change
58 event during sampling. These events occur when a PMDA discovers
59 new metrics sometime after starting up, and informs running client
60 tools like pcp2xlsx. Valid values for action are update (refresh
61 metrics being sampled), ignore (do nothing - the default behav‐
62 iour) and abort (exit the program if such an event happens).
63 -5, --ignore-unknown
65 Silently ignore any metric name that cannot be resolved. At least
66 one metric must be found for the tool to start.
67 -a archive, --archive=archive
69 Performance metric values are retrieved from the set of Perfor‐
70 mance Co-Pilot (PCP) archive log files identified by the archive
71 argument, which is a comma-separated list of names, each of which
72 may be the base name of an archive or the name of a directory con‐
73 taining one or more archives.
74 -A align, --align=align
76 Force the initial sample to be aligned on the boundary of a natu‐
77 ral time unit align. Refer to PCPIntro(1) for a complete descrip‐
78 tion of the syntax for align.
79 --archive-folio=folio
81 Read metric source archives from the PCP archive folio created by
82 tools like pmchart(1) or, less often, manually with mkaf(1).
83 -b scale, --space-scale=scale
85 Unit/scale for space (byte) metrics, possible values include
86 bytes, Kbytes, KB, Mbytes, MB, and so forth. This option will not
87 override possible per-metric specifications. See also pmParseU‐
88 nitsStr(3).
89 -B scale, --space-scale-force=scale
91 Like -b but this option will override per-metric specifications.
92 -c config, --config=config
94 Specify the config file to use. The default is the first found
95 of: ./pcp2xlsx.conf, $HOME/.pcp2xlsx.conf,
96 $HOME/pcp/pcp2xlsx.conf, and $PCP_SYSCONF_DIR/pcp2xlsx.conf. For
97 details, see the above section and pmrep.conf(5).
98 --container=container
100 Fetch performance metrics from the specified container, either
101 local or remote (see -h).
102 -C, --check
104 Exit before reporting any values, but after parsing the configura‐
105 tion and metrics and printing possible headers.
106 --daemonize
108 Daemonize on startup.
109 -e derived, --derived=derived
111 Specify derived performance metrics. If derived starts with a
112 slash (``/'') or with a dot (``.'') it will be interpreted as a
113 derived metrics configuration file, otherwise it will be inter‐
114 preted as comma- or semicolon-separated derived metric expres‐
115 sions. For details see pmLoadDerivedConfig(3) and pmRegister‐
116 Derived(3).
117 -G, --no-globals
119 Do not include global metrics in reporting (see pmrep.conf(5)).
120 -f format, --timestamp-format=format
122 Use the format string for formatting the timestamp. The format
123 will be used with Python's datetime.strftime method which is
124 mostly the same as that described in strftime(3). The default is
125 %Y-%m-%d %H:%M:%S.
126 -F outfile, --output-file=outfile
128 Specify the output file outfile.
129 -h host, --host=host
131 Fetch performance metrics from pmcd(1) on host, rather than from
132 the default localhost.
133 -H, --no-header
135 Do not print any headers.
136 -i instances, --instances=instances
138 Report only the listed instances from current instances (if
139 present). By default all current instances are reported. This is
140 a global option that is used for all metrics unless a metric-spe‐
141 cific instance definition is provided as part of a metricspec. By
142 default single-valued ``flat'' metrics without multiple instances
143 are still reported as usual, use -v to change this. Please refer
144 to pmrep(1) for more details on this option.
145 -I, --ignore-incompat
147 Ignore incompatible metrics. By default incompatible metrics
148 (that is, their type is unsupported or they cannot be scaled as
149 requested) will cause pcp2xlsx to terminate with an error message.
150 With this option all incompatible metrics are silently omitted
151 from reporting. This may be especially useful when requesting
152 non-leaf nodes of the PMNS tree for reporting.
153 -K spec, --spec-local=spec
155 When fetching metrics from a local context (see -L), the -K option
156 may be used to control the DSO PMDAs that should be made accessi‐
157 ble. The spec argument conforms to the syntax described in
158 pmSpecLocalPMDA(3). More than one -K option may be used.
159 -L, --local-PMDA
161 Use a local context to collect metrics from DSO PMDAs on the local
162 host without PMCD. See also -K.
163 -m, --include-labels
165 Include metric labels in the output.
166 -O origin, --origin=origin
168 When reporting archived metrics, start reporting at origin within
169 the time window (see -S and -T). Refer to PCPIntro(1) for a com‐
170 plete description of the syntax for origin.
171 -P precision, --precision=precision
173 Use precision for numeric non-integer output values. The default
174 is to use 3 decimal places (when applicable). This option will
175 not override possible per-metric specifications.
176 -q scale, --count-scale=scale
178 Unit/scale for count metrics, possible values include count x
179 10^-1, count, count x 10, count x 10^2, and so forth from 10^-8 to
180 10^7. (These values are currently space-sensitive.) This option
181 will not override possible per-metric specifications. See also
182 pmParseUnitsStr(3).
183 -Q scale, --count-scale-force=scale
185 Like -q but this option will override per-metric specifications.
186 -r, --raw
188 Output raw metric values, do not convert cumulative counters to
189 rates. This option will override possible per-metric specifica‐
190 tions.
191 -R, --raw-prefer
193 Like -r but this option will not override per-metric specifica‐
194 tions.
195 -s samples, --samples=samples
197 The samples argument defines the number of samples to be retrieved
198 and reported. If samples is 0 or -s is not specified, pcp2xlsx
199 will sample and report continuously (in real time mode) or until
200 the end of the set of PCP archives (in archive mode). See also
201 -T.
202 -S starttime, --start=starttime
204 When reporting archived metrics, the report will be restricted to
205 those records logged at or after starttime. Refer to PCPIntro(1)
206 for a complete description of the syntax for starttime.
207 -t interval, --interval=interval
209 Set the reporting interval to something other than the default 1
210 second. The interval argument follows the syntax described in
211 PCPIntro(1), and in the simplest form may be an unsigned integer
212 (the implied units in this case are seconds). See also the -T
213 option.
214 -T endtime, --finish=endtime
216 When reporting archived metrics, the report will be restricted to
217 those records logged before or at endtime. Refer to PCPIntro(1)
218 for a complete description of the syntax for endtime.
219 When used to define the runtime before pcp2xlsx will exit, if no
221 samples is given (see -s) then the number of reported samples
222 depends on interval (see -t). If samples is given then interval
223 will be adjusted to allow reporting of samples during runtime. In
224 case all of -T, -s, and -t are given, endtime determines the
225 actual time pcp2xlsx will run.
226 -v, --omit-flat
228 Omit single-valued ``flat'' metrics from reporting, only consider
229 set-valued metrics (i.e., metrics with multiple values) for
230 reporting. See -i and -I.
231 -V, --version
233 Display version number and exit.
234 -y scale, --time-scale=scale
236 Unit/scale for time metrics, possible values include nanosec, ns,
237 microsec, us, millisec, ms, and so forth up to hour, hr. This
238 option will not override possible per-metric specifications. See
239 also pmParseUnitsStr(3).
240 -Y scale, --time-scale-force=scale
242 Like -y but this option will override per-metric specifications.
243 -z, --hostzone
245 Use the local timezone of the host that is the source of the per‐
246 formance metrics, as identified by either the -h or the -a
247 options. The default is to use the timezone of the local host.
248 -Z timezone, --timezone=timezone
250 Use timezone for the date and time. Timezone is in the format of
251 the environment variable TZ as described in environ(7). Note that
252 when including a timezone string in output, ISO 8601 -style UTC
253 offsets are used (so something like -Z EST+5 will become UTC-5).
254 -?, --help
256 Display usage message and exit.
257
259 pcp2xlsx.conf
260 pcp2xlsx configuration file (see -c)
261
263 Environment variables with the prefix PCP_ are used to parameterize the
264 file and directory names used by PCP. On each installation, the file
265 /etc/pcp.conf contains the local values for these variables. The
266 $PCP_CONF variable may be used to specify an alternative configuration
267 file, as described in pcp.conf(5).
268 For environment variables affecting PCP tools, see pmGetOptions(3).
270
272 mkaf(1), PCPIntro(1), pcp(1), pcp2elasticsearch(1), pcp2graphite(1),
273 pcp2influxdb(1), pcp2json(1), pcp2spark(1), pcp2xml(1), pcp2zabbix(1),
274 pmcd(1), pminfo(1), pmrep(1), pmGetOptions(3), pmSpecLocalPMDA(3),
275 pmLoadDerivedConfig(3), pmParseUnitsStr(3), pmRegisterDerived(3), LOGA‐
276 RCHIVE(5), pcp.conf(5), PMNS(5), pmrep.conf(5) and environ(7).
277Performance Co-Pilot PCP PCP2XLSX(1)