.TH PERFD 1M
\"
\"	performance daemon -- Chris Bertin
\"
.SH NAME
perfd \- multiplatform system performance metric server
.SH SYNOPSIS
.B perfd
[options]
.SH DESCRIPTION
.PP
.I Perfd
is a system performance daemon that provides real-time
access to system performance metrics, locally or remotely.
For all but the global
metric class, \fIperfd\fR provides data for the last interval only.
For global data, \fIperfd\fR can provide average, minimum, maximum values
as well as standard deviation, based on a configurable collection depth.
.PP
The options are:
.PP
.TP 8
.B \-A class1[,class2,...]\fR
This option specifies a list of metric classes for which data should be
collected. The argument is a comma-separated list of class names. This
option is useful to add individual metric classes when the \fB-l\fR
option is used.
See \fBMETRIC CLASSES\fR below.
.TP
.B \-c directory\fR
This option specifies an alternate configuration directory. \fIperfd\fR
will change its working directory to the specified location and attempt to
load additional configuration options from \fBperfd.ini\fR (see
\fBFILES\fR below). If a \fBparm\fR file is not present in the specified
directory, \fIperfd\fR will use the system-wide file in the official
configuration directory. The default configuration directory is platform
dependent (see \fBDEFAULT LOCATIONS\fR below).
.TP
.B \-C\fR
Check configuration file and exit. If the \fB-c\fR option is
specified, the configuration in that directory is checked.
.TP
.B \-d depth\fR
This option specifies the number of intervals for which global metric
values are kept. By default, \fIperfd\fR keeps 5-minute historical data
for all global (single-instance) metrics.
.TP
.B \-f\fR
This option is intended for debug purposes only and will cause \fIperfd\fR
to run in the foreground instead of backgrounding itself.
.TP
.B \-i interval\fR
This option specifies the data collection frequency. The default is 10
seconds.
.TP
.B \-l\fR
If this option is present, \fIperfd\fR will only collect data for basic
metric classes.
See \fBMETRIC CLASSES\fR below.
.TP
.B \-L size\fR
This option specifies a file size above which \fIperfd\fR will roll its
log or trace files. The default size is \fB1Mb\fR (\fB1048576 bytes\fR).
Specifying a size smaller than \fB4096\fR is silently ignored.
.TP
.B \-p port\fR
This option specifies an alternate port. The default registered port
number for \fIperfd\fR is \fB5227\fR.
.TP
.B \-r maxrps\fR
This option specifies the maximum number of requests that a given thread
is allowed to send per second. If the limit is exceeded, the server will
pause for one second and \fIperfd\fR will log this information in the
log file (see \fBFILES\fR below).
The default limit is 20.
.TP
.B \-s\fR
This option causes the server to deny all requests except those coming
from the host system via the loopback interface (\fBlocalhost\fR).
Denied connection requests are logged (see \fBFILES\fR below).
.TP
.B \-t maxtpc\fR
This option specifies the maximum number of threads per client system.
The default number is 30. If the number is exceeded, the connection
request is denied.
Denied connection requests are logged (see \fBFILES\fR below).
.TP
.B \-x maxcps\fR
This option specifies the maximum number of connections the server will
handle per second. The default is 2. If the number of connection requests
exceeds this value, the server will pause for 3 seconds before establishing
the connection.
.TP
.B \-X class1[,class2,...]\fR
This option specifies a list of metric classes for which data should \fBnot\fR
be collected. The argument is a comma-separated list of class names. This
option can be used to exclude individual metric classes, particularly when
the \fB-l\f option is not present.
See \fBMETRIC CLASSES\fR below.
.TP
.B \-4\fR
This option causes \fIperfd\fR to accept only \fBIPv4\fR connections.
By default, \fIperfd\fR listens for both \fBIPv4\fR
and \fBIPv6\fR client requests so this option should only
be used if explicitly disabling \fBIPv6\fR is desired.
.TP
.B \-?\fR
Print option list.
.SH FILES
All options that can be specified at run-time can also be placed in the
configuration file:
.P
.B <CONFIGDIR>/perfd.ini\fR.
.P
Options
specified on the command
line take precedence over the options specified in the configuration
file. Each line in the file specifies a
run-time option. Characters after the pound sign (\fB#\fR) are ignored.
This is an example of a valid configuration file:
.P
.nf
#
# perfd configuration
#
interval=10
depth=60
maxrps=50
lightweight=false
localonly=false
.fi
.P
The list of valid configuration arguments is:
.P
.nf
depth=<valid numerical depth value>
interval=<valid numerical interval value>
ipv4=<true/false>
lightweight=<true/false>
logsize=<valid numeric value>
port=<valid numerical port value>
maxrps=<valid numerical maxrps value>
localonly=<true/false>
maxtpc=<valid numerical maxtpc value>
maxcps=<valid numerical maxcps value>
add=<valid comma-separated list of classes>
exclude=<valid comma-separated list of classes>
.fi
.P
A log file is maintained for each instance of \fIperfd\fR as well. The
log file is named:
.P
.B <CONFIGDIR>/status.perfd-<port>\fR
.P
where \fB<CONFIGDIR>\fR is the location below and \fB<port>\fR
is the port number. The log file will contain start and stop messages as
well as any exception condition, each message time stamped.
.P
The administrator can also limit which system(s) are allowed to
access \fIperfd\fR data using:
.P
.B <CONFIGDIR>/authip
.P
If the administrator wants
both \fIperfd\fR and the \fIPerformance Agent\fR to use the same list,
this file should be [symbolically] linked with:
.P
.B /var/opt/OV/conf/perf/authip
.P
The format of the \fBauthip\fR file is discussed in
the \fBovpainst.pdf\fR document, in \fBPA\fR's \fBpaperdoc\fR directory.
Essentially, they are a list of system names or \fBIP\fR
addresses (\fBIPv4\fR or \fBIPv6\fR). Note that
changes to this file will require a restart of the \fIperfd\fR daemon to
take effect.
.SH "METRIC CLASSES"
The \fBperfd\fR daemon can run in two main modes, heavy-weight and
light-weight and the data that is collected can be further controlled
using the \fB-A\fR and \fB-X\fR command line options or the \fBadd\fR and
\fBexclude\fR entries in \fBperfd.ini\fR.
.P
In light-weight mode (\fB-l\fR command line option,
or \fBlightweight=true\fR in \fRperfd.ini\fR), only basic
metric classes are enabled: GLOBAL, TABLE (where available), BYDSK, FS,
BYNETIF, BYSWP, BYCPU. The only class
that can be excluded, in this mode, is the FS (FILESYSTEM) class.
.P
In heavy-weight mode, which is the default mode, perfd will collect data
for all available metric classes, except the LV (Logical Volume) data on
AIX and Solaris.
This means that the only class that can be added is the LV class on
these two platforms.
.P
The following classes can be added to a light-weight \fBperfd\fR or
excluded from a heavy-weight one: BYLS, PROC, APP,
LV, FS, NFS, TT (TRANSACTION), HBA, SYSCALL and LDOM. Note that not all these
classes are available on all platforms. Attempting to
exclude metric classes on which other classes depend will be denied. The
main example is attempting to exclude the PROC class and not the APP
class. A message will be logged when requests to exclude classes are not
honored. Sub-classes (drilldown classes) for the main metrics classes,
such as BYDSKDETAIL on HP-UX or BYREGION on Unix platforms, are available
when the main class is enabled and cannot be controlled independently.
Also, at this point, the THREAD class, on systems where it is
available, is tied to the PROC class and cannot be enabled or disabled.
.P
When metric classes are disabled, the global metrics that depend on those
classes will return "na" (not available). For example, if the FS class is
disabled, the GBL_FS_SPACE_UTIL_PEAK metric will return "na", if the PROC
class is disabled, GBL_ACTIVE_PROC, GBL_ALIVE_PROC, etc... will return
"na".
.SH "DEFAULT LOCATIONS"
On HPUX, Linux, Solaris and AIX, the default configuration directory
referred to as \fB<CONFIGDIR>\fR above is
\fB/var/opt/perf\fR, on Windows, the configuration location is specified
when the software is installed and the information is placed in the
registry.
.SH "SEE ALSO"
.PP
\fBglance\fR(1), \fBxglance\fR(1), \fBcpsh\fR(1), \fBpadv\fR(1), \fBmpadv\fR(1).