pmgetindomarchive(3) [centos 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)
Check Out this Related Man Page
PMGETARCHIVELABEL(3) Library Functions Manual PMGETARCHIVELABEL(3) NAME
pmGetArchiveLabel - fetch the label record from a performance metrics archive log C SYNOPSIS
#include <pcp/pmapi.h> int pmGetArchiveLabel(pmLogLabel *lp); cc ... -lpcp DESCRIPTION
Within the framework of the Performance Co-Pilot (PCP), archive logs of performance metrics values may be accumulated and saved using the program pmlogger(1). The routine pmGetArchiveLabel may be used to fetch the label record from an archive log that has already been opened using pmNewContext(3), or pmDupContext(3), and thereby associated with the current Performance Metrics Application Programming Interface (PMAPI) context. The result returned via the pointer lp is a structure that must be pre-allocated by the caller and has the following format (defined in pmapi.h). /* * Label Record at the start of every log file */ typedef struct { int ll_magic; /* PM_LOG_MAGIC | log format version no. */ pid_t ll_pid; /* PID of logger */ struct timeval ll_start;/* start of this log */ char ll_hostname[PM_LOG_MAXHOSTLEN]; /* name of collection host */ char ll_tz[40]; /* $TZ at collection host */ } pmLogLabel; For an application, the most useful information from the archive label is likely to be in the fields ll_start, ll_hostname or ll_tz. Note that the size of the ll_hostname field is PM_LOG_MAXHOSTLEN (64 bytes) which is less than MAXHOSTNAMELEN (see gethostbyname(3)) on some platforms. These semantics are necessary to retain backwards compatibility with the PCP archive file format. pmGetArchiveLabel returns zero for success. 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
pmlogger(1), PMAPI(3), pmDupContext(3), pmGetConfig(3), pmNewContext(3), pcp.conf(5) and pcp.env(5). DIAGNOSTICS
PM_ERR_NOCONTEXT the current PMAPI context is either invalid, or not associated with an archive log Performance Co-Pilot PCP PMGETARCHIVELABEL(3)