Agent Guides › Web Agent Guide › Configure Logs › Set Up and Enable Error Logging

Set Up and Enable Error Logging

The error log is not available until you enable logging and specify a location for the log file. The parameters that enable error logging and determine options such as appending log data are defined in a local configuration file or an Agent Configuration Object at the Policy Server.

Web Agents installed on an IIS 6.0 or Apache 2.0 web server do not support dynamic configuration of log parameters set locally in a local configuration file. Consequently, when you modify a parameter, the change does not take effect until the Agent is restarted. However, these log settings can be stored and updated dynamically if you configure them in an Agent Configuration Object at the Policy Server.

Note: IIS Agents create log files only after the first user request is submitted. Apache 2.0 Web Agents create log files when the Apache server starts.

To set up and enable error logging

1. If you do not have a log file already, create a new log file and any related directories.
2. Set the value of the LogFile parameter to yes.

   Note: Setting the value of this parameter to yes in a local configuration file of a web server overrides any of the logging settings defined on the Policy Server. For example, when the value of this parameter is set to yes in a LocalConfig.conf file, then log files are generated even if the value of the AllowLocalConfig parameter in the corresponding Agent Configuration object on the Policy Server is set to no. Set the related logging parameters (that define the file name, size, and others) in the LocalConfig.conf file too to override any Policy Server log settings.

3. Specify the full path to the error file, including the file name, in any of the following parameters:

   LogFileName

   Specifies the full path (including the file name) of the log file.

   Default: No

   Example: (Windows) web_agent_home\log\WebAgent.log

   Example: (UNIX/LInux> /export/iPlanet/servers/https-jsmith/logs/WebAgent.log

   LogFileName32

   Specifies the full path to a log file for a SiteMinder Web Agent for IIS on 64-bit Windows operating environments protecting 32-bit applications. The 32-bit applications run in Wow64 mode on the 64-bit Windows operating environment. If logging is enabled but this parameter is not set, the Web Agent for IIS appends _32 to the log file name.

   Default: No

   Limits: For Windows 64-bit operating environments only. Specify the file name at the end of the path.

   Example: (Windows 64-bit operating environments using Wow64 mode) web_agent_home\log\WebAgent32.log.

4. (Optional) Set the following parameters (in the Agent Configuration Object on the Policy Server or in the local configuration file):

   LogAppend

   Adds new log information to the end of an existing log file. When this parameter is set to no, the entire log file is rewritten each time logging is invoked.

   Default: No

   LogFileSize

   Specifies the size limit of the log file in megabytes. When the current log file reaches this limit, a new log file is created. The new log file uses one of the following naming conventions:

   • For framework agents, the new log file has a sequence number appended to the original name. For example, a log file named myfile.log is renamed to myfile.log.1 when the size limit is reached.
   • For traditional agents, the new log files are named by appending the date and timestamp to the original name. For example, a log file named myfile.log, is renamed to myfile.log.09-18-2003-16-07-07 when the size limit is reached.

   You must archive or remove the old files manually.

   Default: 0 (no rollover)

   Example: 80

   LogLocalTime

   Specifies whether the logs use Greenwich Mean Time (GMT) or local time. To use GMT, change this setting to no. If this parameter does not exist, the default setting is used.

   Default: Yes

   If you use a local configuration file, your settings will resemble the following example:

   LogFile="yes"
   LogFileName="/export/iPlanet/servers/https-myserver/logs/errors.log"
   LogAppend="no"
   LogFileSize="80"
   LogLocalTime="yes"
   

   Error logging is enabled.