pmiputresult(3) [centos man page]

PMIPUTRESULT(3) 					     Library Functions Manual						   PMIPUTRESULT(3)

NAME

       pmiPutResult - add a data record to a LOGIMPORT archive

C SYNOPSIS

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

       int pmiPutResult(const pmResult *result);

       cc ... -lpcp_import -lpcp

DESCRIPTION

       As  part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiPutResult provides an interface for developers familiar with the
       internal PCP data structures to create output archives directly.

       By building the pmResult data structure directly, then calling pmiPutResult the developer avoids calls to pmiPutValue(3) and/or	pmiPutVal-
       ueHandle(3) followed by a call to pmiWrite(3) for each record written to the archive.

       Any metrics and instances appearing in the result must have been defined by prior calls to pmiAddMetric(3) and pmiAddInstance(3).

       pmiPutResult will arrange for any new metadata (metrics and/or instance domain changes) covered by result to be also written to the PCP ar-
       chive.

       Because of the complexity of the pmResult data structure, this routine is not available in the Perl interface to the LOGIMPORT services.

DIAGNOSTICS

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

SEE ALSO

       LOGIMPORT(3), PMAPI(3), pmiAddInstance(3), pmiAddMetric(3), pmiErrStr(3), pmiPutValue(3), pmiPutValueHandle(3), pmiSetTimezone(3) and  pmi-
       Write(3).

Performance Co-Pilot														   PMIPUTRESULT(3)

PMISTART(3)						     Library Functions Manual						       PMISTART(3)

NAME

       pmiStart - establish a new LOGIMPORT context

C SYNOPSIS

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

       int pmiStart(const char *archive, int inherit);

       cc ... -lpcp_import -lpcp

Perl SYNOPSIS
       use PCP::LogImport;

       pmiStart($archive, $inherit);

DESCRIPTION

       As  part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiStart creates a new context.	Each context maintains the follow-
       ing state and metadata:

       o  The base name (archive) for the physical  files that constitute the output PCP archive.

       o  The source hostname for the data that will be written to the PCP archive.  Defaults to the hostname of the localhost,  but  can  be  set
	  using pmiSetHostname(3).

       o  The source timezone for the PCP archive.  Defaults to the timezone of the localhost, but can be set using pmiSetTimezone(3).

       o  Metrics and instance domains, as defined by pmiAddMetric(3).

       o  Instances for each instance domain, as defined by pmiAddInstance(3).

       o  Handles  as  defined	by  pmiGetHandle(3).   Each handle is a metric-instance pair, and each metric-instance pair may have an associated
	  value in each record written to the output PCP archive.

       o  An optional set of data values for one or more metric-instance pairs (ready for the next record to be written to the output PCP archive)
	  as defined by calls to pmPutValue(3) or pmPutValuehandle(3).

       If inherit is true, then the new context will inherit any and all metadata (metrics, instance domains, instances and handles) from the cur-
       rent context, otherwise the new context is created with no metadata.  The basename for the output PCP archive,  the  source  hostname,  the
       source timezone and any data values from the current context are not inherited.	If this is the first call to pmiStart the metadata will be
       empty independent of the value of inherit.

       Since no physical files for the output PCP archive will be created until the first call to pmiWrite(3) or pmiPutRecord(3), archive could be
       NULL to create a convenience context that is populated with metadata to be inherited by subsequent contexts.

       The return value is a context identifier that could be used in a subsequent call to pmUseContext(3) and the new context becomes the current
       context which persists for all subsequent calls up to either another pmiStart call or a call to pmiUseContext(3) or a call to pmiEnd(3).

DIAGNOSTICS

       It is an error if the physical files archive.0 and/or archive.index and/or archive.meta already exist, but this is not discovered until the
       first  attempt is made to output some data by calling pmiWrite(3) or pmiPutRecord(3), so pmiStart always returns a positive context identi-
       fier.

SEE ALSO

       LOGIMPORT(3), pmiAddInstance(3), pmiAddMetric(3), pmiEnd(3), pmiErrStr(3), pmiGetHandle(3), pmiPutResult(3),  pmiPutValue(3),  pmiPutValue-
       Handle(3), pmiSetHostname(3), pmiSetTimezone(3), pmiUseContext(3) and pmiWrite(3).

Performance Co-Pilot														       PMISTART(3)