PMIPUTRESULT(3)

NAME
pmiPutResult, pmiPutHighResResult - add a data record to a LOGIMPORT archive

C SYNOPSIS
#include <pcp/pmapi.h>
#include <pcp/import.h>

int pmiPutResult(const pmResult_v2 *result);
int pmiPutHighResResult(const pmResult *result);

cc ... -lpcp_import -lpcp

Python SYNOPSIS
from pcp import pmi

log.put_result(result)
log.put_highres_result(result)

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

By building a pmResult data structure directly and calling one of these routines, the developer avoids the separate pmiPutValue(3) and/or pmiPutValueHandle(3) calls followed by pmiHighResWrite(3) for each record written to the archive.

pmiPutHighResResult is the preferred interface. It accepts a pmResult with a struct timespec timestamp, giving nanosecond resolution and Y2038-safe 64-bit seconds.

pmiPutResult accepts the older pmResult_v2 type with a struct timeval timestamp (microsecond resolution).

Any metrics and instances appearing in result must have been defined by prior calls to pmiAddMetric(3) and pmiAddInstance(3). Both routines will arrange for any new metadata (metrics and/or instance domain changes) covered by result to be written to the PCP archive.

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

DIAGNOSTICS
Both routines return 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), pmiPutText(3), pmiPutLabel(3), pmiPutValueHandle(3), pmiSetTimezone(3), pmiHighResWrite(3) and pmiWrite(3).