pmtrimnamespace(3) [centos man page]

PMTRIMNAMESPACE(3)					     Library Functions Manual						PMTRIMNAMESPACE(3)

NAME

       pmTrimNameSpace - prune a performance metrics name space

C SYNOPSIS

       #include <pcp/pmapi.h>

       int pmTrimNameSpace(void);

       cc ... -lpcp

DESCRIPTION

       If  the current Performance Metrics Application Programming Interface (PMAPI) context corresponds to a version 1 archive log of Performance
       Co-Pilot (PCP) performance metrics (as collected by pmlogger(1) -V1), then the currently loaded Performance Metrics Name Space  (PMNS),	is
       trimmed to exclude metrics for which no description can be found in the archive.  The PMNS is further trimmed to remove empty subtrees that
       do not contain any performance metric.

       Since PCP archives usually contain some subset of all metrics named in the default PMNS, pmTrimNameSpace  effectively  trims  the  applica-
       tion's PMNS to contain only the names of the metrics in the archive.

       Since PCP 2.0, pmTrimNameSpace is only needed for dealing with version 1 archives.  Version 2 archives actually store the "trimmed" PMNS.

       Prior to any trimming, the PMNS is restored to the state as of the completion of the last pmLoadASCIINameSpace(3) or pmLoadNameSpace(3), so
       the effects of consecutive calls to pmTrimNameSpace with archive contexts are not additive.

       If the current PMAPI context corresponds to a host and a pmLoadASCIINameSpace(3) or pmLoadNameSpace(3) call was made, then the PMNS reverts
       to all names loaded into the PMNS at the completion of the last pmLoadASCIINameSpace(3) or pmLoadNameSpace(3), i.e. any trimming is undone.

       On success, pmTrimNameSpace returns zero.

SEE ALSO

       pmlogger(1), PMAPI(3), pmLoadASCIINameSpace(3), pmLoadNameSpace(3), pmNewContext(3) and pmns(5).

DIAGNOSTICS

       PM_ERR_NOPMNS
	      you must have loaded a PMNS using pmLoadASCIINameSpace(3) or pmLoadNameSpace(3) before calling pmTrimNameSpace

       PM_ERR_NOCONTEXT
	      the current PMAPI context is invalid

Performance Co-Pilot							PCP							PMTRIMNAMESPACE(3)

PMLOADNAMESPACE(3)					     Library Functions Manual						PMLOADNAMESPACE(3)

NAME

       pmLoadNameSpace - load a local PMNS for an application

C SYNOPSIS

       #include <pcp/pmapi.h>

       int pmLoadNameSpace(const char *filename);

       cc ... -lpcp

DESCRIPTION

       If  the	application wants to force using a local Performance Metrics Name Space (PMNS) instead of a distributed PMNS then it must load the
       PMNS using pmLoadNameSpace or pmLoadASCIINameSpace(3).  If the application is to use a distributed PMNS, then it should NOT make a call	to
       load the PMNS explicitly.

       The filename argument designates the PMNS of interest.  For applications not requiring a tailored PMNS, the special value PM_NS_DEFAULT may
       be used for filename, to force the default local PMNS to be loaded.

       The default local PMNS is found in the file $PCP_VAR_DIR/pmns/root unless the environment variable PMNS_DEFAULT is set, in which  case  the
       value is assumed to be the pathname to the file containing the default local PMNS.

       Externally a PMNS is stored in an ASCII format as described in pmns(5).

       By  default,  multiple names in the PMNS are not allowed to be associated with a single Performance Metrics Identifier (PMID).  pmLoadASCI-
       INameSpace(3) provides an alternative interface with user-defined control over the processing of duplicate PMIDs in the PMNS.

       pmLoadNameSpace returns zero on success.

FILES

       $PCP_VAR_DIR/pmns/root	the default local PMNS, when the environment variable PMNS_DEFAULT is unset

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).	Values for these variables may be obtained programmatically using the pmGetConfig(3) function.

SEE ALSO

       PMAPI(3), pmGetConfig(3), pmLoadASCIINameSpace(3), pmTrimNameSpace(3), pcp.conf(5), pcp.env(5) and pmns(5).

DIAGNOSTICS

       Syntax and other errors in the parsing of the PMNS are reported on stderr with a message of the form ``Error Parsing ASCII PMNS: ...''.

       PM_ERR_DUPPMNS

	      It is an error to try and load more than one PMNS, or to call either pmLoadNameSpace and/or pmLoadASCIINameSpace(3) more than once.

       PM_ERR_PMNS

	      Syntax error in the PMNS file.

Performance Co-Pilot							PCP							PMLOADNAMESPACE(3)