pmindomstr(3) [centos man page]

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)

PMDELPROFILE(3) 					     Library Functions Manual						   PMDELPROFILE(3)

NAME

       pmDelProfile - delete instance(s) from the current PMAPI instance profile

C SYNOPSIS

       #include <pcp/pmapi.h>

       int pmDelProfile(pmInDom indom, int numinst, int *instlist);

       cc ... -lpcp

DESCRIPTION

       The  set  of  instances	for  performance  metrics returned from a pmFetch(3) call may be filtered or restricted using an instance profile.
       There is one instance profile for each context the application  creates	at  the  Performance  Metrics  Application  Programming  Interface
       (PMAPI), and each instance profile may include instances from one or more instance domains (see pmLookupDesc(3)).

       pmDelProfile may be used to delete instance specifications from the instance profile of the current PMAPI context.

       In  the	simplest  variant,  the  list  of instances identified by the instlist argument for the indom instance domain are removed from the
       instance profile.  The list of instance identifiers contains numinst values.

       The indom value would normally be extracted from a call to pmLookupDesc(3) for a  particular  performance  metric,  and	the  instances	in
       instlist would typically be determined by calls to pmGetInDom(3) or pmLookupInDom(3).

       If  indom  equals  PM_INDOM_NULL  or  numinst  is zero, then all instance domains are selected for deletion.  If instlist is NULL, then all
       instances in the selected domain(s) are removed from the profile.

       To disable all available instances in all domains, use pmDelProfile(PM_INDOM_NULL, 0, NULL).  This is the only situation in which indom may
       be PM_INDOM_NULL.

SEE ALSO

       pmAddProfile(3),  PMAPI(3),  pmFetch(3), pmGetInDom(3), pmLookupDesc(3), pmLookupInDom(3), pmNewContext(3), pmUseContext(3) and pmWhichCon-
       text(3).

DIAGNOSTICS

       PM_ERR_PROFILESPEC
	      indom was PM_INDOM_NULL and instlist was not empty

CAVEAT

       It is possible to delete non-existent instance domains and non-existent instances from an instance profile.  None of the routines that  use
       the instance profile will ever issue an error if you do this.  The cost of checking, when checking is possible, outweighs any benefits.

Performance Co-Pilot							PCP							   PMDELPROFILE(3)