pmlocaltime(3) [centos man page]

PMLOCALTIME(3)						     Library Functions Manual						    PMLOCALTIME(3)

NAME

       pmLocaltime - convert the date and time for a reporting timezone

C SYNOPSIS

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

       struct tm *pmLocaltime(const time_t *clock, struct tm *result);

       cc ... -lpcp

DESCRIPTION

       pmLocaltime  is	very  similar  to localtime(3), except the timezone used is the current ``reporting timezone'' (rather than the default TZ
       environment variable scheme), and the result is returned into a caller-declared buffer (rather than a private buffer).

       Like localtime(3) the time to be converted is passed via clock, and the result contains the components broken out in the elements of the tm
       struct.

       pmLocaltime returns result as the value of the function.

       The default current reporting timezone is as defined by the TZ environment variable, so pmLocaltime and localtime(3) will initially produce
       a similar encoding of the date and time.

       Use pmNewZone(3), pmNewContextZone(3) or pmUseZone(3) to establish a new current reporting timezone that will affect  pmLocaltime  but  not
       localtime(3).

SEE ALSO

       localtime(3), PMAPI(3), pmCtime(3), pmGetConfig(3), pmNewContextZone(3), pmNewZone(3), pmUseZone(3), pcp.conf(5) and pcp.env(5).

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