NAME
pmLoadASCIINameSpace - establish a local PMNS for an application
C SYNOPSIS
#include <pcp/pmapi.h>
int pmLoadASCIINameSpace(const char *filename, int dupok)
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 pmLoadASCIINameSpace or pmLoadNameSpace(3). If the
application wants to use a distributed PMNS, then it should NOT make a
call to load the PMNS explicitly.
pmLoadASCIINameSpace is a variant of pmLoadNameSpace(3) which will only
process an ASCII format PMNS, and the dupok argument may be used to
control the handling of multiple names in the PMNS that may be
associated with a single Performance Metric Identifier (PMID). A value
of 0 disallows duplicates, any other value allows duplicates.
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; although since the default local PMNS will exist in a
binary format, pmLoadNameSpace(3) would be the more efficient routine
to use.
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.
pmLoadASCIINameSpace 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 configuration
file, as described in pcp.conf(4). Values for these variables may be
obtained programatically using the pmGetConfig(3) function.
SEE ALSO
pmnscomp(1), PMAPI(3), pmGetConfig(3), pmLoadNameSpace(3),
pmTrimNameSpace(3), pcp.conf(4), pcp.env(4) and pmns(4).
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 to load more than one PMNS, or to call
either pmLoadASCIINameSpace and/or pmLoadNameSpace(3) more than
once.
PM_ERR_PMNS
Syntax error in an ASCII format PMNS.