pmigethandle(3) [centos man page]

PMIGETHANDLE3() 														   PMIGETHANDLE3()

NAME

       pmiGetHandle - define a handle for a metric-instance pair

C SYNOPSIS

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

       int pmiGetHandle(const char *name, const char *instance);

       cc ... -lpcp_import -lpcp

Perl SYNOPSIS
       use PCP::LogImport;

       $handle = pmiGetHandle($name, $instance);

DESCRIPTION

       As  part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiGetHandle creates a handle for a given metric and instance.  The
       handle is returned as the value from the pmiGetHandle call and can be used in subsequent calls to pmiPutValueHandle(3).

       The metric's name should match one defined earlier in a call to pmiAddMetric(3).

       For singular metrics (those defined with an instance domain of PM_INDOM_NULL), the instance should be NULL or an  empty	string,  otherwise
       instance should match the name of an instance defined earlier in a call to pmiAddInstance(3) for the metric's instance domain.

       When combined with pmiPutValueHandle(3), the use of handles provide a performance improvement over the alternative lookup for a metric name
       and an instance name for each data value that is required for pmiPutValue(3).

DIAGNOSTICS

       On failure pmiGetHandle returns a negative value that can be turned into an error message by calling pmiErrStr(3).

SEE ALSO

       LOGIMPORT(3), pmiAddInstance(3), pmiAddMetric(3), pmiErrStr(3) and pmiPutValueHandle(3).

							       Performance Co-Pilot						   PMIGETHANDLE3()

PMIADDINSTANCE(3)					     Library Functions Manual						 PMIADDINSTANCE(3)

NAME

       pmiAddInstance - add an element to an instance domain in a LOGIMPORT context

C SYNOPSIS

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

       int pmiAddInstance(pmInDom indom, const char *instance, int inst);

       cc ... -lpcp_import -lpcp

Perl SYNOPSIS
       use PCP::LogImport;

       pmiAddInstance($indom, $instance, $inst);

DESCRIPTION

       As  part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiAddInstance adds a new element to the instance domain identified
       by indom.

       indom would normally be constructed using the pmInDom_build macro, e.g. pmInDom_build(PMI_DOMAIN,0) for the first instance  domain  in  the
       Performance Metrics Domain PMI_DOMAIN (which is the default for all meta data created by the LOGIMPORT library).

       The  new instance must have both an external name (instance) and an internal instance identifier (inst) that is unique across all instances
       in the indom instance domain.  There is a special ``uniqueness rule'' for instance that is imposed by  pmLookupInDom(3),  namely  that  the
       external  instance  name must be unique in the leading non-space characters, e.g. the instance names ``foo'' and ``foo bar'' are considered
       the same by this rule and not allowed in the same instance domain, but ``foo'' and ``foobar'' would be allowed.

       Once defined, the external instance name can be used in calls to pmiGetHandle(3) and/or pmiPutValue(3) with the name of	a  metric  defined
       over the same instance domain.

DIAGNOSTICS

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

SEE ALSO

       LOGIMPORT(3), pmiAddMetric(3), pmiErrStr(3), pmiGetHandle(3), pmiPutValue(3) and pmLookupInDom(3).

Performance Co-Pilot														 PMIADDINSTANCE(3)