pmparsetime(3) [centos man page]

PMPARSETIME(3)						     Library Functions Manual						    PMPARSETIME(3)

NAME

       __pmParseTime - parse time point specification

C SYNOPSIS

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

       int __pmParseTime(const char *string, struct timeval *logStart, struct timeval *logEnd, struct timeval *rslt, char **errMsg);

       cc ... -lpcp

DESCRIPTION

       __pmParseTime  is  designed  to	encapsulate  the  interpretation of a time point specification in command line switches for use by the PCP
       client tools.

       This function expects to be called with the time point specification as string.	If the tool is running against PCP  archive(s),  you  also
       need to supply the start time of the first (only) archive as logStart, and the end of the last (only) archive as logEnd.  See pmGetArchive-
       Label(3) and pmGetArchiveEnd(3) for how to obtain values for these parameters.  If the tool is running against a live feed  of  performance
       data, logStart should be the current time (but could be aligned on the next second for example), while logEnd should have its tv_sec compo-
       nent set to INT_MAX.

       The rslt structure must be allocated before calling __pmParseTime.

       You also need to set the current PCP reporting time zone to correctly reflect the -z and -Z command line parameters  before  calling  __pm-
       ParseTime.  See pmUseZone(3) and friends for information on how this is done.

       If  the	conversion  is successful, __pmParseTime returns 0, and fills in rslt with the time value defined by the input parameters.  If the
       argument strings could not be parsed, it returns -1 and a dynamically allocated error message string in errMsg.	Be sure to  free(3C)  this
       error message string.

SEE ALSO

       PMAPI(3),  pmGetArchiveEnd(3),  pmGetArchiveLabel(3),  pmNewContextZone(3),  pmNewZone(3), pmParseInterval(3), pmParseTimeWindow(3), pmUse-
       Zone(3), __pmConvertTime(3) and __pmParseCtime(3).

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