pmlookupindomtext(3) [centos man page]

PMLOOKUPINDOMTEXT(3)					     Library Functions Manual					      PMLOOKUPINDOMTEXT(3)

NAME

       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.

       The value for the instance domain indom is typically extracted from a pmDesc structure, following a call to pmLookupDesc(3) for a  particu-
       lar performance metric.

       The  argument  level  should  be PM_TEXT_ONELINE for a one-line summary, else PM_TEXT_HELP for a more verbose description, suited to a help
       dialog.

       The space pointed to by buffer will have been allocated in pmLookupInDomText with malloc(3C), and it is the responsibility of the caller to
       free(3C) the space when it is no longer required.

       pmLookupInDomText returns zero on success.

SEE ALSO

       chkhelp(1), newhelp(1), PMAPI(3), pmGetConfig(3), pmLookupDesc(3), pmLookupText(3), pcp.conf(5) and pcp.env(5).

DIAGNOSTICS

       PM_ERR_NOTHOST
	      if the current PMAPI context is an archive log (help and one-line text is not maintained in the archive logs)

Performance Co-Pilot							PCP						      PMLOOKUPINDOMTEXT(3)

PMINDOMSTR(3)						     Library Functions Manual						     PMINDOMSTR(3)

NAME

       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 the same, but stores the result in a user-supplied buffer buf of length buflen, which should have  room  for	at
       least 20 bytes.

       The  value for the instance domain indom is typically extracted from a pmDesc structure, following a call to pmLookupDesc(3) for a particu-
       lar performance metric.

       Internally, an instance domain identifier is encoded as follows;

	    typedef struct {
		int		pad:2;
		unsigned int	domain:8;	 /* the administrative PMD */
		unsigned int	serial:22;	 /* unique within PMD */
	    } __pmInDom_int;

       pmInDomStr returns a string with each of the domain and serial subfields appearing as decimal numbers, separated by periods.

       The string value returned by pmInDomStr is held in a single static buffer, so the returned value is only valid until the next call to pmIn-
       DomStr.

NOTES

       pmInDomStr returns a pointer to a static buffer and hence is not thread-safe.  Multi-threaded applications should use pmInDomStr_r instead.

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	configura-
       tion file, as described in pcp.conf(5).	Values for these variables may be obtained programmatically using the pmGetConfig(3) function.

SEE ALSO

       PMAPI(3), pmGetConfig(3), pmIDStr(3), pmLookupDesc(3), pcp.conf(5) and pcp.env(5).

Performance Co-Pilot							PCP							     PMINDOMSTR(3)