Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pmdainstance(3) [centos man page]

PMDAINSTANCE(3) 					     Library Functions Manual						   PMDAINSTANCE(3)

pmdaInstance - return instance descriptions for a PMDA C SYNOPSIS
#include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> int pmdaInstance(pmInDom indom, int inst, char *name, __pmInResult **result, pmdaExt *pmda); cc ... -lpcp_pmda -lpcp DESCRIPTION
pmdaInstance uses the standard PMDA(3) data structures to return information concerning the instance domain indom. The result structure is constructed by pmdaInstance and will contain one or more instance names and/or identifiers as specified by the inst and name arguments. If inst has the value PM_IN_NULL and name is a null string, result will contain all the instances names and identifiers in the instance do- main. If inst is PM_IN_NULL but name is the name of an instance in the instance domain indom, then result will contain the instance identifier for instance name. Note that if name contains no spaces, partial matching up to the first space in the instance name is performed, i.e. ``1'' will match instance name ``1 minute''. If name contains an embedded space, then no partial matching is performed and name should match one of the instance names exactly. If name is a null string but inst is an instance identifier in the instance domain indom, then result will contain the name for instance inst. The result structure is allocated with malloc(3) and should be released by the caller with free(3). DIAGNOSTICS
If any errors occur during the execution of pmdaInstance, the result structure is deallocated. If the instance domain indom is not sup- ported by the PMDA, pmdaInstance will return PM_ERR_INDOM. If the inst or name does not correspond to any instances in the indom domain, pmdaInstance will return PM_ERR_INST. CAVEAT
The PMDA must be using PMDA_INTERFACE_2 or later, as specified in the call to pmdaDSO(3) or pmdaDaemon(3). Because of optional partial matching up to the first space in the instance name, the PMDA developer should ensure that if instance names are allowed to have spaces, the names are unique up to the first space. SEE ALSO
malloc(3), PMAPI(3), PMDA(3) and pmGetInDom(3). Performance Co-Pilot PCP PMDAINSTANCE(3)

Check Out this Related Man Page

PMGETINDOMARCHIVE(3)					     Library Functions Manual					      PMGETINDOMARCHIVE(3)

pmGetInDomArchive - get instance identifiers for a performance metrics instance domain C SYNOPSIS
#include <pcp/pmapi.h> int pmGetInDomArchive(pmInDom indom, int **instlist, char ***namelist); cc ... -lpcp DESCRIPTION
Provided the current Performance Metrics Application Programming Interface (PMAPI) context is associated with an archive log, pmGetInDo- mArchive will scan the union of all the instance domain metadata for the instance domain indom, and return via instlist the internal instance identifiers for all instances, and via namelist the full external identifiers for all instances. This routine is a specialized version of the more general PMAPI routine pmGetInDom. The number of instances found is returned as the function value (else less than zero to indicate an error). The value for the instance domain indom is typically extracted from a pmDesc structure, following a call to pmLookupDesc(3) for a particu- lar performance metric. The resulting lists of instance identifiers (instlist and namelist), and the names that the elements of namelist point to, will have been allocated by pmGetInDomArchive with two calls to malloc(3C), and it is the responsibility of the caller to free(instlist) and free(namelist) to release the space when it is no longer required. When the result of pmGetInDomArchive is less than one, both instlist and namelist are undefined (no space will have been allocated, and so calling free(3C) is a singularly bad idea). 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), pmGetInDom(3), pmLookupDesc(3), pmLookupInDomArchive(3), pmNameInDomArchive(3), pcp.conf(5) and pcp.env(5). DIAGNOSTICS
PM_ERR_NOTARCHIVE the current PMAPI context is not associated with an archive log PM_ERR_INDOM_LOG indom is not a defined instance domain identifier for the archive log Performance Co-Pilot PCP PMGETINDOMARCHIVE(3)
Man Page