|
NAME | C SYNOPSIS | Perl SYNOPSIS | DESCRIPTION | DIAGNOSTICS | SEE ALSO | COLOPHON |
PMIADDINSTANCE(3) Library Functions Manual PMIADDINSTANCE(3)
pmiAddInstance - add an element to an instance domain in a LOGIMPORT
context
#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
use PCP::LogImport;
pmiAddInstance($indom, $instance, $inst);
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.
pmiAddInstance returns zero on success else a negative value that can
be turned into an error message by calling pmiErrStr(3).
LOGIMPORT(3), pmiAddMetric(3), pmiErrStr(3), pmiGetHandle(3),
pmiPutValue(3) and pmLookupInDom(3).
This page is part of the PCP (Performance Co-Pilot) project.
Information about the project can be found at ⟨http://www.pcp.io/⟩.
If you have a bug report for this manual page, send it to
pcp@oss.sgi.com. This page was obtained from the project's upstream
Git repository ⟨git://git.pcp.io/pcp⟩ on 2017-07-05. If you discover
any rendering problems in this HTML version of the page, or you
believe there is a better or more up-to-date source for the page, or
you have corrections or improvements to the information in this
COLOPHON (which is not part of the original manual page), send a mail
to man-pages@man7.org
Performance Co-Pilot PMIADDINSTANCE(3)
Pages that refer to this page: logimport(3), pmigethandle(3), pmiputmark(3), pmiputresult(3), pmiputvalue(3), pmistart(3), pmiunits(3), pmiwrite(3)