Section 3: library functions
pmdaDesc – get the description of a metric from a PMDA C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> int pmdaDesc(pmID pmid, pmDesc *desc, pmdaExt *pmda); cc … -lpcp_pmda -lpcp Description pmdaDesc uses the standard PMDA(3) data structures to return the pmDesc description in desc for the metric identified by pmid. Diagnostics If the pmid…
pmdaDaemon – initialize the PMDA to run as a daemon C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> void pmdaDaemon(pmdaInterface *dispatch, int interface, char *name, int domain, char *logfile, char *helptext); cc … -lpcp_pmda -lpcp Description pmdaDaemon initializes the pmdaInterface structure to use the interface extensions assuming the PMDA(3) is to be run as a daemon. The pmdaInterface structure…
pmdaDSO – initialize the PMDA to run as a DSO C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> int pmdaDSO(pmdaInterface *dispatch, int interface, char *name, char *helptext); cc … -lpcp_pmda -lpcp Description pmdaDSO initializes the pmdaInterface structure to use the interface extensions, assuming the PMDA(3) is to be run as a DSO. The pmdaInterface structure is initialized…
pmdaConnect – establish a connection between a daemon PMDA and PMCD C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> void pmdaConnect(pmdaInterface *dispatch); cc … -lpcp_pmda -lpcp Description pmdaConnect initializes an IPC channel between a PMDA(3) and the pmcd(1) process on the local host. The type of the connection is dependent on the e_io field of…
pmdaOpenHelp, pmdaGetHelp, pmdaGetInDomHelp, pmdaCloseHelp – help text support for a PMDA C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> int pmdaOpenHelp(char *fname); char *pmdaGetHelp(int handle, pmID pmid, int type); char *pmdaGetInDomHelp(int handle, pmInDom indom, int type); void pmdaCloseHelp(int handle); cc … -lpcp_pmda -lpcp Description As part of the Performance Metrics Domain Agent (PMDA) API (see…
pmdaChildren – 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 pmdaChildren(char *name, int traverse, char ***offspring, int **status, pmdaExt *pmda); cc … -lpcp_pmda -lpcp Description As part of the Performance Metrics Domain Agent (PMDA) API (see PMDA(3)), pmdaChildren is the generic callback for returning dynamic metric…
pmdaCacheStore, pmdaCacheStoreKey, pmdaCacheLookup, pmdaCacheLookupName, pmdaCacheLookupKey, pmdaCacheOp, pmdaCachePurge, pmdaCacheResize – manage a cache of instance domain information for a PMDA C Synopsis #include <pcp/pmapi.h> #include <pcp/pmda.h> int pmdaCacheStore(pmInDom indom, int flags, const char *name, void *private); int pmdaCacheStoreKey(pmInDom indom, int flags, const char *name, int keylen, const void *key, void *private); int pmdaCacheLookup(pmInDom indom, int inst, char **name, void **private); int pmdaCacheLookupName(pmInDom indom,…
pmdaAttribute – informs a PMDA about client connection attributes C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/pmda.h> int pmdaAttribute(int context, int key, char *value, int length, pmdaExt *pmda); cc … -lpcp_pmda -lpcp Description As part of the Performance Metrics Domain Agent (PMDA) API (see PMDA(3)), pmdaAttribute is the generic callback for responding to client connection…
rpc – library routines for remote procedure calls Synopsis And Description These routines allow C programs to make procedure calls on other machines across the network. First, the client calls a procedure to send a data packet to the server. Upon receipt of the packet, the server calls a dispatch routine to perform the requested…
rpc – library routines for remote procedure calls Synopsis And Description These routines allow C programs to make procedure calls on other machines across the network. First, the client calls a procedure to send a data packet to the server. Upon receipt of the packet, the server calls a dispatch routine to perform the requested…
rpc – library routines for remote procedure calls Synopsis And Description These routines allow C programs to make procedure calls on other machines across the network. First, the client calls a procedure to send a data packet to the server. Upon receipt of the packet, the server calls a dispatch routine to perform the requested…
rpc – library routines for remote procedure calls Synopsis And Description These routines allow C programs to make procedure calls on other machines across the network. First, the client calls a procedure to send a data packet to the server. Upon receipt of the packet, the server calls a dispatch routine to perform the requested…
rpc – library routines for remote procedure calls Synopsis And Description These routines allow C programs to make procedure calls on other machines across the network. First, the client calls a procedure to send a data packet to the server. Upon receipt of the packet, the server calls a dispatch routine to perform the requested…
pmWhichZone – return current reporting timezone C Synopsis #include <pcp/pmapi.h> int pmWhichZone(char **tz); cc … -lpcp Description The current reporting timezone effects the timezone used by pmCtime(3) and pmLocaltime(3). pmWhichZone returns the handle of the current timezone, as previously established by a call to pmNewZone(3) or pmNewContextZone(3). If the call is successful (i.e. there exists…
pmWhichContext – identify the current PMAPI context C Synopsis #include <pcp/pmapi.h> int pmWhichContext(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 an archive log of performance metrics as created by…
pmUseZone – re-establish a reporting timezone C Synopsis #include <pcp/pmapi.h> int pmUseZone(const int tz_handle); cc … -lpcp Description The current reporting timezone effects the timezone used by pmCtime(3) and pmLocaltime(3). The argument tz_handle identifies a reporting timezone as previously established by a call to pmNewZone(3) or pmNewContextZone(3), and this becomes the current reporting timezone. See…
pmUseContext – change current PMAPI context C Synopsis #include <pcp/pmapi.h> int pmUseContext(int handle); 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 an archive log of performance metrics as created by…
pmUnpackEventRecords – unpack event records C Synopsis #include <pcp/pmapi.h> int pmUnpackEventRecords(pmValueSet *vsp, int idx, pmResult ***rap); int pmUnpackHighResEventRecords(pmValueSet *vsp, int idx, pmHighResResult ***hrap); cc … -lpcp Description Event records are encoded as a packed array of records within a pmResult using a container metric with a value of type PM_TYPE_EVENT , and a pmHighResResult when…
pmUnloadNameSpace – unload a local performance metrics name space for an application C Synopsis #include <pcp/pmapi.h> void pmUnloadNameSpace(void); cc … -lpcp Description If one has previously loaded a local Name Space using pmLoadNameSpace(3) or pmLoadASCIINameSpace(3), then calling pmUnloadNameSpace(3) will free up the memory associated with the Name Space and force all subsequent PMNS routine calls…
pmUnitsStr, pmUnitsStr_r – convert a performance metric’s units into a string C Synopsis #include <pcp/pmapi.h> const char *pmUnitsStr(const pmUnits *pu); char *pmUnitsStr_r(const pmUnits *pu, char *buf, int buflen); cc … -lpcp Description The encoding of a performance metric’s dimensionality and scale uses a pmUnits structure; see pmLookupDesc(3). As an aid to labeling graphs and tables,…