Man Linux: Main Page and Category List

NAME

       pmIDStr - convert a performance metric identifier into a string

C SYNOPSIS

       #include <pcp/pmapi.h>

       const char *pmIDStr(pmID pmid)

       cc ... -lpcp

DESCRIPTION

       For  use  in  error  and diagnostic messages, return a ‘human readable’
       version of the specified Performance Metric Identifier (PMID).

       Internally, a PMID is encoded as follows;

            typedef struct {
                int             pad:2;
                unsigned int    domain:8;
                unsigned int    cluster:12;
                unsigned int    item:10;
            } __pmID_int;

       pmIDStr returns a string with each of  the  domain,  cluster  and  item
       subfields appearing as decimal numbers, separated by periods.

       The  string  value  is  held in a single static buffer, so the returned
       value is only valid until the next call to pmIDStr.

PCP ENVIRONMENT

       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(4).  Values for these variables  may  be
       obtained programatically using the pmGetConfig(3) function.

SEE ALSO

       PMAPI(3),  pmGetConfig(3),  pmInDomStr(3), pmLookupDesc(3), pcp.conf(4)
       and pcp.env(4).