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)

PMGETARCHIVELABEL(3)					     Library Functions Manual					      PMGETARCHIVELABEL(3)

NAME

       pmGetArchiveLabel - fetch the label record from a performance metrics archive log

C SYNOPSIS

       #include <pcp/pmapi.h>

       int pmGetArchiveLabel(pmLogLabel *lp);

       cc ... -lpcp

DESCRIPTION

       Within  the  framework of the Performance Co-Pilot (PCP), archive logs of performance metrics values may be accumulated and saved using the
       program pmlogger(1).

       The routine pmGetArchiveLabel may be used to fetch the label record from an archive log that has already been opened using pmNewContext(3),
       or pmDupContext(3), and thereby associated with the current Performance Metrics Application Programming Interface (PMAPI) context.

       The  result  returned  via  the pointer lp is a structure that must be pre-allocated by the caller and has the following format (defined in
       pmapi.h).

	 /*
	  * Label Record at the start of every log file
	  */
	 typedef struct {
	   int	      ll_magic;    /* PM_LOG_MAGIC | log format version no. */
	   pid_t      ll_pid;	   /* PID of logger */
	   struct timeval ll_start;/* start of this log */
	   char       ll_hostname[PM_LOG_MAXHOSTLEN]; /* name of collection host */
	   char       ll_tz[40];   /* $TZ at collection host */
	 } pmLogLabel;

       For an application, the most useful information from the archive label is likely to be in the fields ll_start, ll_hostname or ll_tz.

       Note that the size of the ll_hostname field is PM_LOG_MAXHOSTLEN (64 bytes) which is less than  MAXHOSTNAMELEN  (see  gethostbyname(3))	on
       some platforms.	These semantics are necessary to retain backwards compatibility with the PCP archive file format.

       pmGetArchiveLabel returns zero for success.

PCP ENVIRONMENT

       Environment  variables  with  the prefix PCP_ are used to parameterize the file and directory names used by PCP.  On each installation, the
       file /etc/pcp.conf contains the local values for these variables.  The $PCP_CONF variable may be used to specify an alternative	configura-
       tion file, as described in pcp.conf(5).	Values for these variables may be obtained programmatically using the pmGetConfig(3) function.

SEE ALSO

       pmlogger(1), PMAPI(3), pmDupContext(3), pmGetConfig(3), pmNewContext(3), pcp.conf(5) and pcp.env(5).

DIAGNOSTICS

       PM_ERR_NOCONTEXT
	      the current PMAPI context is either invalid, or not associated with an archive log

Performance Co-Pilot							PCP						      PMGETARCHIVELABEL(3)