Previous Topic: Set the WebLogic Environment for the SiteMinder WSS AgentNext Topic: How to Set Log Files, and Command-line Help to Another Language


SiteMinder WSS Agent for Oracle WebLogic Logging

This section contains the following topics:

SiteMinder WSS Agent Logging

Log Files

Change the SiteMinder WSS Agent Log File Name

Append Messages to an Existing SiteMinder WSS Agent Log File

Set the SiteMinder WSS Agent File Log Level

Roll Over the SiteMinder WSS Agent Log File

Disable SiteMinder WSS Agent XML Message Processing Logging

SiteMinder WSS Agent Log Configuration File Summary

How to Set Log Files, and Command-line Help to Another Language

SiteMinder WSS Agent Logging

The SiteMinder WSS Agent logger for application servers is implemented using Apache’s log4j. For more information, see http://logging.apache.org/log4j/docs/.

Log Files

Two log files provide important information about the SiteMinder WSS Agent:

SiteMinder WSS Agent Log

The SiteMinder WSS Agent for Oracle WebLogic writes information about its standard operations and performance to the SiteMinder WSS Agent log.

By default, SiteMinder WSS Agent logging is enabled and written to the XmlAgent.log file in:

You can change SiteMinder WSS Agent logging parameters by editing the log-config.properties file located in:

Note: These are the default values; the logging configuration file name and location can be changed by editing the log-config-properties JVM system property.

SiteMinder WSS Agent XML Message Processing Logging

In addition to its standard logging functionality, SiteMinder WSS Agents for Application Servers also logs information relating specifically to its processing of XML messages. Like the SiteMinder WSS Agent log, the XML message processing log is also implemented using Apache’s log4j standard.

Note: SiteMinder WSS Agent XML message processing logging does not start until an XML message that needs to be processed is received.

By default, SiteMinder WSS Agent XML message processing logging is enabled and written to the soasm_agent.log file in:

You can change SiteMinder WSS Agent XML message processing logging parameters by editing the log.config file, which can be found in:

Change the SiteMinder WSS Agent Log File Name

To change pathname of the SiteMinder WSS Agent log file, edit the log.logfile-pattern parameter. Possible values are valid pathnames. If you specify a relative value, the path is set relative to the JAVA_AGENT_ROOT JVM system property.

Default value: "log\XmlAgent.log"

For example:

log.logfile-pattern=log\XmlAgent.log

Append Messages to an Existing SiteMinder WSS Agent Log File

To add logging information to an existing SiteMinder WSS Agent log file instead of rewriting the entire file each time logging is invoked, add the log.logfile-append-on-reset parameter.

For example:

log.logfile-append-on-reset=YES

Set the SiteMinder WSS Agent File Log Level

To change the SiteMinder WSS Agent log level, edit the log.logging-level parameter. Possible values are:

Default value: WARNING

For example:

log.logging-level=INFO

Roll Over the SiteMinder WSS Agent Log File

To change file size limit at which the SiteMinder WSS Agent log should rollover, change the log.logfile-limit parameter. Rolling over a log file starts a new log file, preventing a single log file from becoming unmanageable. Possible values are numbers, representing kilobytes.

The default value is 1000.

For example:

log.logfile-limit=512

Disable SiteMinder WSS Agent XML Message Processing Logging

To disable SiteMinder WSS Agent XML message processing logging, remove or comment out (using a "#" prefix) the following lines from the log.config file located in the Agent config subdirectory:

log4j.appender.A2=org.apache.log4j.DailyRollingFileAppender
log4j.appender.A2.File=${NETE_TXM_ROOT}/bin/soasm_agent.log

SiteMinder WSS Agent Log Configuration File Summary

The SiteMinder WSS Agent logging configuration file defines default SiteMinder WSS Agent logging settings.

Available configuration parameters are:

Name

Description

log.logfile-append-on-reset

Add logging information to an existing log file instead of creating a new file each time logging is invoked.

Default value: no

log.logfile-pattern

Specifies the pathname (relative to WSS_Home) of the SiteMinder WSS Agent log file.

Default value: log/XmlAgent.log

log.logging-level

Defines the logging level. The levels are:

  • DEBUG - all logging, most verbose
  • CONFIG - configuration information
  • INFO - information
  • WARNING -warnings
  • SEVERE - errors

Default value: WARNING

log.logfile-limit

Specifies the size limit, in kilobytes Rollover a log file after it reaches the specified size.

Default value: 1,000KB

Note: Once the SiteMinder WSS Agent connects to the Policy Server, corresponding logging settings found in the Agent Configuration Object override the values in log-config.properties.