Previous Common Configuration Properties Next

Logging Properties

All OpenFusion Services can produce logging information. This can be used to both track bugs and monitor server operation. OpenFusion uses four basic logging levels: Error, Warning, Information and Debug. The OpenFusion logging system uses the log4j logging package. (See http://jakarta.apache.org/log4j for more information.)

Log Pattern

The format used for the logging output. This property is only required if Log Layout is set to Pattern.

Details of setting log patterns can be found in Log Messages.

Property Name

log4j.appender.Default.layout.ConversionPattern

Property Type

STATIC

Data Type

STRING

Accessibility

READ/WRITE

Mandatory

YES

Log Layout

The layout used for the logging output. Choices are:

If Pattern is selected, the Log Pattern property must be set.

Property Name

log4j.appender.Default.layout

Property Type

STATIC

Data Type

ENUM

Accessibility

READ/WRITE

Mandatory

YES

Enabled LogFactor5 pattern layout

If true, log output is formatted for viewing with LogFactor5. The default is false. The property is only used if the Log Layout property is set to Pattern.

Property Name

LogFactor5.enabled

Property Type

STATIC

Data Type

BOOLEAN

Accessibility

READ/WRITE

Mandatory

NO

Syslog Facility

This is the UNIX Syslog facility to which logging is directed. See your UNIX documentation for more information on Syslog facility categories.

Property Name

log4j.appender.Default.Facility

Property Type

STATIC

Data Type

ENUM

Accessibility

READ/WRITE

Mandatory

YES

Syslog Host

This option determines the name of the host to which logging is directed when the Syslog logging plug-in is selected. Syslog output is sent to the local host by default.

Property Name

log4j.appender.Default.SyslogHost

Property Type

STATIC

Data Type

STRING

Accessibility

READ/WRITE

Mandatory

YES

File Backup Number

This is the number of backup files that are retained after the value of File Maximum Size is exceeded and RollingFile is selected as the logging plug-in. The default is 1.

Property Name

log4j.appender.Default.MaxBackupIndex

Property Type

STATIC

Data Type

INTEGER

Accessibility

READ/WRITE

Mandatory

NO

File Append

This option controls whether the existing log file is replaced or new messages are appended to the file.

Property Name

log4j.appender.Default.Append

Property Type

STATIC

Data Type

BOOLEAN

Accessibility

READ/WRITE

Mandatory

NO

File Maximum Size

This is the maximum size of the log file created when RollingFile is selected as the logging plug-in. A new logging file will be created when the value of File Maximum Size is exceeded.

Property Name

log4j.appender.Default.MaxFileSize

Property Type

STATIC

Data Type

INTEGER

Accessibility

READ/WRITE

Mandatory

NO

Log File

The File Name specifies the file where diagnostic output is saved. A default value is used when this property is not set. This is:

<install_dir>/domains/<domain>/<node>/<service>/log/<service>.log

where <install_dir> is the OpenFusion installation path. See The Object Hierarchy for details of the domains directory structure.

Property Name

log4j.appender.Default.File

Property Type

STATIC

Data Type

FILE

Accessibility

READ/WRITE

Mandatory

YES

Log Plug-in

This property determines how diagnostic output will be logged. Options are:

File

Selecting this option will direct all diagnostic output to a file specified by the Log File property.

Rolling File

This option directs diagnostic output to a file. The output file is backed up periodically when a specific size is reached. See also File Backup Number.

Syslog


This option directs diagnostic output to the UNIX syslog facility.


Event Log

This option directs diagnostic output to the NT Event Log.

Log Service

This option redirects all diagnostic output to the OpenFusion Log Service. A notification-type log is used.

None

All diagnostic messages are disabled.

Property Name

log4j.appender.Default

Property Type

STATIC

Data Type

ENUM

Accessibility

READ/WRITE

Mandatory

YES

Notify Log ID

This is the identity of the Notify Log that is used when logging to the Log Service is selected. A new log is created when a log with this identity does not already exist.

Property Name

log4j.appender.Default.LogID

Property Type

STATIC

Data Type

INTEGER

Accessibility

READ/WRITE

Mandatory

YES

Log Level

This property determines the level of diagnostic output that is logged in the log file. The logging level can be changed dynamically. Options are:


Caution: significant amounts of output may be generated when the Debug level of logging is selected.

Property Name

log4j.rootLogger

Property Type

DYNAMIC

Data Type

ENUM

Accessibility

READ/WRITE

Mandatory

YES



Previous Common Configuration Properties Next