There is a set of common command line arguments that are used
consistently by most PCP tools.
-a
archive, --archive
=archive
Performance metric information is retrospectively
retrieved from the set of Performance Co-Pilot (PCP)
archives identified by archive previously generated by
pmlogger(1). See LOGIMPORT(3) and LOGARCHIVE(5) for
archive creation interfaces and format documentation.
archive is a comma-separated list of names, each of which
may be the name of a directory containing one or more
archives, the base name common to all of the physical
files created by an instance of pmlogger(1), or any one of
the physical files, e.g. /path/to/myarchives (directory)
or myarchive (base name) or myarchive.meta
(the metadata
file) or myarchive.index
(the temporal index) or
myarchive.0
(the first data volume of archive) or
myarchive.0.bz2
or myarchive.0.bz
(the first data volume
compressed with bzip2
(1)) or myarchive.0.gz
or
myarchive.0.Z
or myarchive.0.z
(the first data volume
compressed with gzip
(1)), myarchive.1
or myarchive.3.bz2
or myarchive.42.gz
etc.
-h
host, --host
=host
Unless directed to another host by the -h
(or --host
)
option, or to a set of archives by the -a
(or --archive
)
option, the source of performance metrics will be the
Performance Metrics Collector Daemon (PMCD) on the local
host. Refer to the PMCD HOST SPECIFICATION
section later
for further details on the many options available when
forming the host specification, as well as a detailed
description of the default local host connection. The -a
(or --archive
), and -h
(or --host
) options are mutually
exclusive.
-s
samples, --samples
=samples
The argument samples defines the number of samples to be
retrieved and reported. If samples is 0 or -s
(or
--samples
) is not specified, the application will sample
and report continuously (in real time mode) or until the
end of the set of PCP archives (in archive mode).
-z
, --hostzone
Change the reporting timezone to the local timezone at the
host that is the source of the performance metrics, as
identified via either the -h
(or --host
) or -a
(or
--archive
) options.
-Z
timezone, --timezone
=timezone
By default, applications report the time of day according
to the local timezone on the system where the application
is executed. The -Z
(or --timezone
) option changes the
timezone to timezone in the format of the environment
variable TZ
as described in environ(7).
-D
debugspec, --debug
=debugspec
Sets the PCP debugging options to debugspec to enable
diagnostics and tracing that is most helpful for
developers or when trying to diagnose the misbehaviour of
a PCP application. debugspec should be a comma-separated
list of debugging option name(s) and/or decimal integers,
see pmdbg(1) for a description of the supported option
names and values.
In the absence of a live or archive source of metrics, a
heuristic search for archive logs for the local host can be
invoked via the -O
(or --origin
) option. When using this option
without an explicit source of metrics, monitor tools attempt to
use archives from a system archive location such as
$PCP_LOG_DIR/pmlogger/`hostname`
. Refer to the TIME WINDOW
SPECIFICATION
section below for details on the acceptable syntax
for the origin option, but a typical invocation in this mode
would be -O today
or --origin yesterday
.