logimport(3) [centos man page]

LOGIMPORT(3)						     Library Functions Manual						      LOGIMPORT(3)

NAME

       LOGIMPORT - introduction to the library for importing data and creating a PCP archive

C SYNOPSIS

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

       cc ... -lpcp_import -lpcp

Perl SYNOPSIS
       use PCP::LogImport;

DESCRIPTION

       The  Performance Co-Pilot Log Import (LOGIMPORT) API is a library (and Perl wrapper) that supports the creation of PCP archives from exter-
       nal sources of performance data, either in the form of historical logs and spreadsheets or from real-time sources that are  not	integrated
       as a Performance Metrics Domain Agent (PMDA) under the control of pmcd(1).

       The typical usage for LOGIMPORT would involve:

       o  An initial call to pmiStart(3).

       o  Optional calls to pmiSetHostname(3) and/or pmiSetTimezone(3) to set the hostname and timezone for the source of the performance data.

       o  One or more calls to pmiAddMetric(3) to define performance metrics.

       o  One or more calls to pmiAddInstance(3) to define instances associated with the metrics.

       o  Optional calls to pmiGetHandle(3) to defined convenience handles for metric-instance pairs.

       o  A  main  loop in which performance data is injested and for each sample time interval, the PCP archive record is constructed by calls to
	  pmiPutValue(3) and/or pmiPutValueHandle(3), followed by a call to pmiWrite(3) to flush all data and any associated new metadata  to  the
	  PCP archive.	Alternatively, pmiPutResult(3) could be used to package and process all the data for one sample time interval.

       o  Once the input source of data has been consumed, calling pmiEnd(3) to complete the PCP archive creation and close all open files.

       If  new metrics and/or instances are discovered during the data injestion, these can be added by subsequent calls to pmiAddMetric(3) and/or
       pmiAddInstance(3), provided all the metrics and instances have been defined before a call to  pmiGetHandle(3),  pmiPutValue(3)or  pmiPutRe-
       sult(3) that references those metrics and instances.

SEE ALSO

       pmcd(1),  pmlogger(1),  pmiGetHandle(3),  pmiAddInstance(3),  pmiAddMetric(3),  pmiEnd(3),  pmiErrStr(3),  pmiPutResult(3), pmiPutValue(3),
       pmiPutValueHandle(3), pmiSetHostname(3), pmiSetTimezone(3), pmiStart(3) and pmiWrite(3).

Performance Co-Pilot														      LOGIMPORT(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)