WebServerLogMBean

Overview

Aggregates the logging attributes for the WebServerMBean.

Attributes

This section describes the following attributes:

BufferSizeKB

Gets the underlying log buffer size in kilobytes

CachingDisabled

Private property that disables caching in proxies.

DateFormatPattern

The date format pattern used for rendering dates in the log. The DateFormatPattern string conforms to the specification of the java.text.SimpleDateFormat class.

ELFFields

Returns the list of fields specified for the extended logging format for access.log.

FileCount

The maximum number of log files that the server creates when it rotates the log. This number does not include the file that the server uses to store current messages. (Requires that you enable Number of Files Limited.)

For more information, see:

• isNumberOfFilesLimited

FileMinSize

The size (1 - 65535 kilobytes) that triggers the server to move log messages to a separate file. The default is 500 kilobytes. After the log file reaches the specified minimum size, the next time the server checks the file size, it will rename the current log file as SERVER_NAME.lognnnnn and create a new one to store subsequent messages. (Requires that you specify a file rotation type of Size.)

For more information, see:

• getRotationType

FileName

The name of the log file.

FileTimeSpan

The interval (in hours) at which the server saves old log messages to another file. (Requires that you specify a file rotation type of TIME.)

For more information, see:

• getRotationType

LogFileFormat

The format of the HTTP log file. Both formats are defined by the W3C. With the extended log format, you use server directives in the log file to customize the information that the server records.

LogFileRotationDir

The directory where the rotated log files will be stored. By default the rotated files are stored in the same directory where the log file is stored.

LoggingEnabled

Indicates whether this server logs HTTP requests. (The remaining fields on this page are relevant only if you select this check box.)

Gets the loggingEnabled attribute of the WebServerMBean object.

LogTimeInGMT

Specifies whether the time stamps for HTTP log messages are in Greenwich Mean Time (GMT) regardless of the local time zone that the host computer specifies.

Use this method to comply with the W3C specification for Extended Format log files. The specification states that all time stamps for Extended Format log entries be in GMT.

This method applies only if you have specified the extended message format.

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:
Name=user-specified-name

Notes

Optional information that you can include to describe this configuration.

WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.

Note:

If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

NumberOfFilesLimited

Indicates whether to limit the number of log files that this server instance creates to store old messages. (Requires that you specify a file rotation type of SIZE or TIME.)

After the server reaches this limit, it deletes the oldest log file and creates a new log file with the latest suffix.

If you do not enable this option, the server creates new files indefinitely and you must clean up these files as you require.

For more information, see:

• getRotationType

ObjectName

Returns the ObjectName under which this MBean is registered in the MBean server.

Deprecated.

Parent

Return the immediate parent for this MBean

Registered

Returns false if the MBean represented by this object has been unregistered.

Deprecated.

RotateLogOnStartup

Specifies whether a server rotates its log file during its startup cycle. The default value in production mode is false.

RotationTime

Determines the start time (hour and minute) for a time-based rotation sequence.

At the time that this value specifies, the server renames the current log file. Thereafter, the server renames the log file at an interval that you specify in File Time Span.

Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.

Use the following format: H:mm, where

• H

  is Hour in day (0-23).

• mm

  is the minute in hour

For more information, see:

• getRotationType
• getFileTimeSpan

RotationType

Criteria for moving old log messages to a separate file.

• NONE

  Messages accumulate in a single file. You must erase the contents of the file when the size is too large. Note that WebLogic Server sets a threshold size limit of 500 MB before it forces a hard rotation to prevent excessive log file growth.

• SIZE

  When the log file reaches the size that you specify in FileMinSize, the server renames the file as SERVER_NAME.lognnnnn.

• TIME

  At each time interval that you specify in TimeSpan, the server renames the file as SERVER_NAME.lognnnnn.

After the server renames a file, subsequent messages accumulate in a new file with the name that you specified as the log file name.

Type

Returns the type of the MBean.

Operations

This section describes the following operations:

freezeCurrentValue

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note:

To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Deprecated. 9.0.0.0

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

restoreDefaultValue

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Deprecated. 9.0.0.0

unSet

Restore the given property to its default value.