test

Sun Java System Federation Manager 7.0 User's Guide

Logging

The Logging service provides status and error messages related to Federation Manager administration. An administrator can configures values such as log file size and log file location. Federation Manager can record events in flat text files or in a relational database. The Logging service attributes are global attributes. The attributes are:

Maximum Log Size

This attribute accepts a value for the maximum size (in bytes) of a Federation Manager log file. The default value is 1000000.

Number of History Files

This attribute has a value equal to the number of backup log files that will be retained for historical analysis. Any integer can be entered depending on the partition size and available disk space of the local system. The default value is 3.

Note –

Entering a value of 0 is interpreted to be the same as a value of 1, meaning that if you specify 0, a history log file will be created.

The value in this attribute is only used when the Logging Type attribute is set to FILE. If Logging Type is set to DB (Database), there are no history files.

Log File Location

The file-based logging function needs a location where log files can be stored. This field accepts a full directory path to that location. The default location is /var/opt/SUNWam/fm/logs.

If a non-default directory is specified, Federation Manager will create the directory if it does not exist. You should then set the appropriate permissions for that directory (for example, 0700).

When configuring the log location for database logging (such as, Oracle or MySQL), part of the log location is case sensitive. For example, if you are logging to an Oracle database, the log location should be (note case sensitivity):

jdbc:oracle:thin:@machine.domain:port:DBName

To configure logging to a database, add the JDBC driver files to the web container's Java Virtual Machine (JVM) classpath. You need to manually add JDBC driver files to the classpath of the amadmin script or amadmin logging can not load the JDBC driver.

Note –

Changes to logging attributes usually take effect after you save them. This does not require you to restart the server. If you are changing to secure logging, however, you should restart the server.

Logging Type

Enables you to specify either File, for flat file logging, or DB for database logging.

Caution – Caution –

If either of the following attributes (Database User Name or Database User Password) is invalid, it will seriously affect Federation Manager processing. If Federation Manager or the Federation Manager Console becomes unstable, set the com.iplanet.am.logstatus property in AMConfig.properties to INACTIVE.

After setting the property, restart the server, log in to the console and reset the invalid attribute. Then, change the value of the logstatus property back to ACTIVE and restart the server.

Database User Name

This attribute accepts the name of the user that will connect to the database when the Logging Type attribute is set to DB.

Database User Password

This attribute accepts the database user password when the Logging Type attribute is set to DB.

Database User Password (confirm)

Confirm the database password.

Database Driver Name

This attribute enables you to specify the driver used for the logging implementation class.

Configurable Log Fields

Represents the list of fields that are to be logged. By default, all of the fields are logged. The fields are:

At minimum you should log CONTEXTID, DOMAIN, HOSTNAME, LOGINID and MESSAGEID.

Maximum Number of Records

This attribute sets the maximum number of records that the Java LogReader interface returns, regardless of how many records match the read query. By default, it is set to 500. This attribute can be overridden by the caller of the Logging API through the LogQuery class.

Number of Files per Archive

This attribute is only applicable to secure logging. It specifies when the log files and keystore need to be archived, and the secure keystore regenerated, for subsequent secure logging. The default is five files per logger.

Buffer Size

This attribute specifies the maximum number of log records to be buffered in memory before the logging service attempts to write them to the logging repository. The default is one record.

DB Failure Memory Buffer Size

This attribute defines the maximum number of log records held in memory if database logging fails. This attribute is only applicable when DB is specified as the Logging Type. When the Logging Service loses connection to the database, it will buffer up to the number of records specified. This attribute defaults to two times of the value defined in the Buffer Size attribute.

Buffer Time

This attribute defines the amount of time that the log records will buffered in memory before they are sent to the logging service to be logged. This attribute applies if Enable Time Buffering is ON. The default is 3600 seconds.

Enable Time Buffering

When selected as ON, Federation Manager will set a time limit for log records to be buffered in memory. The amount of time is set in the Buffer Time attribute.