1PMLOGGER(1) General Commands Manual PMLOGGER(1)
2
6 pmlogger - create archive log for performance metrics
7
9 pmlogger [-CLNoPruy?] [-c conffile] [-h host] [-H hostname] [-I ver‐
10 sion] [-K spec] [-l logfile] [-m note] [-n pmnsfile] [-p pid] [-s end‐
11 size] [-t interval] [-T endtime] [-U username] [-v volsize] [-V ver‐
12 sion] [-x fd] archive
13
15 pmlogger creates the archive logs of performance metric values that may
16 be ``played back'' by other Performance Co-Pilot (see PCPIntro(1))
17 tools. These logs form the basis of the VCR paradigm and retrospective
18 performance analysis services common to the PCP toolkit.
19 The mandatory argument archive is the base name for the physical files
21 that constitute an archive log. The archive argument may contain strf‐
22 time(3) meta-characters, which will be substituted prior to creating
23 the archive log files. When pmlogger is run as a service (see pmlog‐
24 ger_daily(1)), the standard archive base name template is %Y%m%d.%H.%M.
25 The -V option specifies the version for the archive that is generated.
27 By default a version 2 archive is generated, and the only value cur‐
28 rently supported for version is 2.
29 Unless directed to another host by the -h option or when directly using
31 PMDAs via the -o option, pmlogger will contact the Performance Metrics
32 Collector Daemon (PMCD) on the local host and use that as the source of
33 the metric values to be logged.
34 To support the required flexibility and control over what is logged and
36 when, pmlogger maintains an independent two level logging state for
37 each instance of each performance metric. At the first (mandatory)
38 level, logging is allowed to be on (with an associated interval between
39 samples), or off or maybe. In the latter case, the second (advisory)
40 level logging is allowed to be on (with an associated interval between
41 samples), or off.
42 The mandatory level allows universal specification that some metrics
44 must be logged, or must not be logged. The default state for all in‐
45 stances of all metrics when pmlogger starts is mandatory maybe and ad‐
46 visory off.
47 Use pmlc(1) to interrogate and change the logging state once pmlogger
49 is running.
50 If a metric's state is mandatory (on or off) and a request is made to
52 change it to mandatory maybe, the new state is mandatory maybe and ad‐
53 visory off. If a metric's state is already advisory (on or off) and a
54 request is made to change it to mandatory maybe, the current state is
55 retained.
56 It is not possible for pmlogger to log specific instances of a metric
58 and all instances of the same metric concurrently. If specific in‐
59 stances are being logged and a request to log all instances is made,
60 then all instances of the metric will be logged according to the new
61 request, superseding any prior logging request for the metric. A re‐
62 quest to log all instances of a metric will supersede any previous re‐
63 quest to log all instances. A request to log specific instances of a
64 metric when all instances are already being logged is refused. To do
65 this one must turn off logging for all instances of the metric first.
66 In each case, the validity of the request is checked first; for example
67 a request to change a metric's logging state to advisory on when it is
68 currently mandatory off is never permitted (it is necessary to change
69 the state to mandatory maybe first).
70 Optionally, each system running pmcd(1) may also be configured to run a
72 ``primary'' pmlogger instance. This pmlogger instance is launched by
73 $PCP_RC_DIR/pmlogger, and is affected by the files $PCP_SYSCONF_DIR/pm‐
74 logger/control, $PCP_SYSCONF_DIR/pmlogger/control.d (use chkconfig(8),
75 systemctl(1) or similar platform-specific commands to activate or dis‐
76 able the primary pmlogger instance), $PCP_SYSCONFIG_DIR/pmlogger (envi‐
77 ronment variable settings for the primary pmlogger)
78 $PCP_SYSCONF_DIR/pmlogger/pmlogger.options (command line options passed
79 to the primary pmlogger) and $PCP_VAR_DIR/config/pmlogger/config.de‐
80 fault (the default initial configuration file for the primary pmlog‐
81 ger).
82 The primary pmlogger instance is identified by the -P option. There
84 may be at most one ``primary'' pmlogger instance on each system. The
85 primary pmlogger instance (if any) must be running on the same host as
86 the pmcd(1) to which it connects (if any), so the -h and -P options are
87 mutually exclusive.
88 Logging of some metrics is possible even in the absence of a local
90 pmcd(1), using the "local context" mode of operation. This is acti‐
91 vated using the -o option, and causes pmlogger to make use of local DSO
92 PMDAs instead of communicating with pmcd(1). When operating using a
93 local context, the -K option may be used to control the DSO PMDAs that
94 should be made accessible. The spec argument conforms to the syntax
95 described in pmSpecLocalPMDA(3). More than one -K option may be used.
96 When launched as a non-primary instance, pmlogger will exit immediately
98 if the configuration file causes no metric logging to be scheduled.
99 The -L option overrides this behavior, and causes a non-primary pmlog‐
100 ger instance to ``linger'', presumably pending some future dynamic re-
101 configuration and state change via pmlc(1). pmlogger will also linger
102 without the -L option being used if all the metrics to be logged are
103 logged as once only metrics. When the once only metrics have been
104 logged, a warning message will be generated stating that the event
105 queue is empty and no more events will be scheduled.
106 By default all diagnostics and errors from pmlogger are written to the
108 file pmlogger.log in the directory where pmlogger is launched. The -l
109 option may be used to override the default behavior. If the log file
110 cannot be created or is not writable, output is written to standard er‐
111 ror instead. If the logfile for the -l option is "-" (i.e. -l-) then
112 log messages are written to the standard output stream. This can be
113 particularly useful when running pmlogger manually, rather than as a
114 service daemon.
115 The -N option directs pmlogger to notify a service manager, typically
117 systemd(1), when it has started and is about to begin writing PCP ar‐
118 chive logs. This option would only normally be used when pmlogger is
119 run as a daemon service under the control of a service manager. For
120 more details, see __pmServerNotifyServiceManagerReady(3) and sys‐
121 temd(1). On platforms that do not use a service manager that supports
122 notifications, the -N option is basically a no-op.
123 If specified, the -s option instructs pmlogger to terminate after a
125 certain size in records, bytes or time units has been accumulated. If
126 endsize is an integer then endsize records will be written to the log.
127 If endsize is an integer suffixed by b or bytes then endsize bytes of
128 the archive data will be written out (note, however, that archive log
129 record boundaries will not be broken and so this limit may be slightly
130 surpassed). Other viable file size units include: K, Kb, KiB, Kbyte,
131 Kilobyte for kilobytes and M, Mb, MiB, Mbyte, Megabyte for megabytes
132 and G, Gb, GiB, Gbyte, Gigabyte for gigabytes. These units may be op‐
133 tionally suffixed by an s and may be of mixed case. Alternatively end‐
134 size may be an integer or a floating point number suffixed using a time
135 unit as described in PCPIntro(1) for the interval argument (to the
136 standard PCP -t command line option).
137 Some examples of different formats:
138 -s 100
139 -s 100bytes
140 -s 100K
141 -s 100Mb
142 -s 10Gbyte
143 -s 10mins
144 -s 1.5hours
145 The default is for pmlogger to run forever.
146 The -r option causes the size of the physical record(s) for each group
148 of metrics and the expected contribution of the group to the size of
149 the PCP archive for one full day of collection to be reported in the
150 log file. This information is reported the first time each group is
151 successfully written to the archive.
152 The -U option specifies the user account under which to run pmlogger.
154 The default is the current user account for interactive use. When run
155 as a daemon, the unprivileged "pcp" account is used in current versions
156 of PCP, but in older versions the superuser account ("root") was used
157 by default.
158 The log file is potentially a multi-volume data set, and the -v option
160 causes pmlogger to start a new volume after a certain size in records,
161 bytes, or time units has been accumulated for the current volume. The
162 format of this size specification is identical to that of the -s option
163 (see above). The default is for pmlogger to create a single volume
164 log. Additional volume switches can also be forced asynchronously by
165 either using pmlc(1) or sending pmlogger a SIGHUP signal (see below).
166 Note, if a scheduled volume switch is in operation due to the -v op‐
167 tion, then its counters will be reset after an asynchronous switch.
168 Independent of any -v option, each volume of an archive is limited to
170 no more than 2^31 bytes, so pmlogger will automatically create a new
171 volume for the archive before this limit is reached.
172 Normally pmlogger operates on the distributed Performance Metrics Name
174 Space (PMNS), however if the -n option is specified an alternative lo‐
175 cal PMNS is loaded from the file pmnsfile.
176 Under normal circumstances, pmlogger will run forever (except for a -s
178 option or a termination signal). The -T option may be used to limit
179 the execution time using the format of time as prescribed by PCPIn‐
180 tro(1). The time is interpreted within the time zone of the PMCD
181 server, unless the -y option is given, within which case the time zone
182 at this logger host is used.
183 Some examples of different formats:
184 -T 10mins
185 -T '@ 11:30'
186 From this it can be seen that -T 10mins and -s 10mins perform identical
187 actions.
188 Alternatively, pmlogger runtime may be limited to the lifetime of an‐
190 other process by using the -p or --PID option to nominate the PID of
191 the process of interest. In this case the pmlogger will exit when the
192 other process no longer exists.
193 When pmlogger receives a SIGHUP signal, the current volume of the log
195 is closed, and a new volume is opened. This mechanism (or the alterna‐
196 tive mechanism via pmlc(1)) may be used to manage the growth of the log
197 files - once a log volume is closed, that file may be archived without
198 ill-effect on the continued operation of pmlogger. See also the -v op‐
199 tion above.
200 When pmlogger receives a SIGUSR2 signal, the current archive log is
202 closed, and a new archive is opened. For this to succeed, the original
203 archive argument must include strftime(3) meta characters (e.g.
204 %Y%m%d.%H.%M), otherwise pmlogger will exit because the archive files
205 will already exist and pmlogger will not over-write existing archive
206 files. Note that SIGUSR2 triggers pmlogger to re-exec itself and re-
207 parse all original arguments. This means that any relative time limits
208 placed on it's termination time or sampling limit are reset and begin
209 again. This only affects relative termination times, not absolute
210 times e.g. -T 5s is affected, but -T 5pm is not.
211 Historically the buffers for the current log may be flushed to disk us‐
213 ing the flush command of pmlc(1), or by using the -u option. The cur‐
214 rent version of pmlogger and the libpcp routines that underpin pmlogger
215 unconditionally use unbuffered writes and a single fwrite(3) for each
216 logical record written, and so ``flushing'' does not force any addi‐
217 tional data to be written to the file system. The -u option and the
218 pmlc(1) flush command are retained for backwards compatibility.
219 When launched with the -x option, pmlogger will accept asynchronous
221 control requests on the file descriptor fd. This option is only ex‐
222 pected to be used internally by PCP applications that support ``live
223 record mode''.
224 The -m option allows the string note to be appended to the map file for
226 this instance of pmlogger in the $PCP_TMP_DIR/pmlogger directory. This
227 is currently used internally to document the file descriptor (fd) when
228 the -x option is used, or to indicate that this pmlogger instance was
229 started under the control of pmlogger_check(1), (-m pmlogger_check) or
230 was re-exec'd (see execvp(3)) due to a SIGUSR2 signal being recieved as
231 described above (-m reexec).
232 The -H option allows the hostname written into the archive label to be
234 overridden. This mirrors the -H option of pmcd(1) , but allows it to
235 be specified on the pmlogger process. Without this option, the value
236 returned from the logged pmcd(1) is used.
237 The -C option will cause the configuration file to be parsed and pmlog‐
239 ger will then exit without creating an output archive, so when -C is
240 specified, the archive command line argument is not required. Any er‐
241 rors in the configuration file are reported.
242
244 The configuration file may be specified with the -c option. If it is
245 not, configuration specifications are read from standard input.
246 If conffile does not exist, then a search is made in the directory
248 $PCP_VAR_DIR/config/pmlogger for a file of the same name, and if found
249 that file is used, e.g. if config.mumble does not exist in the current
250 directory and the file $PCP_VAR_DIR/config/pmlogger/config.mumble does
251 exist, then -c config.mumble and -c $PCP_VAR_DIR/config/pmlogger/con‐
252 fig.mumble are equivalent.
253 The syntax for the configuration file is as follows.
255 1. Words are separated by white space (space, tab or newline).
257 2. The symbol ``#'' (hash) introduces a comment, and all text up to
259 the next newline is ignored.
260 3. Keywords (shown in bold below) must appear literally (i.e. in
262 lower case).
263 4. Each specification begins with the optional keyword log, followed
265 by one of the states mandatory on, mandatory off, mandatory maybe,
266 advisory on or advisory off.
267 5. For the on states, a logging interval must follow using the syntax
269 ``once'', or ``default'', or ``every N timeunits'', or simply ``N
270 timeunits'' - N is an unsigned integer, and timeunits is one of
271 the keywords msec, millisecond, sec, second, min, minute, hour or
272 the plural form of one of the above.
273 Internal limitations require the interval to be smaller than (ap‐
274 proximately) 74 hours. An interval value of zero is a synonym for
275 once. An interval of default means to use the default logging in‐
276 terval of 60 seconds; this default value may be changed to inter‐
277 val with the -t command line option.
278 The interval argument follows the syntax described in PCPIntro(1),
280 and in the simplest form may be an unsigned integer (the implied
281 units in this case are seconds).
282 6. Following the state and possible interval specifications comes a
284 ``{'', followed by a list of one or more metric specifications and
285 a closing ``}''. The list is white space (or comma) separated.
286 If there is only one metric specification in the list, the braces
287 are optional.
288 7. A metric specification consists of a metric name optionally fol‐
290 lowed by a set of instance names. The metric name follows the
291 standard PCP naming conventions, see PMNS(5), and if the metric
292 name is a non-leaf node in the PMNS (see PMNS(5)), then pmlogger
293 will recursively descend the PMNS and apply the logging specifica‐
294 tion to all descendent metric names that are leaf nodes in the
295 PMNS. The set of instance names is a ``['', followed by a list of
296 one or more space (or comma) separated names, numbers or strings,
297 and a closing ``]''. Elements in the list that are numbers are
298 assumed to be internal instance identifiers, other elements are
299 assumed to be external instance identifiers - see pmGetInDom(3)
300 for more information.
301 If no instances are given, then the logging specification is ap‐
303 plied to all instances of the associated metric.
304 8. There may be an arbitrary number of logging specifications.
306 9. As of PCP version 4.0 and later, any metric name specification
308 that does not resolve to a leaf node in the PMNS is added to an
309 internal list of possible dynamic subtree roots. PMDAs can dynam‐
310 ically create new metrics below a dynamic root node in their PMNS,
311 and send a notification to clients that the PMNS has changed, see
312 pmdaExtSetFlags(3) and in particular the METRIC CHANGES section
313 for API details. This mechanism is currently supported by pm‐
314 daopenmetrics(1) and pmdammv(1). When a fetch issued by pmlogger
315 returns with the PMDA_EXT_NAMES_CHANGE flag set, pmlogger will
316 traverse the internal list of possible dynamic subtree nodes and
317 dynamically discover any new metrics. In effect, as of PCP ver‐
318 sion 4.0 and later, pmlogger can be configured to dynamically log
319 new metrics that appear in the future, after the configuration
320 file is initially parsed.
321 10. Following all of the logging specifications, there may be an op‐
323 tional access control section, introduced by the literal token
324 [access]. Thereafter come access control rules that allow or dis‐
325 allow operations from particular hosts or groups of hosts.
326 The operations may be used to interrogate or control a running pm‐
328 logger using pmlc(1) and fall into the following classes:
329 enquire interrogate the status of pmlogger and the metrics
331 it is logging
332 advisory Change advisory logging.
333 mandatory Change mandatory logging.
334 all All of the above.
335 Access control rules are of the form ``allow hostlist : opera‐
337 tionlist ;'' and ``disallow hostlist : operationlist ;''.
338 The hostlist follows the syntax and semantics for the access con‐
340 trol mechanisms used by PMCD and are fully documented in pmcd(1).
341 An operationslist is a comma separated list of the operations ad‐
342 visory, mandatory, enquire and all.
343 A missing [access] section allows all access and is equivalent to
345 allow * : all;.
346 The configuration (either from standard input or conffile) is initially
348 scanned by pmcpp(1) with the options -rs and -I $PCP_VAR_DIR/config/pm‐
349 logger. This extends the configuration file syntax with include file
350 processing (%include), a common location to search for include files
351 ($PCP_VAR_DIR/config/pmlogger), macro definitions (%define), macro ex‐
352 pansion (%name and %{name}) and conditional inclusion of lines (%ifdef
353 name ... %else ... %endif and %ifndef name ... %else ... %endif).
354
356 The available command line options are:
357 -c conffile, --config=conffile
359 Specify the conffile file to use.
360 -C, --check
362 Parse configuration and exit.
363 -h host, --host=host
365 Fetch performance metrics from pmcd(1) on host, rather than from
366 the default localhost.
367 -H hostname, --labelhost=hostname
369 Specify the hostname to use instead of the one returned by
370 pmcd(1).
371 -I version, --pmlc-ipc-version=version
373 Normally, pmlogger and pmlc(1) will autonegotiate a mutually ac‐
374 ceptable version for their private IPC channel. Use -I to force
375 pmlogger to offer (at most) version as the version to be used.
376 This option may be required if pmlogger needs to be managed by an
377 older version of pmlc(1) that fails to autonegotiate correctly.
378 -K spec, --spec-local=spec
380 When fetching metrics from a local context (see -o), the -K option
381 may be used to control the DSO PMDAs that should be made accessi‐
382 ble. The spec argument conforms to the syntax described in pm‐
383 SpecLocalPMDA(3). More than one -K option may be used.
384 -l logfile, --log=logfile
386 Write all diagnostics to logfile instead of the default pmlog‐
387 ger.log.
388 -L, --linger
390 Run even if not the primary logger instance and nothing to log.
391 -m note, --note=note
393 Append note to the port map file for this instance.
394 -n pmnsfile, --namespace=pmnsfile
396 Load an alternative Performance Metrics Name Space (PMNS(5)) from
397 the file pmnsfile.
398 -N, --notify
400 Notify service manager such as systemd(1) as needed.
401 -o, --local-PMDA
403 Use a local context to collect metrics from DSO PMDAs on the local
404 host without PMCD. See also -K.
405 -p PID, --PID=PID
407 Log specified metrics for the lifetime of the pid PID.
408 -P, --primary
410 Run as primary logger instance. See above for more detailed de‐
411 scription of this.
412 -r, --report
414 Report record sizes and archive growth rate.
415 -s endsize, --size=endsize
417 Terminate after log size exceeds endsize.
418 -t interval, --interval=interval
420 Specify the logging interval. The default value is 60 seconds.
421 Please refer to the ENVIRONMENT and FILES sections below regarding
422 the PMLOGGER_INTERVAL environment variable and its impact on the
423 default logging interval.
424 -T endtime, --finish=endtime
426 Specify the endtime when to end logging.
427 -u Use unbuffered output. This is the default (so this option does
429 nothing).
430 -U username, --username=username
432 When in daemon mode, run as user username.
433 -v volsize, --volsize=volsize
435 Switch log volumes after reaching log volume size volsize.
436 -V version, --version=version
438 Specify log archive version. The default and the only accepted
439 value is 2.
440 -x fd
442 Allow asynchronous control requests on the file descriptor fd.
443 -y Use local timezone instead of the timezone from the pmcd(1) host.
445 -?, --help
447 Display usage message and exit.
448
450 For each PCP utility, there is a sample pmlogger configuration file
451 that could be used to create an archive log suitable for replaying with
452 that tool (i.e. includes all of the performance metrics used by the
453 tool). For a tool named foo this configuration file is located in
454 $PCP_VAR_DIR/config/pmlogger/config.foo.
455 The following is a simple default configuration file for a primary pm‐
457 logger instance, and demonstrates most of the capabilities of the con‐
458 figuration specification language.
459 log mandatory on once { hinv.ncpu hinv.ndisk }
461 log mandatory on every 10 minutes {
462 disk.all.write
463 disk.all.read
464 network.interface.in.packets [ "et0" ]
465 network.interface.out.packets [ "et0" ]
466 nfs.server.reqs [ "lookup" "getattr" "read" "write" ]
467 }
468 log advisory on every 30 minutes {
470 environ.temp
471 pmcd.pdu_in.total
472 pmcd.pdu_out.total
473 }
474 %include "macros.default"
476 %ifdef %disk_detail
478 log mandatory on %disk_detail_freq {
479 disk.dev
480 }
481 %endif
482 [access]
484 disallow * : all except enquire;
485 allow localhost : mandatory, advisory;
486
488 The archive logs are sufficiently precious that pmlogger will not trun‐
489 cate an existing physical file. A message of the form
490 ...: "foo.index" already exists, not over-written
491 ...: File exists
492 indicates this situation has arisen. You must explicitly remove the
493 files and launch pmlogger again.
494 There may be at most one primary pmlogger instance per monitored host;
496 attempting to bend this rule produces the error:
497 pmlogger: there is already a primary pmlogger running
498 Various other messages relating to the creation and/or deletion of
500 files in $PCP_TMP_DIR/pmlogger suggest a permission problem on this di‐
501 rectory, or some feral files have appeared therein.
502
504 archive.meta
505 metadata (metric descriptions, instance domains, etc.) for the ar‐
506 chive log
507 archive.0
509 initial volume of metrics values (subsequent volumes have suffixes
510 1, 2, ...)
511 archive.index
513 temporal index to support rapid random access to the other files
514 in the archive log
515 $PCP_TMP_DIR/pmlogger
517 pmlogger maintains the files in this directory as the map between
518 the process id of the pmlogger instance and the IPC port that may
519 be used to control each pmlogger instance (as used by pmlc(1))
520 $PCP_VAR_DIR/config/pmlogger/config.default
522 default configuration file for the primary logger instance
523 launched from $PCP_RC_DIR/pmlogger
524 $PCP_VAR_DIR/config/pmlogger/config.*
526 assorted configuration files suitable for creating logs that may
527 be subsequently replayed with the PCP visualization and monitoring
528 tools
529 $PCP_ARCHIVE_DIR/<hostname>
531 Default directory for PCP archive files for performance metric
532 values collected from the host <hostname>.
533 $PCP_SYSCONFIG_DIR/pmlogger
535 additional environment variables that will be set when the primary
536 pmlogger instance executes. Only settings of the form "PMLOG‐
537 GER_VARIABLE=value" will be honoured.
538 ./pmlogger.log
540 (or $PCP_ARCHIVE_DIR/<hostname>/pmlogger.log when started automat‐
541 ically by either $PCP_RC_DIR/pmlogger or one of the pmlogger(1)
542 monitoring scripts such as pmlogger_check(1))
543 all messages and diagnostics are directed here
544
546 Normally pmlogger creates a socket to receive control messages from
547 pmlc(1) on the first available TCP/IP port numbered 4330 or higher.
548 The environment variable PMLOGGER_PORT may be used to specify an alter‐
549 native starting port number.
550 If set to the value 1, the PMLOGGER_LOCAL environment variable will
552 cause pmlogger to run in a localhost-only mode of operation, where it
553 binds only to the loopback interface.
554 The PMLOGGER_REQUEST_TIMEOUT variable may be set by applications such
556 as pmlc(1) to specify a timeout in seconds for connection requests to
557 the pmlogger control port. If not set, connections may block indefi‐
558 nitely. This variable would not normally be set by pmlogger itself.
559 The PMLOGGER_MAXPENDING variable can be set to indicate the maximum
561 length to which the queue of pending pmlc connections may grow.
562 The default sampling interval used by pmlogger can be set using the PM‐
564 LOGGER_INTERVAL variable (if not set, 60 seconds will be used). Both
565 the command line and directives in the configuration file will override
566 this value. It is an integer in units of seconds.
567 On platforms using systemd(1), and when the -N option is given, the NO‐
569 TIFY_SOCKET environment variable would normally be set by the service
570 manager prior to launching pmlogger.
571
573 Environment variables with the prefix PCP_ are used to parameterize the
574 file and directory names used by PCP. On each installation, the file
575 /etc/pcp.conf contains the local values for these variables. The
576 $PCP_CONF variable may be used to specify an alternative configuration
577 file, as described in pcp.conf(5).
578
580 PCPIntro(1), pmcd(1), pmdumplog(1), pmlc(1), pmlogger_check(1), system‐
581 ctl(1), systemd(1), execvp(3), pmSpecLocalPMDA(3), strftime(3), __pm‐
582 ServerNotifyServiceManagerReady(3), pcp.conf(5), pcp.env(5), pmlog‐
583 ger(5), PMNS(5) and chkconfig(8).
584Performance Co-Pilot PCP PMLOGGER(1)