Section 3: library functions
pmiAddMetric – add a new metric definition to a LOGIMPORT context C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/import.h> int pmiAddMetric(const char *name, pmID pmid, int type, pmInDom indom, int sem, pmUnits units); cc … -lpcp_import -lpcp Perl SYNOPSIS use PCP::LogImport; pmiAddMetric($name, $pmid, $type, $indom, $sem, $units); Description As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)),…
pmiAddInstance – add an element to an instance domain in a LOGIMPORT context C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/import.h> int pmiAddInstance(pmInDom indom, const char *instance, int inst); cc … -lpcp_import -lpcp Perl SYNOPSIS use PCP::LogImport; pmiAddInstance($indom, $instance, $inst); Description As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiAddInstance adds a…
pmprintf, pmflush – print formatted output in a window or to standard error C Synopsis #include <pcp/pmapi.h> int pmprintf(const char *fmt, … /*args*/); int pmflush(void); cc … -lpcp Description The combination of pmprintf and pmflush produces output in either an xconfirm(1) window, on the standard error stream, or to a file in a manner similar…
pmtracebegin, pmtraceend, pmtraceabort, pmtracepoint, pmtraceobs, pmtracecounter, pmtracestate, pmtraceerrstr – application-level performance instrumentation services C Synopsis #include <pcp/trace.h> int pmtracebegin(const char *tag); int pmtraceend(const char *tag); int pmtraceabort(const char *tag); int pmtracepoint(const char *tag); int pmtraceobs(const char *tag, double value); int pmtracecounter(const char *tag, double value); char *pmtraceerrstr(int code); int pmtracestate(int flags); cc … -lpcp_trace Fortran…
pmdaText – extract metric help text for a PMDA C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> int pmdaText(int ident, int type, char **buffer, pmdaExt *pmda); cc … -lpcp_pmda -lpcp Description As part of the Performance Metrics Domain Agent (PMDA) API (see PMDA(3)), pmdaText uses the standard PMDA(3) data structures to return the help text…
pmdaStore – store a value into a metric for a PMDA C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> int pmdaStore(pmResult *result, pmdaExt *pmda); cc … -lpcp_pmda -lpcp Description As part of the Performance Metrics Domain Agent (PMDA) API (see PMDA(3)), pmdaStore is the generic callback for storing a value into a metric. pmdaStore is…
pmdaRootConnect, pmdaRootShutdown, pmdaRootContainerHostName, pmdaRootContainerProcessID, pmdaRootContainerCGroupName, pmdaRootProcessStart, pmdaRootProcessWait, pmdaRootProcessTerminate – privileged PCP collector services C Synopsis #include <pcp/pmapi.h> #include <pcp/pmda.h> int pmdaRootConnect(void); void pmdaRootShutdown(int fd); int pmdaRootContainerHostName(int fd, char *name, int namelen, char *buffer, int buflen); int pmdaRootContainerProcessID(int fd, char *name, int namelen); int pmdaRootContainerCGroupName(int fd, char *name, int namelen, char *buffer, int buflen); int pmdaRootProcessStart(int…
pmdaProfile – update instance profile for PMDA in preparation for the next fetch from PMCD C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> int pmdaProfile(__pmProfile *prof, pmdaExt *pmda); cc … -lpcp_pmda -lpcp Description As part of the Performance Metrics Domain Agent (PMDA) API (see PMDA(3)), pmdaProfile is the default callback which handles the receipt of…
pmdaPMID – translate a dynamic performance metric name into a PMID C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> int pmdaPMID(char *name, pmID *pmid, pmdaExt *pmda); cc … -lpcp_pmda -lpcp Description As part of the Performance Metrics Domain Agent (PMDA) API (see PMDA(3)), pmdaPMID is the generic callback for translating a dynamic metric name into…
pmdaOpenLog – redirect stderr to a logfile C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> void pmdaOpenLog(pmdaInterface * dispatch); cc … -lpcp_pmda -lpcp Description pmdaOpenLog redirects stderr to the logfile specified in the dispatch structure, set by the previous call to pmdaDaemon(3) or pmdaGetOpt(3). The first line of the log file will detail the name…
pmdaName – translate a PMID to a set of dynamic performance metric names C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> int pmdaName(pmID pmid, char ***nameset, pmdaExt *pmda); cc … -lpcp_pmda -lpcp Description As part of the Performance Metrics Domain Agent (PMDA) API (see PMDA(3)), pmdaName is the generic callback for translating a pmid into…
pmdaInterfaceMoved – reset internal state of a pmdaInterface structure C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> void pmdaInterfaceMoved(pmdaInterface *dispatch) cc … -lpcp_pmda -lpcp Description After a call to either pmdaDaemon(3) or pmdaDSO(3) to initialize the pmdaInterface structure, if the caller needs to relocate or move the structure for any reason then pmdaInterfaceMoved needs to…
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…
pmdaInit, pmdaRehash, pmdaSetFlags – initialize a PMDA C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> void pmdaInit(pmdaInterface *dispatch, pmdaIndom *indoms, int nindoms, pmdaMetric *metrics, int nmetrics); void pmdaRehash(pmdaExt *pmda, pmdaMetric *metrics, int nmetrics); void pmdaSetFlags(pmdaInterface *dispatch, int flags); cc … -lpcp_pmda -lpcp Description pmdaInit initializes a PMDA so that it is ready to receive PDUs from pmcd(1). The function expects…
pmdaGetOpt, pmdaGetOptions – get options from arguments, parsing generic PMDA options C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> int pmdaGetOptions(int argc, char *const *argv, pmdaOptions *opts, pmdaInterface *dispatch); int pmdaGetOpt(int argc, char *const *argv, const char *optstring, pmdaInterface *dispatch, int *err); cc … -lpcp_pmda -lpcp Description These functions are wrappers for pmgetopt_r(3). The behavior of each function is…
pmdaMain, pmdaGetContext, pmdaSetResultCallBack, pmdaSetCheckCallBack, pmdaSetDoneCallBack, pmdaSetEndContextCallBack – generic PDU processing for a PMDA C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> cc … -lpcp_pmda -lpcp void pmdaMain(pmdaInterface *dispatch); void pmdaSetCheckCallBack(pmdaInterface *dispatch, pmdaCheckCallBack callback); void pmdaSetDoneCallBack(pmdaInterface *dispatch, pmdaDoneCallBack callback); void pmdaSetResultCallBack(pmdaInterface *dispatch, pmdaResultCallBack callback); void pmdaSetEndContextCallBack(pmdaInterface *dispatch, pmdaEndContextCallBack callback); int pmdaGetContext(void); Description For Performance Metric Domain Agents (PMDA(3)) using the…
pmdaFetch, pmdaSetFetchCallBack – fill a pmResult structure with the requested metric values C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> int pmdaFetch(int numpmid, pmID *pmidlist, pmResult **resp, pmdaExt *pmda); void pmdaSetFetchCallBack(pmdaInterface *dispatch, pmdaFetchCallBack callback); cc … -lpcp_pmda -lpcp Description pmdaFetch is a generic callback used by a PMDA(3) to process a fetch request from pmcd(1). The request…
pmdaEventNewQueue, pmdaEventNewActiveQueue, pmdaEventQueueHandle, pmdaEventQueueAppend, pmdaEventQueueShutdown, pmdaEventQueueRecords, pmdaEventQueueClients, pmdaEventQueueCounter, pmdaEventQueueBytes, pmdaEventQueueMemory – utilities for PMDAs managing event queues C Synopsis #include <pcp/pmapi.h> #include <pcp/pmda.h> int pmdaEventNewQueue(const char *name, size_t maxmem); int pmdaEventNewActiveQueue(const char *name, size_t maxmem, int nclients); int pmdaEventQueueHandle(const char *name); int pmdaEventQueueAppend(int handle, void *buffer, size_t bytes, struct timeval *tv); int pmdaEventQueueShutdown(int handle); typedef…
pmdaEventNewClient, pmdaEventEndClient, pmdaEventClients – client context tracking interfaces for event queues C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> int pmdaEventNewClient(int context); int pmdaEventEndClient(int context); int pmdaEventClients(pmAtomValue *avp); cc … -lpcp_pmda -lpcp Description A Performance Metrics Domain Agent (PMDA) that exports event records needs to track which clients are connected to it, in order that…
pmdaEventNewArray, pmdaEventResetArray, pmdaEventReleaseArray, pmdaEventAddRecord, pmdaEventAddMissedRecord, pmdaEventAddParam, pmdaEventGetAddr, pmdaEventNewHighResArray, pmdaEventResetHighResArray, pmdaEventReleaseHighResArray, pmdaEventAddHighResRecord, pmdaEventAddHighResMissedRecord, pmdaEventHighResAddParam, pmdaEventHighResGetAddr – utilities for PMDAs to build packed arrays of event records C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> int pmdaEventNewArray(void); int pmdaEventResetArray(int idx); int pmdaEventReleaseArray(int idx); int pmdaEventAddRecord(int idx, struct timeval *tp, int flags); int pmdaEventAddMissedRecord(int idx, struct timeval *tp, int nmissed);…