SiteScope User's Guide

Log Descriptions

SiteScope records the readings and measurements from the monitors you have defined in log files. The tab delimited text log files can be viewed directly and they are used to generate management reports. The log files can also be used for operational analysis by other software applications. This page describes the format of the SiteScope log files and log database.

SiteScope Log Files

Every time SiteScope runs a monitor, the measurements for the monitor are written in the SiteScope log file. The current SiteScope log files are located in the ~SiteScope/logs directory and is named based on the date - for example, the log file for August 1, 1998 is named SiteScope1998_08_01.log. Within SiteScope you can access the monitor logs by clicking on the "View the log of alerts sent" link on the SiteScope Alert detail page.

(Previous versions of SiteScope saved this information in files called SiteScope.log and SiteScope.log.old)

The SiteScope log file contains monitoring data separated into tab delimited fields. The following is a sample of some log entries:

11:54:50 07/25/96	good	Server	Web server performance	8.61 hits/min	1:232	10	12000	8.61	1023.4	
11:54:51 07/25/96	error	Server	Local home page	forbidden	2:112
11:54:54 07/25/96	good	Server	FTP Service	running	3:154		
11:55:04 07/25/96	good	Network	CPU	36% used	1:311	
11:56:28 07/25/96	good	Network	CPU	34% used	1:312
11:57:27 07/25/96	good	Network	CPU	19% used	1:313	
11:58:06 07/25/96	good	Server	Disk space on C drive	68% full	4:43

Below is a description of the information listed in each column of the log file:

Log File Column Data Description

1 11:54:50 The first column contains the time and date that the monitor ran.

2 good The second column contains the monitor's current status.

3 Server The third column contains the name of the group that the monitor belongs to.

4 Web server performance The fourth column contains the monitor's name.

5 8.61 hits/min The fifth column contains the monitor's current reading.

6 1:232 The sixth column contains the monitor ID and sample number. The monitor ID is before the : (in this case 1) and the sample number is after the : (in this case 232).

7, 8,
9, ... (variable) The remaining columns contain additional data specific to that monitor. For a full description of all of the columns for each type of monitor, refer to the Detailed SiteScope Log File Columns listing.

Log File Column	Data	Description
1	11:54:50	The first column contains the time and date that the monitor ran.
2	good	The second column contains the monitor's current status.
3	Server	The third column contains the name of the group that the monitor belongs to.
4	Web server performance	The fourth column contains the monitor's name.
5	8.61 hits/min	The fifth column contains the monitor's current reading.
6	1:232	The sixth column contains the monitor ID and sample number. The monitor ID is before the : (in this case 1) and the sample number is after the : (in this case 232).
7, 8, 9, ...	(variable)	The remaining columns contain additional data specific to that monitor. For a full description of all of the columns for each type of monitor, refer to the Detailed SiteScope Log File Columns listing.

For information about a monitor's status or reading, refer to the help text for that monitor.

Other Logs

SiteScope produces several other log files and the following provides a brief outline of what you will find in each one. All log files are found in the SiteScope/logs directory.

access.log: Access.log records hits on SiteScope's internal web server. The format follows the Common Logfile Format, which is the format used by many web servers.
alert.log: alert.log records all of the alerts sent or run by SiteScope -- both those that are successful and those that fail for some reason
error.log: error.log records any errors and some diagnostic information (SiteScope startup is the most common). Errors include failed alerts, errors in the web server HTTP requests (if you have a login, the most common will be an HTTPRequestException 401, which are normal authentication errors), or monitors that run for a long time.
RunMonitor.log: RunMonitor.log is a progress log for SiteScope and is not all that useful for most users.

SiteScope Log Database Table

When a monitor runs, a record can optionally be saved into a SQL database. See the Log Preferences page for more information about database logging.

Log data is contained in a single table called SiteScopeLog. The first nine fields of each database record are the same for all monitors. The next ten fields contain different measurements depending on the kind of monitor supplying the data. All the fields use the VARCHAR(255) data type. A description of the fields in the log database record are shown in the table below along with their default field names:

Field Name Example Data Description

datex 1999-01-20 11:54:54 The first field contains the date that the monitor ran.

serverName demo.sitescope.com The second field contains the name of the server where SiteScope is running.

class URLMonitor The third field contains the type of the monitor

sample 23 The fourth field contains the sample number of this monitor

category good The fifth field contains the category name of the monitor

groupName URLs The sixth field contains the group name of the monitor

monitorName Home Page The seventh field contains the name of the monitor

status 1.01 seconds The eighth field contains the status of the monitor

monitorID 10 The ninth field contains the ID of the monitor

value1, value2, ... value10 (variable) The tenth through nineteenth fields contain the monitor specific data as described in the Log Columns page. The first variable field (value1) will correspond to the value listed as column 7 in the log files.

Field Name	Example Data	Description
datex	1999-01-20 11:54:54	The first field contains the date that the monitor ran.
serverName	demo.sitescope.com	The second field contains the name of the server where SiteScope is running.
class	URLMonitor	The third field contains the type of the monitor
sample	23	The fourth field contains the sample number of this monitor
category	good	The fifth field contains the category name of the monitor
groupName	URLs	The sixth field contains the group name of the monitor
monitorName	Home Page	The seventh field contains the name of the monitor
status	1.01 seconds	The eighth field contains the status of the monitor
monitorID	10	The ninth field contains the ID of the monitor
value1, value2, ... value10	(variable)	The tenth through nineteenth fields contain the monitor specific data as described in the Log Columns page. The first variable field (value1) will correspond to the value listed as column 7 in the log files.

The logging statement can be changed by editing _logJdbcInsertSiteScopeLog in the groups/master.config file. A stored procedure can be called by replacing the insert statement with a call statement. For example, "call logit(?,?,?)" would call the stored procedure named logit passing it the first three parameters.

Contact Customer Support (http://support.mercuryinteractive.com) if you are interested in saving separate records for each measurement of a monitor.