pmaddprofile(3) [centos man page]

PMADDPROFILE(3) 					     Library Functions Manual						   PMADDPROFILE(3)

NAME

       pmAddProfile - add instance(s) to the current PMAPI instance profile

C SYNOPSIS

       #include <pcp/pmapi.h>

       int pmAddProfile(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(3)), and each instance profile may include instances from one or more instance domains (see pmLookupDesc(3)).

       pmAddProfile may be used to add new instance specifications to 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 added to 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).

       To select all instances in all instance domains, use

	  pmAddProfile(PM_INDOM_NULL, 0, (int *)0)

       This  is the only case where indom may be equal to PM_INDOM_NULL.  If numinst is zero, or instlist is NULL, then all instances in indom are
       selected.

SEE ALSO

       PMAPI(3), pmDelProfile(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 add non-existent instance domains and non-existent instances to 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							   PMADDPROFILE(3)

PMIADDMETRIC(3) 					     Library Functions Manual						   PMIADDMETRIC(3)

NAME

       pmiAddMetric - add a new metric definition to a LOGIMPORT context

C SYNOPSIS

       #include <pcp/pmapi.h>
       #include <pcp/impl.h>
       #include <pcp/import.h>

       int pmiAddMetric(const char *name, pmID pmid, int type, pmInDom indom, int sem, pmUnits units);

       cc ... -lpcp_import -lpcp

Perl SYNOPSIS
       use PCP::LogImport;

       pmiAddMetric($name, $pmid, $type, $indom, $sem, $units);

DESCRIPTION

       As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiAddMetric is used to define a new metric.  The metric's name must
       follow the naming conventions described in PCPIntro(1) and should be unique for each LOGIMPORT context.

       The other arguments are in effect the fields of a pmDesc structure.  Refer to pmLookupDesc(3) for a complete description of the values  and
       semantics of the components of this structure, and hence the valid argument values for pmiAddMetrics.

       The  internal  identifier for the metric may be given using the pmid argument and must be unique for each LOGIMPORT context.  The value for
       pmid which would typically be constructed using the pmid_build macro, e.g. pmid_build(PMI_DOMAIN, 0, 3) for  the  fourth  metric  in  first
       ``cluster''  of	metrics  in the Performance Metrics Domain PMI_DOMAIN (which is the default for all meta data created by the LOGIMPORT li-
       brary).	Alternatively, pmid may be PM_IN_NULL and pmiAddMetric will assign a unique pmid (although this means the pmid remains opaque  and
       the application must use pmiPutValue(3) or pmiPutValueHandle(3) and cannot use pmiPutResult(3) to add data values to the PCP archive).

       type defines the data type of the metric and must be one of the PM_TYPE_...  values defined in <pcp/import.h>.

       The  instance domain for the metric is defined by indom and may be PM_INDOM_NULL for a metric with a singular value, else the value for in-
       dom would normally be constructed using the pmInDom_build macro, e.g. pmInDom_build(LOGIMPORT,0) for the first instance domain in the  Per-
       formance  Metrics  Domain  LOGIMPORT (which is the default for all meta data created by the LOGIMPORT library).	Multiple metrics can share
       the same instance domain if they have values for a similar (or more usually, identical) set of instances.

       The semantics of the metric (counter, instantaneous value, etc.) is specified by the sem argument which would normally be the result  of  a
       call to the convenience constructor method pmiUnits(3).

DIAGNOSTICS

       pmiAddMetric returns zero on success else a negative value that can be turned into an error message by calling pmiErrStr(3).

SEE ALSO

       PCPIntro(1), LOGIMPORT(3), pmiErrStr(3), pmiPutResult(3), pmiPutValue(3), pmiPutValueHandle(3), pmiUnits(3) and pmLookupDesc(3).

Performance Co-Pilot														   PMIADDMETRIC(3)