pmgetarchivelabel(3) [centos man page]

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)

PCP.CONF(5)							File Formats Manual						       PCP.CONF(5)

NAME

       pcp.conf - the Performance Co-Pilot configuration and environment file

SYNOPSIS

       /etc/pcp.conf

DESCRIPTION

       When  using  Performance Co-Pilot (PCP) tools and utilities and when calling PCP library functions, a standard set of environment variables
       are defined in /etc/pcp.conf.  These variables are generally used to specify the location of various PCP pieces in the file system and  may
       be  loaded  into  shell scripts by sourcing the /etc/pcp.env(5) shell script and queried by C/C++ programs using the pmGetConfig(3) library
       function.  If a variable is already defined in the environment, the values in pcp.conf do not override those values,  i.e.  the	values	in
       pcp.conf serve as installation defaults only.

       Both  the  pcp.env  and	pcp.conf  files  are expected to be found in /etc by default.  If required, the pcp.conf file may be relocated and
       PCP_CONF set in the environment to specify the full path to the new location.  The pcp.env file can not be relocated (this is the only hard
       coded path required by PCP).

       The syntax rules for pcp.conf are as follows :

       1.  the general syntax is
						       PCP_VARIABLE_NAME=variable value to end of line

       2.  lines that begin with # and all blank lines are ignored.

       3.  all variables must be prefixed with PCP_.  This is a security issue - variables that do not have this prefix will be silently ignored.

       4.  there  should  be  no  space  between the variable name and the literal = and no space between the = and the variable value (unless the
	   value actually starts with a space).  This is required because the pcp.conf file may be sourced directly by Makefiles as well as inter-
	   preted by the pcp.env script and the pmGetConfig function.

       5.  variable  values  may  contain  spaces  and should not be quoted.  The pcp.env script automatically quotes all variable values from the
	   character immediately following the = through to the end of the line.

       For further details and an explanation of the use of each variable, see the comments in the /etc/pcp.conf file itself.

ENVIRONMENT

       The PCP_CONF environment variable specifies an alternative path to the pcp.conf file.

SEE ALSO

       PCPIntro(1), PCPIntro(3), PMAPI(3), pmGetConfig(3) and pcp.env(5).

Performance Co-Pilot							PCP							       PCP.CONF(5)