pmlookupname(3) [centos man page]

PMLOOKUPNAME(3) 					     Library Functions Manual						   PMLOOKUPNAME(3)

NAME

       pmLookupName - translate performance metric names into PMIDs

C SYNOPSIS

       #include <pcp/pmapi.h>

       int pmLookupName(int numpmid, char **namelist, pmID *pmidlist);

       cc ... -lpcp

DESCRIPTION

       Given  a list in namelist containing numpmid full pathnames for performance metrics from a Performance Metrics Name Space (PMNS), pmLookup-
       Name returns the list of associated Performance Metric Identifiers (PMIDs) via pmidlist.

       The result from pmLookupName will be the number of names translated in the absence of errors, else an error  code  less	than  zero.   When
       errors are encountered, the corresponding value in pmidlist will be PM_ID_NULL.

       Note that the error protocol guarantees there is a 1:1 relationship between the elements of namelist and pmidlist, hence both lists contain
       exactly numpmid elements.  For this reason, the caller is expected to have pre-allocated a suitably sized array for pmidlist.

SEE ALSO

       PMAPI(3), pmGetChildren(3), pmGetChildrenStatus(3),  pmGetConfig(3),  pmLoadNameSpace(3),  pmNameID(3),	pmNewContext(3),  pcp.conf(5)  and
       pcp.env(5).

DIAGNOSTICS

       PM_ERR_TOOSMALL
	      numpmid must be at least 1

       PM_ERR_NOPMNS
	      Failed  to access a PMNS for operation.  Note that if the application hasn't a priori called pmLoadNameSpace(3) and wants to use the
	      distributed PMNS, then a call to pmLookupName must be made after the creation of a context (see pmNewContext(3)).

       PM_ERR_NAME
	      One or more of the elements of namelist does not correspond to a valid metric name in the PMNS.

       PM_ERR_NONLEAF
	      A name referred to a node in the PMNS but it was not a leaf node.

       PM_ERR_*
	      Other diagnostics are for protocol failures when accessing the distributed PMNS.

Performance Co-Pilot							PCP							   PMLOOKUPNAME(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)