1PMIDSTR(3)                 Library Functions Manual                 PMIDSTR(3)
2
3
4

NAME

6       pmIDStr - convert a performance metric identifier into a string
7

C SYNOPSIS

9       #include <pcp/pmapi.h>
10
11       const char *pmIDStr(pmID pmid)
12
13       cc ... -lpcp
14

DESCRIPTION

16       For  use  in  error  and diagnostic messages, return a `human readable'
17       version of the specified Performance Metric Identifier (PMID).
18
19       Internally, a PMID is encoded as follows;
20
21            typedef struct {
22                int             pad:2;
23                unsigned int    domain:8;
24                unsigned int    cluster:12;
25                unsigned int    item:10;
26            } __pmID_int;
27
28       pmIDStr returns a string with each of the domain, cluster and item sub‐
29       fields appearing as decimal numbers, separated by periods.
30
31       The  string  value  is  held in a single static buffer, so the returned
32       value is only valid until the next call to pmIDStr.
33

PCP ENVIRONMENT

35       Environment variables with the prefix PCP_ are used to parameterize the
36       file  and  directory names used by PCP.  On each installation, the file
37       /etc/pcp.conf contains the  local  values  for  these  variables.   The
38       $PCP_CONF  variable may be used to specify an alternative configuration
39       file, as described in pcp.conf(4).  Values for these variables  may  be
40       obtained programatically using the pmGetConfig(3) function.
41

SEE ALSO

43       PMAPI(3),  pmGetConfig(3),  pmInDomStr(3), pmLookupDesc(3), pcp.conf(4)
44       and pcp.env(4).
45
46
47
48Performance Co-Pilot                  SGI                           PMIDSTR(3)
Impressum