Previous Topic: Configure JBoss to Work with the SiteMinder AgentNext Topic: Set Log Files, and Command-line Help to Another Language


Configure CA SiteMinder® Agent for JBoss Logging

This section contains the following topics:

Overview

Log Files

Change the SiteMinder Agent Log File Name

Append Messages to an Existing SiteMinder Agent Log File

Set the SiteMinder Agent File Log Level

Roll Over the SiteMinder Agent Log File

SiteMinder Agent Log Configuration File Summary

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

Overview

The SiteMinder Agent for JBoss logger 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 Agent:

SiteMinder Agent Log

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

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

You can change SiteMinder 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.log-config-properties JVM system property.

SiteMinder XML Message Processing Log

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

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

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

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

Change the SiteMinder Agent Log File Name

To change the pathname of the SiteMinder Agent log file, edit the log.logfile-pattern parameter in the log-config.properties file. 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: "./soa-log/XmlAgent.log"

For example:

log.logfile-pattern=log/XmlAgent.log

Append Messages to an Existing SiteMinder Agent Log File

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

For example:

log.logfile-append-on-reset=YES

Set the SiteMinder Agent File Log Level

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

Default value: SEVERE

For example:

log.logging-level=INFO

Note: the more verbose logging levels can rapidly result in very large log files and may not therefore be appropriate for production environments.

Roll Over the SiteMinder Agent Log File

To change file size limit at which the SiteMinder 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

SiteMinder Agent Log Configuration File Summary

The SiteMinder Agent logging configuration file (SMAGENT_HOME\config\log-config.properties) defines default SiteMinder Agent logging settings.

Available configuration parameters are as follows:

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 JBOSS_HOME/bin) of the SiteMinder Agent log file.

Default value: /soa-log/XmlAgent.log

log.logging-level

Defines the logging level. The levels are:

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

Default value: SEVERE

log.logfile-limit

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

Default value: 1000

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