LogMBean

Overview

Configures the threshold severity level and filter settings for logging output.

Specifies whether the server logging is based on a Log4j implementation or the default Java Logging APIs.

Redirects the JVM stdout and stderr output to the registered log destinations.

Related MBeans

This section describes attributes that provide access to other MBeans.

DomainLogBroadcastFilter

The filter configuration for log events being sent to the domain log.

LogFileFilter

The filter configuration for the server log file.

A filter configuration defines simple filtering rules to limit the volume of log messages written to the log file.

MemoryBufferFilter

The filter configuration for messages that are stored in the log memory buffer. By default, all log messages are cached.

Deprecated. 12.1.3.0

StdoutFilter

The filter configuration for log events being sent to the standard out.

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.

DomainLogBroadcasterBufferSize

Broadcasts log messages to the domain log in batch mode.

The size of the buffer for log messages that are sent to the domain log. The buffer is maintained on the Managed Server and is broadcasted to the domain log when it is full.

If you notice performance issues due to a high rate of log messages being generated, set this value higher. This will cause the buffer to be broadcasted less frequently from the Managed Server to the domain log. In production environments, it is not recommended to set the buffer size lower than the production default of 10.

DomainLogBroadcastSeverity

The minimum severity of log messages going to the domain log from this server's log broadcaster. Messages with a lower severity than the specified value will not be published to the domain log.

DynamicallyCreated

Return whether the MBean was created dynamically or is persisted to config.xml

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 - 2097150 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 file that stores current log messages. Usually it is a computed value based on the name of the parent of this MBean. For example, for a server log, it is SERVER_NAME.log.

However, if the name of the parent cannot be obtained, the file name is weblogic.log. If you specify a relative pathname, it is interpreted as relative to the server's root directory.

To include a time and date stamp in the file name when the log file is rotated, add java.text.SimpleDateFormat variables to the file name. Surround each variable with percentage (%) characters.

For example, if the file name is defined to be myserver_%yyyy%_%MM%_%dd%_%hh%_%mm%.log, the log file will be named myserver_yyyy_mm_dd_hh_mm.log.

When the log file is rotated, the rotated file name contains the date stamp. For example, if the log file is rotated for the first time on 2 April, 2003 at 10:05 AM, the log file that contains the old messages will be named myserver_2003_04_02_10_05.log00001.

If you do not include a time and date stamp, the rotated log files are numbered in order of creation. For example, myserver.log00007.

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

Id

Return the unique id of this MBean instance

Log4jLoggingEnabled

Specifies whether the server logging is based on a Log4j implementation. By default, WebLogic logging uses an implementation based on the Java Logging APIs which are part of the JDK.

Applications that use the WebLogic Message Catalog framework or the NonCatalogLogger will not be affected by the underlying Logging implementation.

Deprecated. 12.1.3.0

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.

LogFileSeverity

The minimum severity of log messages going to the server log file. By default all messages go to the log file.

LoggerSeverity

The minimum severity of log messages going to all log destinations.

LoggerSeverityProperties

The configuration of the different logger severities keyed by name. The values are one of the predefined Severity strings namely Emergency, Alert, Critical, Error, Warning, Notice, Info, Debug, Trace.

LogMonitoringEnabled

Enable or disable log monitoring.

LogMonitoringIntervalSecs

Timer interval in seconds to check the counts of messages logged during the interval.

LogMonitoringMaxThrottleMessageSignatureCount

Maximum number of unique message signatures that will be monitored during the throttle interval.

LogMonitoringThrottleMessageLength

Cut-off length of the log message for evaluation during throttle period. The log message length is truncated to this length for evaluation of repeated logging events.

LogMonitoringThrottleThreshold

The threshold number of messages logged during the evaluation period which enables or disables the throttling.

Once throttling is enabled messages with the same repeating message signatures are throttled. Every nth repeated message specified by this attribute is logged in a monitoring cycle.

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

MemoryBufferSeverity

The minimum severity of log messages going to the memory buffer of recent log events. Messages with a lower severity than the specified value will not be cached in the buffer.

Deprecated. 12.1.3.0

MemoryBufferSize

The size of the memory buffer that holds the last n log records. This is used to support viewing the most recent log record entries (tail viewing) from the WebLogic Administration Console.

Deprecated. 12.1.3.0

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

PlatformLoggerLevels

Specifies the platform logger and the associated level names set through the WebLogic Server configuration.

Note the following behavior:

• The configuration is applicable for java.util.logging.Logger instances in the JDK's default global LogManager.

• WebLogic Server loggers are configured in terms of weblogic.logging.Severities through the LoggerSeverities attribute. These loggers are not available in the JDK's default global LogManager.

• If your WebLogic domain includes Oracle JRF and is configured to use Oracle Diagnostic Logging (ODL), the java.util.logging levels set on the LogMBean.PlatformLoggerLevels attribute are ignored. For information about how to configure ODL logging for JDK platform loggers, see Managing Log Files and Diagnostics Data in Administering Oracle Fusion Middleware.

For more information, see:

• getLoggerSeverityProperties()

RedirectStderrToServerLogEnabled

Specifies whether the stderr of the JVM in which a WebLogic Server instance runs is redirected to the WebLogic Logging system. When this attribute is enabled, the stderr content is published to all the registered log destinations, such as the server terminal console and log file.

Note that JVM messages are redirected asynchronously. In the event of an overload situation, these messages may be dropped. As a best practice, Oracle recommends using one of the supported logging APIs instead.

RedirectStdoutToServerLogEnabled

Specifies whether the stdout of the JVM in which a WebLogic Server instance runs is redirected to the WebLogic logging system. When this attribute is enabled, the stdout content is published to all the registered log destinations, such as the server terminal console and log file.

Note that JVM messages are redirected asynchronously. In the event of an overload situation, these messages may be dropped. As a best practice, Oracle recommends using one of the supported logging APIs instead.

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.

ServerLoggingBridgeUseParentLoggersEnabled

Specifies whether application log messages are propagated to the parent node in the Logger tree or to the WebLogic Server log by means of the Logging Bridge. By default, this attribute is disabled, which results in application log messages being propagated to the WebLogic Server log.

Note the following behavior:

• If WebLogic Server is configured to be based upon the Java Logging API (the default), the Logging Bridge is made available as a java.util.logging.Handler object.

• If WebLogic Server is configured to be based upon a Log4j implementation, the Logging Bridge is made available as a org.apache.log4j.Appender object.

• If the ServerLoggingBridgeUseParentLoggersEnabled is disabled, applications that use either the Java Logging API or Log4j have their log messages redirected by the Logging Bridge to the WebLogic Server log.

• If the ServerLoggingBridgeUseParentLoggersEnabled is enabled, applications that use the Java Logging API have their log messages propagated to the parent node in the global Java Logging Logger tree.

• If the ServerLoggingBridgeUseParentLoggersEnabled is enabled, applications that use Log4j have their log messages propagated to the parent node in the Log4j Logger tree.

Deprecated. 12.1.3.0

StdoutFormat

The output format to use when logging to the console.

StdoutLogStack

Specifies whether to dump stack traces to the console when included in logged message.

StdoutSeverity

The minimum severity of log messages going to the standard out. Messages with a lower severity than the specified value will not be published to standard out.

Tags

Return all tags on this Configuration MBean

Type

Returns the type of the MBean.

Operations

This section describes the following operations:

addTag

Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.

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

getInheritedProperties

Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

isInherited

Check if the value of a property is inherited from template mbean or not.

isSet

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

removeTag

Remove a tag from this Configuration MBean

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.