1PCP2INFLUXDB(1) General Commands Manual PCP2INFLUXDB(1)
2
6 pcp2influxdb - pcp-to-influxdb metrics exporter
7
9 pcp2influxdb [-CGHIjLnrRvV?] [-4 action] [-8|-9 limit] [-a archive]
10 [-A align] [--archive-folio folio] [-b|-B space-scale] [-c config]
11 [--container container] [--daemonize] [-e derived] [-E password] [-g
12 server] [-h host] [-i instances] [-J rank] [-K spec] [-N predicate] [-O
13 origin] [-P|-0 precision] [-q|-Q count-scale] [-s samples] [-S start‐
14 time] [-t interval] [-T endtime] [-U username] [-x database] [-X tags]
15 [-y|-Y time-scale] metricspec [...]
16
18 pcp2influxdb is a customizable performance metrics exporter tool from
19 PCP to InfluxDB. Any available performance metric, live or archived,
20 system and/or application, can be selected for exporting using either
21 command line arguments or a configuration file.
22 pcp2influxdb is a close relative of pmrep(1). Refer to pmrep(1) for
24 the metricspec description accepted on pcp2influxdb command line. See
25 pmrep.conf(5) for description of the pcp2influxdb.conf configuration
26 file overall syntax. This page describes pcp2influxdb specific options
27 and configuration file differences with pmrep.conf(5). pmrep(1) also
28 lists some usage examples of which most are applicable with pcp2in‐
29 fluxdb as well.
30 Only the command line options listed on this page are supported, other
32 options recognized by pmrep(1) are not supported.
33 Options via environment values (see pmGetOptions(3)) override the cor‐
35 responding built-in default values (if any). Configuration file op‐
36 tions override the corresponding environment variables (if any). Com‐
37 mand line options override the corresponding configuration file options
38 (if any).
39
41 pcp2influxdb uses a configuration file with overall syntax described in
42 pmrep.conf(5). The following options are common with pmrep.conf: ver‐
43 sion, source, speclocal, derived, header, globals, samples, interval,
44 type, type_prefer, ignore_incompat, names_change, instances, live_fil‐
45 ter, rank, limit_filter, limit_filter_force, invert_filter, predicate,
46 omit_flat, precision, precision_force, count_scale, count_scale_force,
47 space_scale, space_scale_force, time_scale, time_scale_force. The out‐
48 put option is recognized but ignored for pmrep.conf compatibility.
49 pcp2influxdb specific options
51 influx_server (string)
52 Specify the URL of InfluxDB server to send the metrics to. Corre‐
53 sponding command line option is -g. Default is
54 http://127.0.0.1:8086.
55 influx_db (string)
57 Specify the metrics database. Corresponding command line option is
58 -x. Default is pcp.
59 influx_user (string)
61 Specify the username for the database. Corresponding command line
62 option is -U.
63 influx_pass (string)
65 Specify the password for the database. Corresponding command line
66 option is -E.
67 influx_tags (string)
69 Specify string of tags to add to the metrics. Corresponding com‐
70 mand line option is -X.
71
73 The available command line options are:
74 -0 precision, --precision-force=precision
76 Like -P but this option will override per-metric specifications.
77 -4 action, --names-change=action
79 Specify which action to take on receiving a metric names change
80 event during sampling. These events occur when a PMDA discovers
81 new metrics sometime after starting up, and informs running client
82 tools like pcp2influxdb. Valid values for action are update (re‐
83 fresh metrics being sampled), ignore (do nothing - the default be‐
84 haviour) and abort (exit the program if such an event happens).
85 -5, --ignore-unknown
87 Silently ignore any metric name that cannot be resolved. At least
88 one metric must be found for the tool to start.
89 -8 limit, --limit-filter=limit
91 Limit results to instances with values above/below limit. A posi‐
92 tive integer will include instances with values at or above the
93 limit in reporting. A negative integer will include instances
94 with values at or below the limit in reporting. A value of zero
95 performs no limit filtering. This option will not override possi‐
96 ble per-metric specifications. See also -J and -N.
97 -9 limit, --limit-filter-force=limit
99 Like -8 but this option will override per-metric specifications.
100 -a archive, --archive=archive
102 Performance metric values are retrieved from the set of Perfor‐
103 mance Co-Pilot (PCP) archive log files identified by the archive
104 argument, which is a comma-separated list of names, each of which
105 may be the base name of an archive or the name of a directory con‐
106 taining one or more archives.
107 -A align, --align=align
109 Force the initial sample to be aligned on the boundary of a natu‐
110 ral time unit align. Refer to PCPIntro(1) for a complete descrip‐
111 tion of the syntax for align.
112 --archive-folio=folio
114 Read metric source archives from the PCP archive folio created by
115 tools like pmchart(1) or, less often, manually with mkaf(1).
116 -b scale, --space-scale=scale
118 Unit/scale for space (byte) metrics, possible values include
119 bytes, Kbytes, KB, Mbytes, MB, and so forth. This option will not
120 override possible per-metric specifications. See also pmParseU‐
121 nitsStr(3).
122 -B scale, --space-scale-force=scale
124 Like -b but this option will override per-metric specifications.
125 -c config, --config=config
127 Specify the config file or directory to use. In case config is a
128 directory all files under it ending .conf will be included. The
129 default is the first found of: ./pcp2influxdb.conf, $HOME/.pcp2in‐
130 fluxdb.conf, $HOME/pcp/pcp2influxdb.conf, and
131 $PCP_SYSCONF_DIR/pcp2influxdb.conf. For details, see the above
132 section and pmrep.conf(5).
133 --container=container
135 Fetch performance metrics from the specified container, either lo‐
136 cal or remote (see -h).
137 -C, --check
139 Exit before reporting any values, but after parsing the configura‐
140 tion and metrics and printing possible headers.
141 --daemonize
143 Daemonize on startup.
144 -e derived, --derived=derived
146 Specify derived performance metrics. If derived starts with a
147 slash (``/'') or with a dot (``.'') it will be interpreted as a
148 derived metrics configuration file, otherwise it will be inter‐
149 preted as comma- or semicolon-separated derived metric expres‐
150 sions. For details see pmLoadDerivedConfig(3) and pmRegister‐
151 Derived(3).
152 -E password, --db-pass=password
154 Specify the database password.
155 -g server, --db-server=server
157 InfluxDB server to send the metrics to.
158 -G, --no-globals
160 Do not include global metrics in reporting (see pmrep.conf(5)).
161 -h host, --host=host
163 Fetch performance metrics from pmcd(1) on host, rather than from
164 the default localhost.
165 -H, --no-header
167 Do not print any headers.
168 -i instances, --instances=instances
170 Retrieve and report only the specified metric instances. By de‐
171 fault all instances, present and future, are reported.
172 Refer to pmrep(1) for complete description of this option.
174 -I, --ignore-incompat
176 Ignore incompatible metrics. By default incompatible metrics
177 (that is, their type is unsupported or they cannot be scaled as
178 requested) will cause pcp2influxdb to terminate with an error mes‐
179 sage. With this option all incompatible metrics are silently
180 omitted from reporting. This may be especially useful when re‐
181 questing non-leaf nodes of the PMNS tree for reporting.
182 -j, --live-filter
184 Perform instance live filtering. This allows capturing all named
185 instances even if processes are restarted at some point (unlike
186 without live filtering). Performing live filtering over a huge
187 number of instances will add some internal overhead so a bit of
188 user caution is advised. See also -n.
189 -J rank, --rank=rank
191 Limit results to highest/lowest ranked instances of set-valued
192 metrics. A positive integer will include highest valued instances
193 in reporting. A negative integer will include lowest valued in‐
194 stances in reporting. A value of zero performs no ranking. Rank‐
195 ing does not imply sorting, see -6. See also -8.
196 -K spec, --spec-local=spec
198 When fetching metrics from a local context (see -L), the -K option
199 may be used to control the DSO PMDAs that should be made accessi‐
200 ble. The spec argument conforms to the syntax described in pm‐
201 SpecLocalPMDA(3). More than one -K option may be used.
202 -L, --local-PMDA
204 Use a local context to collect metrics from DSO PMDAs on the local
205 host without PMCD. See also -K.
206 -n, --invert-filter
208 Perform ranking before live filtering. By default instance live
209 filtering (when requested, see -j) happens before instance ranking
210 (when requested, see -J). With this option the logic is inverted
211 and ranking happens before live filtering.
212 -N predicate, --predicate=predicate
214 Specify a comma-separated list of predicate filter reference met‐
215 rics. By default ranking (see -J) happens for each metric indi‐
216 vidually. With predicates, ranking is done only for the specified
217 predicate metrics. When reporting, rest of the metrics sharing
218 the same instance domain (see PCPIntro(1)) as the predicate will
219 include only the highest/lowest ranking instances of the corre‐
220 sponding predicate. Ranking does not imply sorting, see -6.
221 So for example, using proc.memory.rss (resident memory size of
223 process) as the predicate metric together with proc.io.total_bytes
224 and mem.util.used as metrics to be reported, only the processes
225 using most/least (as per -J) memory will be included when report‐
226 ing total bytes written by processes. Since mem.util.used is a
227 single-valued metric (thus not sharing the same instance domain as
228 the process related metrics), it will be reported as usual.
229 -O origin, --origin=origin
231 When reporting archived metrics, start reporting at origin within
232 the time window (see -S and -T). Refer to PCPIntro(1) for a com‐
233 plete description of the syntax for origin.
234 -P precision, --precision=precision
236 Use precision for numeric non-integer output values. The default
237 is to use 3 decimal places (when applicable). This option will
238 not override possible per-metric specifications.
239 -q scale, --count-scale=scale
241 Unit/scale for count metrics, possible values include count x
242 10^-1, count, count x 10, count x 10^2, and so forth from 10^-8 to
243 10^7. (These values are currently space-sensitive.) This option
244 will not override possible per-metric specifications. See also
245 pmParseUnitsStr(3).
246 -Q scale, --count-scale-force=scale
248 Like -q but this option will override per-metric specifications.
249 -r, --raw
251 Output raw metric values, do not convert cumulative counters to
252 rates. This option will override possible per-metric specifica‐
253 tions.
254 -R, --raw-prefer
256 Like -r but this option will not override per-metric specifica‐
257 tions.
258 -s samples, --samples=samples
260 The samples argument defines the number of samples to be retrieved
261 and reported. If samples is 0 or -s is not specified, pcp2in‐
262 fluxdb will sample and report continuously (in real time mode) or
263 until the end of the set of PCP archives (in archive mode). See
264 also -T.
265 -S starttime, --start=starttime
267 When reporting archived metrics, the report will be restricted to
268 those records logged at or after starttime. Refer to PCPIntro(1)
269 for a complete description of the syntax for starttime.
270 -t interval, --interval=interval
272 Set the reporting interval to something other than the default 1
273 second. The interval argument follows the syntax described in
274 PCPIntro(1), and in the simplest form may be an unsigned integer
275 (the implied units in this case are seconds). See also the -T op‐
276 tion.
277 -T endtime, --finish=endtime
279 When reporting archived metrics, the report will be restricted to
280 those records logged before or at endtime. Refer to PCPIntro(1)
281 for a complete description of the syntax for endtime.
282 When used to define the runtime before pcp2influxdb will exit, if
284 no samples is given (see -s) then the number of reported samples
285 depends on interval (see -t). If samples is given then interval
286 will be adjusted to allow reporting of samples during runtime. In
287 case all of -T, -s, and -t are given, endtime determines the ac‐
288 tual time pcp2influxdb will run.
289 -U username, --db-user=username
291 Specify the database username.
292 -v, --omit-flat
294 Report only set-valued metrics with instances (e.g. disk.dev.read)
295 and omit single-valued ``flat'' metrics without instances (e.g.
296 kernel.all.sysfork). See -i and -I.
297 -V, --version
299 Display version number and exit.
300 -x database, --db-name=database
302 Specify the metrics database name.
303 -X tags, --db-tags=tags
305 Specify strings of tags to add to the metrics.
306 -y scale, --time-scale=scale
308 Unit/scale for time metrics, possible values include nanosec, ns,
309 microsec, us, millisec, ms, and so forth up to hour, hr. This op‐
310 tion will not override possible per-metric specifications. See
311 also pmParseUnitsStr(3).
312 -Y scale, --time-scale-force=scale
314 Like -y but this option will override per-metric specifications.
315 -?, --help
317 Display usage message and exit.
318
320 pcp2influxdb.conf
321 pcp2influxdb configuration file (see -c)
322
324 Environment variables with the prefix PCP_ are used to parameterize the
325 file and directory names used by PCP. On each installation, the file
326 /etc/pcp.conf contains the local values for these variables. The
327 $PCP_CONF variable may be used to specify an alternative configuration
328 file, as described in pcp.conf(5).
329 For environment variables affecting PCP tools, see pmGetOptions(3).
331
333 mkaf(1), PCPIntro(1), pcp(1), pcp2elasticsearch(1), pcp2graphite(1),
334 pcp2json(1), pcp2spark(1), pcp2xlsx(1), pcp2xml(1), pcp2zabbix(1),
335 pmcd(1), pminfo(1), pmrep(1), pmGetOptions(3), pmSpecLocalPMDA(3), pm‐
336 LoadDerivedConfig(3), pmParseUnitsStr(3), pmRegisterDerived(3), LOGA‐
337 RCHIVE(5), pcp.conf(5), PMNS(5) and pmrep.conf(5).
338Performance Co-Pilot PCP PCP2INFLUXDB(1)