1PCP2INFLUXDB(1) General Commands Manual PCP2INFLUXDB(1)
2
6 pcp2influxdb - pcp-to-influxdb metrics exporter
7
9 pcp2influxdb [-CGHIjLnrRvV?] [-8|-9 limit] [-a archive] [--ar‐
10 chive-folio folio] [-A align] [-b|-B space-scale] [-c config] [--con‐
11 tainer container] [--daemonize] [-e derived] [-E password] [-g server]
12 [-h host] [-i instances] [-J rank] [-K spec] [-N predicate] [-O origin]
13 [-P|-0 precision] [-q|-Q count-scale] [-s samples] [-S starttime] [-t
14 interval] [-T endtime] [-U username] [-x database] [-X tags] [-y|-Y
15 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). Please refer to pmrep(1)
24 for the metricspec description accepted on pcp2influxdb command line
25 and pmrep.conf(5) for description of the pcp2influxdb.conf configura‐
26 tion file overall syntax, this page describes pcp2influxdb specific
27 options and configuration file differences with pmrep.conf(5).
28 pmrep(1) also lists some usage examples of which most are applicable
29 with pcp2influxdb 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
36 options override the corresponding environment variables (if any).
37 Command line options override the corresponding configuration file
38 options (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, instances, live_filter, rank,
45 limit_filter, limit_filter_force, invert_filter, predicate, omit_flat,
46 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 -8 limit, --limit-filter=limit
76 Limit results to instances with values above/below limit. A posi‐
77 tive integer will include instances with values at or above the
78 limit in reporting. A negative integer will include instances
79 with values at or below the limit in reporting. A value of zero
80 performs no limit filtering. This option will not override possi‐
81 ble per-metric specifications. See also -J and -N.
82 -9 limit, --limit-filter-force=limit
84 Like -8 but this option will override per-metric specifications.
85 -a archive, --archive=archive
87 Performance metric values are retrieved from the set of Perfor‐
88 mance Co-Pilot (PCP) archive log files identified by the argument
89 archive, which is a comma-separated list of names, each of which
90 may be the base name of an archive or the name of a directory con‐
91 taining one or more archives.
92 --archive-folio
94 Read metric source archives from the PCP archive folio created by
95 tools like pmchart(1) or, less often, manually with mkaf(1).
96 -A align, --align=align
98 Force the initial sample to be aligned on the boundary of a natu‐
99 ral time unit align. Refer to PCPIntro(1) for a complete descrip‐
100 tion of the syntax for align.
101 -b scale, --space-scale=scale
103 Unit/scale for space (byte) metrics, possible values include
104 bytes, Kbytes, KB, Mbytes, MB, and so forth. This option will not
105 override possible per-metric specifications. See also pmParseU‐
106 nitsStr(3).
107 -B scale, --space-scale-force=scale
109 Like -b but this option will override per-metric specifications.
110 -c config, --config=config
112 Specify the config file to use. The default is the first found
113 of: ./pcp2influxdb.conf, $HOME/.pcp2influxdb.conf,
114 $HOME/pcp/pcp2influxdb.conf, and
115 $PCP_SYSCONF_DIR/pcp2influxdb.conf. For details, see the above
116 section and pmrep.conf(5).
117 --container
119 Fetch performance metrics from the specified container, either
120 local or remote (see -h).
121 -C, --check
123 Exit before reporting any values, but after parsing the configura‐
124 tion and metrics and printing possible headers.
125 --daemonize
127 Daemonize on startup.
128 -e derived, --derived=derived
130 Specify derived performance metrics. If derived starts with a
131 slash (``/'') or with a dot (``.'') it will be interpreted as a
132 derived metrics configuration file, otherwise it will be inter‐
133 preted as comma- or semicolon-separated derived metric expres‐
134 sions. For details see pmLoadDerivedConfig(3) and pmRegister‐
135 Derived(3).
136 -E password, --db-pass=password
138 Specify the database password.
139 -g server, --db-server=server
141 InfluxDB server to send the metrics to.
142 -G, --no-globals
144 Do not include global metrics in reporting (see pmrep.conf(5)).
145 -h host, --host=host
147 Fetch performance metrics from pmcd(1) on host, rather than from
148 the default localhost.
149 -H, --no-header
151 Do not print any headers.
152 -i instances, --instances=instances
154 Report only the listed instances from current instances (if
155 present, see also -j). By default all instances, present and
156 future, are reported. This is a global option that is used for
157 all metrics unless a metric-specific instance definition is pro‐
158 vided as part of a metricspec. By default single-valued ``flat''
159 metrics without multiple instances are still reported as usual,
160 use -v to change this. Please refer to pmrep(1) for more details
161 on this option.
162 -I, --ignore-incompat
164 Ignore incompatible metrics. By default incompatible metrics
165 (that is, their type is unsupported or they cannot be scaled as
166 requested) will cause pcp2influxdb to terminate with an error mes‐
167 sage. With this option all incompatible metrics are silently
168 omitted from reporting. This may be especially useful when
169 requesting non-leaf nodes of the PMNS tree for reporting.
170 -j, --live-filter
172 Perform instance live filtering. This allows capturing all fil‐
173 tered instances even if processes are restarted at some point
174 (unlike without live filtering). Doing live filtering over a huge
175 amount of instances naturally comes with some overhead so a bit of
176 user caution is advised.
177 -J rank, --rank=rank
179 Limit results to highest/lowest rank instances of set-valued met‐
180 rics. A positive integer will include highest valued instances in
181 reporting. A negative integer will include lowest valued
182 instances in reporting. A value of zero performs no ranking. See
183 also -8.
184 -K spec, --spec-local=spec
186 When fetching metrics from a local context (see -L), the -K option
187 may be used to control the DSO PMDAs that should be made accessi‐
188 ble. The spec argument conforms to the syntax described in
189 pmSpecLocalPMDA(3). More than one -K option may be used.
190 -L, --local-PMDA
192 Use a local context to collect metrics from DSO PMDAs on the local
193 host without PMCD. See also -K.
194 -n, --invert-filter
196 Perform ranking before live filtering. By default instance live
197 filter filtering (when requested, see -j) happens before instance
198 ranking (when requested, see -J). With this option the logic is
199 inverted and ranking happens before live filtering.
200 -N predicate, --predicate=predicate
202 Specify a comma-separated list of predicate filter reference met‐
203 rics. By default ranking (see -J) happens for each metric indi‐
204 vidually. With predicate filter reference metrics, ranking is
205 done only for the specified metrics. When reporting, the rest of
206 the metrics sharing the same instance domain (see PCPIntro(1)) as
207 the predicates will include only the highest/lowest ranking
208 instances of the corresponding predicates.
209 So for example, when the using proc.memory.rss (resident size of
211 process) as the predicate and including proc.io.total_bytes and
212 mem.util.used as metrics to be reported, only the processes using
213 most/least memory (as per -J) will be included when reporting
214 total bytes written by processes. Since mem.util.used is a sin‐
215 gle-valued metric (thus not sharing the same instance domain as
216 the process-related metrics), it will be reported as usual.
217 -O origin, --origin=origin
219 When reporting archived metrics, start reporting at origin within
220 the time window (see -S and -T). Refer to PCPIntro(1) for a com‐
221 plete description of the syntax for origin.
222 -P precision, --precision=precision
224 Use precision for numeric non-integer output values. The default
225 is to use 3 decimal places (when applicable). This option will
226 not override possible per-metric specifications.
227 -0 precision, --precision-force=precision
229 Like -P but this option will override per-metric specifications.
230 -q scale, --count-scale=scale
232 Unit/scale for count metrics, possible values include count x
233 10^-1, count, count x 10, count x 10^2, and so forth from 10^-8 to
234 10^7. (These values are currently space-sensitive.) This option
235 will not override possible per-metric specifications. See also
236 pmParseUnitsStr(3).
237 -Q scale, --count-scale-force=scale
239 Like -q but this option will override per-metric specifications.
240 -r, --raw
242 Output raw metric values, do not convert cumulative counters to
243 rates. This option will override possible per-metric specifica‐
244 tions.
245 -R, --raw-prefer
247 Like -r but this option will not override per-metric specifica‐
248 tions.
249 -s samples, --samples=samples
251 The argument samples defines the number of samples to be retrieved
252 and reported. If samples is 0 or -s is not specified,
253 pcp2influxdb will sample and report continuously (in real time
254 mode) or until the end of the set of PCP archives (in archive
255 mode). See also -T.
256 -S starttime, --start=starttime
258 When reporting archived metrics, the report will be restricted to
259 those records logged at or after starttime. Refer to PCPIntro(1)
260 for a complete description of the syntax for starttime.
261 -t interval, --interval=interval
263 The default update interval may be set to something other than the
264 default 1 second. The interval argument follows the syntax
265 described in PCPIntro(1), and in the simplest form may be an
266 unsigned integer (the implied units in this case are seconds).
267 See also the -T option.
268 -T endtime, --finish=endtime
270 When reporting archived metrics, the report will be restricted to
271 those records logged before or at endtime. Refer to PCPIntro(1)
272 for a complete description of the syntax for endtime.
273 When used to define the runtime before pcp2influxdb will exit, if
275 no samples is given (see -s) then the number of reported samples
276 depends on interval (see -t). If samples is given then interval
277 will be adjusted to allow reporting of samples during runtime. In
278 case all of -T, -s, and -t are given, endtime determines the
279 actual time pcp2influxdb will run.
280 -U username, --db-user=username
282 Specify the database username.
283 -v, --omit-flat
285 Omit single-valued ``flat'' metrics from reporting, only consider
286 set-valued metrics (i.e., metrics with multiple values) for
287 reporting. See -i and -I.
288 -V, --version
290 Display version number and exit.
291 -x database, --db-name=database
293 Specify the metrics database name.
294 -X tags, --db-tags=tags
296 Specify strings of tags to add to the metrics.
297 -y scale, --time-scale=scale
299 Unit/scale for time metrics, possible values include nanosec, ns,
300 microsec, us, millisec, ms, and so forth up to hour, hr. This
301 option will not override possible per-metric specifications. See
302 also pmParseUnitsStr(3).
303 -Y scale, --time-scale-force=scale
305 Like -y but this option will override per-metric specifications.
306 -?, --help
308 Display usage message and exit.
309
311 pcp2influxdb.conf
312 pcp2influxdb configuration file (see -c)
313
315 Environment variables with the prefix PCP_ are used to parameterize the
316 file and directory names used by PCP. On each installation, the file
317 /etc/pcp.conf contains the local values for these variables. The
318 $PCP_CONF variable may be used to specify an alternative configuration
319 file, as described in pcp.conf(5).
320 For environment variables affecting PCP tools, see pmGetOptions(3).
322
324 mkaf(1), PCPIntro(1), pcp(1), pcp2elasticsearch(1), pcp2graphite(1),
325 pcp2json(1), pcp2xlsx(1), pcp2xml(1), pcp2zabbix(1), pmcd(1),
326 pminfo(1), pmrep(1), pmGetOptions(3), pmSpecLocalPMDA(3), pmLoad‐
327 DerivedConfig(3), pmParseUnitsStr(3), pmRegisterDerived(3), LOGA‐
328 RCHIVE(5), pcp.conf(5), pmns(5) and pmrep.conf(5).
329Performance Co-Pilot PCP PCP2INFLUXDB(1)