The Linux Manuals (man pages) document is an important part of Linux documents. Linux Manuals are organized as several sections. Each section has a group of commands for a specific area in Linux usage, administration or development.
pmNewZone – establish a reporting timezone C Synopsis #include <pcp/pmapi.h> int pmNewZone(const char *tz); cc … -lpcp Description The current reporting timezone affects the timezone used by pmCtime(3) and pmLocaltime(3). The argument tz defines a timezone string, in the format described for the TZ environment variable, see environ(7). pmNewZone sets the current reporting timezone, and…
pmNewContextZone – establish a reporting timezone based on a PMAPI context C Synopsis #include <pcp/pmapi.h> int pmNewContextZone(void); cc … -lpcp Description The current reporting timezone affects the timezone used by pmCtime(3) and pmLocaltime(3). If the current PMAPI context is an archive, pmNewContextZone uses the timezone from the archive label record to set the current reporting…
pmNewContext – establish a new PMAPI context C Synopsis #include <pcp/pmapi.h> int pmNewContext(int type, const char *name); 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…
pmNameInDomArchive – translate an instance identifier into an instance name C Synopsis #include <pcp/pmapi.h> int pmNameInDomArchive(pmInDom indom, int inst, char **name); cc … -lpcp Description Provided that the current Performance Metrics Application Programming Interface (PMAPI) context is associated with a set of archive logs, pmNameInDomArchive will scan the union of all the instance domain metadata…
pmNameInDom – translate an instance identifier into an instance name C Synopsis #include <pcp/pmapi.h> int pmNameInDom(pmInDom indom, int inst, char **name); cc … -lpcp Description For the instance domain indom, in the current Performance Metrics Application Programming Interface (PMAPI) context, locate the instance with the internal instance identifier given by inst, and return the full…
pmNameID – translate a PMID to a performance metric name C Synopsis #include <pcp/pmapi.h> int pmNameID(pmID pmid, char **name); cc … -lpcp Description Given a Performance Metric Identifier (PMID) via pmid, pmNameID will determine the corresponding metric name, if any, in the Performance Metrics Name Space (PMNS), and return this via name. If the PMNS…
pmNameAll – translate a PMID to a set of performance metric names C Synopsis #include <pcp/pmapi.h> int pmNameAll(pmID pmid, char ***nameset); cc … -lpcp Description Given a Performance Metric Identifier (PMID) via pmid, pmNameAll will determine all the corresponding metric names, if any, in the Performance Metrics Name Space (PMNS), and return these via nameset….
pmLookupText – return text describing a performance metric C Synopsis #include <pcp/pmapi.h> int pmLookupText(pmID pmid, 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 metric identified by pmid. The argument level should…
pmLookupName – translate performance metric names into PMIDs C Synopsis #include <pcp/pmapi.h> int pmLookupName(int numpmid, char **namelist, pmID *pmidlist); cc … -lpcp Description Given a list in namelist containing numpmid full pathnames for performance metrics from a Performance Metrics Name Space (PMNS), pmLookupName returns the list of associated Performance Metric Identifiers (PMIDs) via pmidlist. The…
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….
pmLookupInDomArchive – translate an instance name into an instance identifier C Synopsis #include <pcp/pmapi.h> int pmLookupInDomArchive(pmInDom indom, const char *name); cc … -lpcp Description Provided the current Performance Metrics Application Programming Interface (PMAPI) context is associated with a set of archive logs, pmLookupInDomArchive will scan the union of all the instance domain metadata for the…
pmLookupInDom – translate an instance name into an instance identifier C Synopsis #include <pcp/pmapi.h> int pmLookupInDom(pmInDom indom, const char *name); cc … -lpcp Description For the instance domain indom, in the current Performance Metrics Application Programming Interface (PMAPI) context, locate the instance with the external identification given by name, and return the internal instance identifier….
pmLookupDesc – obtain a description for a performance metric C Synopsis #include <pcp/pmapi.h> int pmLookupDesc(pmID pmid, pmDesc *desc); cc … -lpcp Description Given a Performance Metrics Identifier (PMID) as pmid, fill in the given pmDesc structure, pointed to by the parameter desc, from the current Performance Metrics Application Programming Interface (PMAPI) context. The pmDesc structure…
pmLocaltime – convert the date and time for a reporting timezone C Synopsis #include <time.h> #include <pcp/pmapi.h> struct tm *pmLocaltime(const time_t *clock, struct tm *result); cc … -lpcp Description pmLocaltime is very similar to localtime(3), except the timezone used is the current “reporting timezone” (rather than the default TZ environment variable scheme), and the result…
pmLoadNameSpace – load a local PMNS for an application C Synopsis #include <pcp/pmapi.h> int pmLoadNameSpace(const char *filename); cc … -lpcp Description If the application wants to force using a local Performance Metrics Name Space (PMNS) instead of a distributed PMNS then it must load the PMNS using pmLoadNameSpace or pmLoadASCIINameSpace(3). If the application is to…
pmLoadDerivedConfig – load derived metric definitions from files C Synopsis #include <pcp/pmapi.h> int pmLoadDerivedConfig(char *path); cc … -lpcp Description Derived metrics may be used to extend the available metrics with new (derived) metrics using simple arithmetic expressions. The definitions of these metrics can be persisted and loaded programatically by monitor tools using pmLoadDerivedConfig. The path…
pmLoadASCIINameSpace – establish a local PMNS for an application C Synopsis #include <pcp/pmapi.h> int pmLoadASCIINameSpace(const char *filename, int dupok); cc … -lpcp Description If the application wants to force using a local Performance Metrics Name Space (PMNS) instead of a distributed PMNS then it must load the PMNS using pmLoadASCIINameSpace or pmLoadNameSpace(3). If the application…
pmInDomStr, pmInDomStr_r – convert a performance metric instance domain identifier into a string C Synopsis #include <pcp/pmapi.h> const char *pmInDomStr(pmInDom indom); char *pmInDomStr_r(pmInDom indom, char *buf, int buflen); cc … -lpcp Description For use in error and diagnostic messages, pmInDomStr return a ‘human readable’ version of the specified instance domain identifier. The pmInDomStr_r function does…
pmIDStr, pmIDStr_r – convert a performance metric identifier into a string C Synopsis #include <pcp/pmapi.h> const char *pmIDStr(pmID pmid); char *pmIDStr_r(pmID pmid, char *buf, int buflen); cc … -lpcp Description For use in error and diagnostic messages, pmIDStr returns a `human readable’ version of the specified Performance Metric Identifier (PMID). The pmIDStr_r function does the…
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…