Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

newhelp(1) [centos man page]

NEWHELP(1)						      General Commands Manual							NEWHELP(1)

NAME
newhelp - generate a performance metrics help database SYNOPSIS
$PCP_BINADM_DIR/newhelp [-V] [-n pmnsfile] [-o outputfile] [-v version] [file ...] DESCRIPTION
newhelp generates the Performance Co-Pilot help text files used by Performance Metric Domain Agents (PMDAs). Normally newhelp operates on the default Performance Metrics Namespace (PMNS), however if the -n option is specified an alternative names- pace is loaded from the file pmnsfile. When there is only one input file, the base name of the new database is derived from the name of the input file, otherwise the -o flag must be given to explicitly name the database. If no input files are supplied, newhelp reads from the standard input stream, in which case the -o flag must be given. If the output file name is determined to be foo, newhelp will create foo.dir and foo.pag. Although historically there have been multiple help text file formats, the only format currently supported using the -v option is version 2, and this is the default if no -v flag is provided. The -V flag causes verbose messages to be printed while newhelp is parsing its input. The first line of each entry in a help source file consists of an ``@'' character beginning the line followed by a space and then the per- formance metric name and a one line description of the metric. Following lines (up to the next line beginning with ``@'' or end of file) may contain a verbose help description. E.g. # # This is an example of newhelp's input syntax # @ kernel.all.cpu.idle CPU idle time A cumulative count of the number of milliseconds of CPU idle time, summed over all processors. Three-part numeric metric identifiers (PMIDs) may be used in place of metric names, e.g. 60.0.23 rather than kernel.all.cpu.idle in the example above. Other than for dynamic metrics (where the existence of a metric is known to a PMDA, but not visible in the PMNS and hence has no name that could be known to newhelp) use of this syntactic variant is not encouraged. Lines beginning with ``#'' are ignored, as are blank lines in the file before the first ``@''. The verbose help text is optional. As a special case, a ``metric'' name of the form NNN.MM (for numeric NNN and MM) is interpreted as an instance domain identification, and the text describes the instance domain. FILES
$PCP_VAR_DIR/pmns/* default PMNS specification files PCP ENVIRONMENT
Environment variables with the prefix PCP_ are used to parameterize the file and directory names used by PCP. On each installation, the file /etc/pcp.conf contains the local values for these variables. The $PCP_CONF variable may be used to specify an alternative configura- tion file, as described in pcp.conf(5). SEE ALSO
chkhelp(1), PMAPI(3), pmLookupInDomText(3), pmLookupText(3), pcp.conf(5) and pcp.env(5). Performance Co-Pilot PCP NEWHELP(1)

Check Out this Related Man Page

PCP(1)							      General Commands Manual							    PCP(1)

NAME
pcp - summarize a Performance Co-Pilot (PCP) installation SYNOPSIS
pcp [-p] [-a archive] [-h host] [-n pmnsfile] DESCRIPTION
The pcp command summarizes the status of a Performance Co-Pilot (PCP) installation. The report includes: the OS version, a summary of the hardware inventory, the local timezone, details of valid PCP licenses, the PCP software version, the state of the pmcd(1) process and asso- ciated Performance Metrics Domain Agents (PMDAs), as well as information about any PCP archive loggers (pmlogger(1)) and PCP inference engines (pmie(1)) that are running. For more general information about PCP, refer to PCPIntro(1). With no arguments, pcp reports on the local host, however the following options are accepted: -a archive Report the PCP configuration as described in the PCP archive log archive. -h host Report the PCP configuration on host rather than the local host. -n pmnsfile Load an alternative Performance Metrics Name Space (pmns(5)) from the file pmnsfile. -p Display pmie performance information - counts of rules evaluating to true, false, or indeterminate, as well as the expected rate of rule calculation, for each pmie process running on the default host. Refer to the individual metric help text for full details on these values. All of the displayed values are performance metric values and further information for each can be obtained using the command: $ pminfo -dtT metric The complete set of metrics required by pcp to produce its output is contained in $PCP_SYSCONF_DIR/pmlogger/config.pcp. When displaying running pmlogger instances, as a space-saving measure pcp will display a relative path to the archive being created if that archive is located below a pcplog subdirectory, otherwise the full pathname is displayed (the PCP log rotation and periodic pmlogger check- ing facilities support the creation of archives below $PCP_LOG_DIR/pmlogger/<hostname>). A similar convention is used for trimming the amount of information displayed for running pmie instances, where configuration files below $PCP_VAR_DIR/config will be displayed in truncated form. FILES
$PCP_SYSCONF_DIR/pmlogger/config.pcp pmlogger configuration file for collecting all of the metrics required by pcp. PCP ENVIRONMENT
Environment variables with the prefix PCP_ are used to parameterize the file and directory names used by PCP. On each installation, the file /etc/pcp.conf contains the local values for these variables. The $PCP_CONF variable may be used to specify an alternative configura- tion file, as described in pcp.conf(5). SEE ALSO
PCPIntro(1), pmcd(1), pmie(1), pmlogger(1), pcp.conf(5) and pcp.env(5). DIAGNOSTICS
pcp will terminate with an exit status of 1 if pmcd on the target host could not be reached or the archive could not be opened, or 2 for any other error. Performance Co-Pilot PCP PCP(1)
Man Page