'\"! tbl | mmdoc
'\"macro stdmacro
.\"
.\" Copyright (c) 2015-2018,2022 Red Hat.
.\" Copyright (c) 2000 Silicon Graphics, Inc.  All Rights Reserved.
.\"
.\" This program is free software; you can redistribute it and/or modify it
.\" under the terms of the GNU General Public License as published by the
.\" Free Software Foundation; either version 2 of the License, or (at your
.\" option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful, but
.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
.\" or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
.\" for more details.
.\"
.\"
.TH PMVAL 1 "PCP" "Performance Co-Pilot"
.SH NAME
\f3pmval\f1,
\f3pmevent\f1 \- arbitrary performance metrics value dumper
.SH SYNOPSIS
\f3pmval\f1
[\f3\-dgLrvVXz?\f1]
[\f3\-a\f1 \f2archive\f1]
[\f3\-A\f1 \f2align\f1]
[\f3\-\-container\f1=\f2name\f1]
[\f3\-\-derived\f1=\f2file\f1]
[\f3\-f\f1 \f2N\f1]
[\f3\-h\f1 \f2host\f1]
[\f3\-i\f1 \f2instances\f1]
[\f3\-K\f1 \f2spec\f1]
[\f3\-n\f1 \f2pmnsfile\f1]
[\f3\-O\f1 \f2offset\f1]
[\f3\-p\f1 \f2port\f1]
[\f3\-s\f1 \f2samples\f1]
[\f3\-S\f1 \f2starttime\f1]
[\f3\-t\f1 \f2interval\f1]
[\f3\-T\f1 \f2endtime\f1]
[\f3\-U\f1 \f2archive\f1]
[\f3\-w\f1 \f2width\f1]
[\f3\-x\f1 \f2pattern\f1]
[\f3\-Z\f1 \f2timezone\f1]
\f2metricname\f1
.sp
\f3pmevent\f1
\&...
.SH DESCRIPTION
.de EX
.in +0.5i
.ie t .ft CB
.el .ft B
.ie t .sp .5v
.el .sp
.ta \\w' 'u*8
.nf
..
.de EE
.fi
.ie t .sp .5v
.el .sp
.ft R
.in
..
.B pmval
prints current or archived values for the nominated performance metric.
The metric of interest is named in the
.I metricname
argument, subject to instance qualification with the
.B \-i
flag as described below.
.PP
Unless directed to another host by the
.B \-h
option,
or to a set of archives by the
.B \-a
or
.B \-U
options,
.B pmval
will contact the Performance Metrics Collector Daemon (PMCD)
on the local host to obtain the required information.
.PP
The
.I metricname
argument may also be given in the metric specification syntax, as
described in
.BR PCPIntro (1),
where the source, metric and instance may all be included in the
.IR metricname ,
e.g. thathost:kernel.all.load["1 minute"].
When this format is used, none of the
.B \-h
or
.B \-a
or
.B \-U
options may be specified.
.PP
When using the metric specification syntax, the ``hostname''
.B @
is treated specially and
causes
.B pmval
to use a local context to collect metrics from PMDAs on the local host
without PMCD.
Only some metrics are available in this mode.
.PP
When processing a set of archives,
.B pmval
may relinquish its own timing control, and operate under the control of a
a
.BR pmtime (1)
process that uses a GUI dialog to provide timing control.
In this case, either the
.B \-g
option should be used to start
.B pmval
as the sole client of a new
.BR pmtime (1)
instance, or
.B \-p
should be used to attach
.B pmval
to an existing
.BR pmtime (1)
instance via the IPC channel identified by the
.I port
argument.
.PP
The
.BR \-S ,
.BR \-T ,
.BR \-O
and
.B \-A
options may be used to define a time window to restrict the
samples retrieved, set an initial origin within the time window,
or specify a ``natural'' alignment of the sample times; refer to
.BR PCPIntro (1)
for a complete description of these options.
.PP
The output from
.B pmval
is directed to standard output.
The following symbols may occasionally appear, in place of a metric value, in
.B pmval
output:  A question mark symbol (?) indicates that a value is no
longer available for that metric instance.
An exclamation mark (!)
indicates that a 64-bit counter wrapped during the sample.
.PP
.B pmevent
is an alias for
.BR pmval .
.SH OPTIONS
The available command line options are:
.TP 5
\fB\-a\fR \fIarchive\fR, \fB\-\-archive\fR=\fIarchive\fR
Performance metric values are retrieved from the set of Performance
Co-Pilot (PCP) archive files identified by the
.I archive
argument, which is a comma-separated list of names,
each of which may be the base name of an archive or the name of
a directory containing one or more archives.
See also
.BR \-U .
.TP
\fB\-A\fR \fIalign\fR, \fB\-\-align\fR=\fIalign\fR
Force the initial sample to be
aligned on the boundary of a natural time unit
.IR align .
Refer to
.BR PCPIntro (1)
for a complete description of the syntax for
.IR align .
.TP
\fB\-\-container\fR=\fIcontainer\fR
Specify an individual
.I container
to be queried.
.TP
\fB\-d\fR, \fB\-\-delay\fR
When replaying from an archive, this option requests that the prevailing
real-time delay be applied between samples (see
.BR \-t )
to effect a pause, rather than
the default behaviour of replaying at full speed.
.TP
\fB\-\-derived\fR=\fIfile\fR
Load derived metric definitions from
.IR file .
.TP
\fB\-f\fR \fIprecision\fR, \fB\-\-precision\fR=\fIprecision\fR
Numbers are reported in ``fixed point'' notation, rather than the default
scientific notation, using
.IR precision
digits for precision.
Each number will be up to the column width determined by
the default heuristics, else the
.B \-w
option if specified, and include
.I precision
digits after the decimal point.
So, the options
.B "\-f 3 \-w 8"
would produce numbers of the form 9999.999.
A value of zero for
.I precision
omits the decimal point and any fractional digits.
.TP
\fB\-g\fR, \fB\-\-guimode\fR
Start
.B pmval
as the sole client of a new
.BR pmtime (1)
server process for replay of archived performance data using the
.BR pmtime (1)
graphical user interface.
.TP
\fB\-h\fR \fIhost\fR, \fB\-\-host\fR=\fIhost\fR
Fetch performance metrics from
.BR pmcd (1)
on
.IR host ,
rather than from the default localhost.
.TP
\fB\-i\fR \fIinstances\fR, \fB\-\-instances\fR=\fIinstances\fR
Specify a list of one or more names of
.I instances
for the nominated performance metric \- just these
.I instances
will be retrieved and reported
(the default is to report all instances).
The list must be a single argument, with
elements of the list separated by commas and/or white space.
.RS
.PP
The instance name may be quoted with single (') or double (") quotes
for those cases where
the instance name contains white space or commas.
.PP
Multiple
.B \-i
options are allowed as an alternative way of specifying more than
one instance of interest.
.PP
As an example, the following are all equivalent:
.EX
$ pmval \-i "'1 minute','5 minute'" kernel.all.load
$ pmval \-i '"1 minute","5 minute"' kernel.all.load
$ pmval \-i "'1 minute' '5 minute'" kernel.all.load
$ pmval \-i "'1 minute'" \-i "'5 minute'" kernel.all.load
$ pmval 'localhost:kernel.all.load["1 minute","5 minute"]'
.EE
.RE
.TP
\fB\-K\fR \fIspec\fR, \fB\-\-spec\-local\fR=\fIspec\fR
When fetching metrics from a local context (see
.BR \-L ),
the
.B \-K
option may be used to control the DSO PMDAs that should be made accessible.
The
.I spec
argument conforms to the syntax described in
.BR pmSpecLocalPMDA (3).
More than one
.B \-K
option may be used.
.TP
\fB\-L\fR, \fB\-\-local\-PMDA\fR
Use a local context to collect metrics from DSO PMDAs on the local host
without PMCD.
See also
.BR \-K .
.TP
\fB\-n\fR \fIpmnsfile\fR, \fB\-\-namespace\fR=\fIpmnsfile\fR
Load an alternative Performance Metrics Name Space
.RB ( PMNS (5))
from the file
.IR pmnsfile .
.TP
\fB\-O\fR \fIorigin\fR, \fB\-\-origin\fR=\fIorigin\fR
When reporting archived metrics, start reporting at
.I origin
within the time window (see
.B \-S
and
.BR \-T ).
Refer to
.BR PCPIntro (1)
for a complete description of the syntax for
.IR origin .
.TP
\fB\-p\fR \fIport\fR, \fB\-\-guiport\fR=\fIport\fR
Attach
.B pmval
to an existing
.BR pmtime (1)
time control process instance via the IPC channel identified by the
\f2port\f1 argument.
This option is normally only used by other tools, e.g.
.BR pmchart (1),
when they launch
.B pmval
with synchronized time control.
.TP
\fB\-r\fR, \fB\-\-raw\fR
Print raw values for cumulative counter metrics.
Normally cumulative counter metrics are converted to rates.
For example, disk transfers are reported
as number of disk transfers per second during the preceding sample interval,
rather than the raw value of number of disk transfers since the machine was
booted.
If you specify this option, the raw metric values are printed.
.TP
\fB\-s\fR \fIsamples\fR, \fB\-\-samples\fR=\fIsamples\fR
The
.I samples
argument defines the number of samples to be retrieved and reported.
If
.I samples
is 0 or
.B \-s
is not specified,
.B pmval
will sample and report continuously (in real time mode) or until the end
of the set of PCP archives (in archive mode).
.TP
\fB\-S\fR \fIstarttime\fR, \fB\-\-start\fR=\fIstarttime\fR
When reporting archived metrics, the report will be restricted to those
records logged at or after
.IR starttime .
Refer to
.BR PCPIntro (1)
for a complete description of the syntax for
.IR starttime .
.TP
\fB\-t\fR \fIinterval\fR, \fB\-\-interval\fR=\fIinterval\fR
Set the reporting
.I interval
to something other than the default 1 second.
The
.I interval
argument follows the syntax described in
.BR PCPIntro (1),
and in the simplest form may be an unsigned integer
(the implied units in this case are seconds).
.TP
\fB\-T\fR \fIendtime\fR, \fB\-\-finish\fR=\fIendtime\fR
When reporting archived metrics, the report will be restricted to those
records logged before or at
.IR endtime .
Refer to
.BR PCPIntro (1)
for a complete description of the syntax for
.IR endtime .
.TP
\fB\-U\fR \fIarchive\fR, \fB\-\-nointerp\fR=\fIarchive\fR
Performance metric values are retrieved from the Performance Co-Pilot (PCP)
.IR archive .
The argument is a comma-separated list of names, each
of which may be the base name of an archive or the name of a directory containing
one or more archives.
However, unlike
.B \-a
every recorded value in the archive for the selected metric
and instances is reported (so no interpolation mode, and the sample
interval (\c
.B \-t
option) is ignored.
See also
.BR \-a .
.RS +5n
.PP
At most one of the options
.B \-a
and
.B \-U
may be specified.
.RE
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Enable verbose mode.
.TP
\fB\-V\fR, \fB\-\-version\fR
Display version number and exit.
.TP
\fB\-w\fR \fIwidth\fR, \fB\-\-width\fR=\fIwidth\fR
Set the width of each column of output to be
.I width
columns.
If not specified columns are wide
enough to accommodate the largest value of the type being printed.
.TP
\fB\-x\fR \fIpattern\fR, \fB\-\-filter\fR=\fIpattern\fR
The given
.I pattern
is sent to the performance metric domain agent for the requested
.I metricname
before any values are requested.
This serves two purposes.
Firstly, it provides a mechanism for server-side event filtering
that is customisable for individual event streams.
In addition, some performance metrics domain agents also use the
PMCD store mechanism to provide a basic security model (e.g. for
sensitive log files, only a client host with
.BR pmStore (3)
access would be able to access the event stream).
.RS
.PP
As
.I pattern
may be processed by
.BR regcomp (3)
it should be a non-empty string.
Use . (dot) for a \(lqmatch all\(rq
.IR pattern .
.RE
.TP
\fB\-X\fR, \fB\-\-timestamp\fR
When replaying from an archive, this option requests that the
timestamp be reported with additional date information and increased
precision (microseconds with a single \fB\-X\fR, nanoseconds with an
additional \fB\-X\fR), for example
.B "Sat\ May\ 22\ 20:32:20.971633\ 2021"
instead of the default format, for example
.BR "20:32:20.971" .
.TP
\fB\-z\fR, \fB\-\-hostzone\fR
Use the local timezone of the host that is the source of the
performance metrics, as identified by either the
.B \-h
or the
.B \-a
or the
.B \-U
options.
The default is to use the timezone of the local host.
.TP
\fB\-Z\fR \fItimezone\fR, \fB\-\-timezone\fR=\fItimezone\fR
Use
.I timezone
for the date and time.
.I Timezone
is in the format of the environment variable
.B TZ
as described in
.BR environ (7).
.TP
\fB\-?\fR, \fB\-\-help\fR
Display usage message and exit.
.SH CAVEATS
By default,
.B pmval
attempts to display non-integer numeric values in a way that does not distort the
inherent precision (rarely more than 4 significant
digits), and tries to maintain a tabular format in
the output.
These goals are sometimes in conflict.
.PP
In the absence of the
.B \-f
option (described above),
the following table describes the formats used for different
ranges of numeric values for any metric that is of type
.B PM_TYPE_FLOAT
or
.BR PM_TYPE_DOUBLE ,
or any metric that has the semantics of a counter (for
which
.B pmval
reports the rate converted value):
.TS
box,center;
cf(R) | cf(R)
rf(CR) | lf(R).
Format	Value Range
_
!	No values available
9.999E-99	< 0.1
0.0\0\0\0	0
9.9999	> 0 and <= 0.9999
9.999\0	> 0.9999 and < 9.999
99.99\0\0	> 9.999 and < 99.99
999.9\0\0\0	> 99.99 and < 999.9
9999.\0\0\0\0	> 999.9 and < 9999
9.999E+99	> 9999
.TE
.SH PCP ENVIRONMENT
Environment variables with the prefix \fBPCP_\fP are used to parameterize
the file and directory names used by PCP.
On each installation, the
file \fI/etc/pcp.conf\fP contains the local values for these variables.
The \fB$PCP_CONF\fP variable may be used to specify an alternative
configuration file, as described in \fBpcp.conf\fP(5).
.PP
For environment variables affecting PCP tools, see \fBpmGetOptions\fP(3).
.SH SEE ALSO
.BR PCPIntro (1),
.BR pmcd (1),
.BR pmchart (1),
.BR pmdumptext (1),
.BR pminfo (1),
.BR pmlogdump (1),
.BR pmlogger (1),
.BR pmrep (1),
.BR pmtime (1),
.BR PMAPI (3),
.BR pmSpecLocalPMDA (3),
.BR pmStore (3),
.BR pcp.conf (5),
.BR pcp.env (5)
and
.BR PMNS (5).

.\" control lines for scripts/man-spell
.\" +ok+ sp {from .sp in troff macro defn} thathost