pmGetVersion – fetch installed PCP version number C Synopsis #include <pcp/pmapi.h> int pmGetVersion(void); cc … -lpcp Description pmGetVersion returns a binary encoding of the locally installed PCP version number. This may be used in conjunction with the related macros PM_VERSION(a,b,c) and PM_VERSION_CURRENT that generate PCP version numbers in the same format. Refer to the example…
pmGetPMNSLocation – determine the location of the currently used PMNS C Synopsis #include <pcp/pmapi.h> int pmGetPMNSLocation(void); cc … -lpcp Description If an application needs to know where the Performance Metrics Name Space (PMNS) is coming from then pmGetPMNSLocation will return whether it is from an archive, PMNS_ARCHIVE, or from a local PMNS file, PMNS_LOCAL, or…
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 a set of archive logs, pmGetInDomArchive will scan the union of all the instance domain metadata…
pmGetInDom – get instance identifiers for a performance metrics instance domain C Synopsis #include <pcp/pmapi.h> int pmGetInDom(pmInDom indom, int **instlist, char ***namelist); cc … -lpcp Description In the current Performance Metrics Application Programming Interface (PMAPI) context, locate the description of the instance domain indom, and return via instlist the internal instance identifiers for all instances,…
pmGetContextHostName, pmGetContextHostName_r – return the hostname associated with a Performance Co-Pilot context C Synopsis #include <pcp/pmapi.h> const char *pmGetContextHostName(int id); char *pmGetContextHostName_r(int id, char *buf, int buflen); cc … -lpcp Description Given a valid PCP context identifier previously created with pmNewContext(3) or pmDupContext(3), the pmGetContextHostName function returns the hostname associated with id. The pmGetContextHostName_r function…
pmGetConfig, pmGetOptionalConfig – return values for Performance Co-Pilot configuration variables C Synopsis #include <pcp/pmapi.h> char *pmGetConfig(const char *variable); char *pmGetOptionalConfig(const char *variable); #include <pcp/impl.h> char *__pmGetAPIConfig(const char *feature); cc … -lpcp Description The pmGetConfig and pmGetOptionalConfig functions search for variable first in the environment and then, if not found, in the Performance Co-Pilot (PCP) configuration…
pmGetChildrenStatus – return the descendent nodes of a PMNS node and their respective status C Synopsis #include <pcp/pmapi.h> int pmGetChildrenStatus(const char *name, char ***offspring, int **status); cc … -lpcp Description Given a fully qualified pathname to a node in the current Performance Metrics Name Space (PMNS), as identified by name, pmGetChildrenStatus returns via offspring a list…
pmGetChildren – return the descendent nodes of a PMNS node C Synopsis #include <pcp/pmapi.h> int pmGetChildren(const char *name, char ***offspring); cc … -lpcp Description Given a fully qualified pathname to a node in the current Performance Metrics Name Space (PMNS), as identified by name, pmGetChildren returns via offspring a list of the relative names of…
pmGetArchiveLabel – fetch the label record from a set of performance metrics archive logs 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…
pmGetArchiveEnd – locate logical end of file for a set of archive logs C Synopsis #include <pcp/pmapi.h> int pmGetArchiveEnd(struct timeval *tvp); cc … -lpcp Description Assuming the current PMAPI context is associated with a set of archive logs, pmGetArchiveEnd will attempt to find the logical end of file (after the last complete record in the…
pmFreeResult – release storage allocated for performance metrics values C Synopsis #include <pcp/pmapi.h> void pmFreeResult(pmResult *result); cc … -lpcp Description The variable sized results returned by pmFetch(3) are allocated below the Performance Metrics Application Programming Interface (PMAPI) using a combination of dynamic (i.e. malloc(3)) and specialized allocation strategies. Applications should call pmFreeResult to release the…
pmgetopt_r, pmGetOptions, pmGetContextOptions, pmFreeOptions, pmUsageMessage – command line handling for PMAPI tools C Synopsis #include <pcp/pmapi.h> int pmgetopt_r(int argc, char *const *argv, pmOptions *opts); int pmGetOptions(int argc, char *const *argv, pmOptions *opts); int pmGetContextOptions(int ctx, pmOptions *opts); void pmUsageMessage(pmOptions *opts); void pmFreeOptions(pmOptions *opts); cc … -lpcp Description The pmGetOptions function provides command line option processing…
pmParseMetricSpec, pmFreeMetricSpec – uniform metric specification parser C Synopsis #include <pcp/pmapi.h> int pmParseMetricSpec(const char *string, int isarch, char *source, pmMetricSpec **rsltp, char **errmsg); void pmFreeMetricSpec(pmMetricSpec *rslt); cc … -lpcp Description pmParseMetricSpec accepts a string specifying the name of a PCP performance metric, and optionally the source (either a hostname or a PCP archive log filename) and instances for…
pmFreeEventResult, pmFreeHighResEventResult – release storage allocated for unpacked event records C Synopsis #include <pcp/pmapi.h> void pmFreeEventResult(pmResult **rset); void pmFreeHighResEventResult(pmHighResResult **hrset); cc … -lpcp Description When processing event records, if pmUnpackEventRecords(3) is used to unpack event records from a metric within a pmResult structure with a value of type PM_TYPE_EVENT then the structure returned from pmUnpackEventRecords(3)…
pmFetchArchive – get performance metrics directly from a set if archive logs C Synopsis #include <pcp/pmapi.h> int pmFetchArchive(pmResult **result); cc … -lpcp Description pmFetchArchive is a variant of pmFetch(3) that may only be used when the current Performance Metrics Application Programming Interface (PMAPI) context is associated with a set of archive logs. The result is…
pmFetch – get performance metric values C Synopsis #include <pcp/pmapi.h> int pmFetch(int numpmid, pmID *pmidlist, pmResult **result); cc … -lpcp Description Given a list of Performance Metric Identifiers (PMID)s, e.g. as constructed by pmLookupName(3), via pmidlist and numpmid, fetch the values for these performance metrics. The call to pmFetch is executed in the context of…
pmExtractValue – extract a performance metric value from a pmResult structure C Synopsis #include <pcp/pmapi.h> int pmExtractValue(int valfmt, const pmValue *ival, int itype, pmAtomValue *oval, int otype); cc … -lpcp Description The pmValue structure is embedded within the pmResult structure that is used to return one or more performance metrics; see pmFetch(3). All performance metric values may be…
pmEventFlagsStr, pmEventFlagsStr_r – convert an event record flags value into a string C Synopsis #include <pcp/pmapi.h> const char *pmEventFlagsStr(int flags); char *pmEventFlagsStr_r(int flags, char *buf, int buflen); cc … -lpcp Description For use in error and diagnostic messages, pmEventFlagsStr returns a `human readable’ version of the value flags, assuming this to be the er_flags field…
pmErrStr, pmErrStr_r – convert a PMAPI error code into a string C Synopsis #include <pcp/pmapi.h> const char *pmErrStr(int code); char *pmErrStr_r(int code, char *buf, int buflen); cc … -lpcp Description Translate an error code into a text string, suitable for generating a diagnostic message. The pmErrStr_r function does the same, but stores the result in…
pmDupContext – duplicate a PMAPI context C Synopsis #include <pcp/pmapi.h> int pmDupContext(void); cc … -lpcp Description An application using the Performance Metrics Application Programming Interface (PMAPI) may manipulate several concurrent contexts, each associated with a source of performance metrics, e.g. pmcd(1) on some host, or a set of archive logs of performance metrics as created…