pmlookupindomtext(3) [centos man page]
PMLOOKUPINDOMTEXT(3) Library Functions Manual PMLOOKUPINDOMTEXT(3) NAME
pmLookupInDomText - return text describing a performance metrics instance domain C SYNOPSIS
#include <pcp/pmapi.h> int pmLookupInDomText(pmInDom indom, int level, char **buffer); cc ... -lpcp DESCRIPTION
Provided the source of metrics from the current Performance Metrics Application Programming Interface (PMAPI) context is a host, retrieve descriptive text about the performance metrics instance domain identified by indom. 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 argument level should be PM_TEXT_ONELINE for a one-line summary, else PM_TEXT_HELP for a more verbose description, suited to a help dialog. The space pointed to by buffer will have been allocated in pmLookupInDomText with malloc(3C), and it is the responsibility of the caller to free(3C) the space when it is no longer required. pmLookupInDomText returns zero on success. SEE ALSO
chkhelp(1), newhelp(1), PMAPI(3), pmGetConfig(3), pmLookupDesc(3), pmLookupText(3), pcp.conf(5) and pcp.env(5). DIAGNOSTICS
PM_ERR_NOTHOST if the current PMAPI context is an archive log (help and one-line text is not maintained in the archive logs) Performance Co-Pilot PCP PMLOOKUPINDOMTEXT(3)
Check Out this Related Man Page
PMGETINDOMARCHIVE(3) Library Functions Manual PMGETINDOMARCHIVE(3) NAME
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)