PMIDSTR(3) Library Functions Manual PMIDSTR(3)
pmIDStr, pmIDStr_r - convert a performance metric identifier into a string
#include <pcp/pmapi.h> const char *pmIDStr(pmID pmid); char *pmIDStr_r(pmID pmid, char *buf, int buflen); cc ... -lpcp
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 same, but stores the result in a user-supplied buffer buf of length buflen, which should have room for at least 20 bytes. Internally, a PMID is encoded with three fields: domain, cluster and item. pmIDStr returns a string with each of the fields appearing as decimal numbers, separated by periods. The string value result from pmIDStr is held in a single static buffer, so the returned value is only valid until the next call to pmIDStr.
pmIDStr returns a pointer to a static buffer and hence is not thread-safe. Multi-threaded applications should use pmIDStr_r instead.
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 configuration file, as described in pcp.conf(5). Values for these variables may be obtained programmatically using the pmGetConfig(3) function.
PMAPI(3), pmGetConfig(3), pmInDomStr(3), pmTypeStr(3), pmSemStr(3), pmUnitsStr(3), pmLookupDesc(3), pcp.conf(5) and pcp.env(5).
This page is part of the PCP (Performance Co-Pilot) project. Information about the project can be found at ⟨http://www.pcp.io/⟩. If you have a bug report for this manual page, send it to firstname.lastname@example.org. This page was obtained from the project's upstream Git repository ⟨https://github.com/performancecopilot/pcp.git⟩ on 2023-06-23. (At that time, the date of the most recent commit that was found in the repository was 2023-06-21.) If you discover any rendering problems in this HTML version of the page, or you believe there is a better or more up-to-date source for the page, or you have corrections or improvements to the information in this COLOPHON (which is not part of the original manual page), send a mail to email@example.com Performance Co-Pilot PCP PMIDSTR(3)
Pages that refer to this page: pmid_helper(3), pmindomstr(3), pmsemstr(3), pmtypestr(3), pmunitsstr(3), pmwebapi(3)