LogMBean (Java API Reference for Oracle WebLogic Server)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-02

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.management.configuration
Interface LogMBean

All Superinterfaces:: CommonLogMBean, ConfigurationMBean, DescriptorBean, DynamicMBean, LogFileMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

public interface LogMBean
extends CommonLogMBean
extends CommonLogMBean

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.

Field Summary

Fields inherited from interface weblogic.management.configuration.CommonLogMBean
`STDOUT_NOID, STDOUT_STANDARD`

Fields inherited from interface weblogic.management.configuration.LogFileMBean
`DEFAULT_FILE_NAME, MAX_ROTATED_FILES, NONE, SIZE, TIME, TIME_FORMAT`

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
`DEFAULT_EMPTY_BYTE_ARRAY`

Method Summary
`int`	`getDomainLogBroadcasterBufferSize()` Broadcasts log messages to the domain log in batch mode.
`LogFilterMBean`	`getDomainLogBroadcastFilter()` The filter configuration for log events being sent to the domain log.
`String`	`getDomainLogBroadcastSeverity()` The minimum severity of log messages going to the domain log from this server's log broadcaster.
`LogFilterMBean`	`getLogFileFilter()` The filter configuration for the server log file.
`LogFilterMBean`	`getMemoryBufferFilter()` The filter configuration for messages that are stored in the log memory buffer.
`String`	`getMemoryBufferSeverity()` The minimum severity of log messages going to the memory buffer of recent log events.
`int`	`getMemoryBufferSize()` The size of the memory buffer that holds the last n log records.
`LogFilterMBean`	`getStdoutFilter()` The filter configuration for log events being sent to the standard out.
`boolean`	`isLog4jLoggingEnabled()` Specifies whether the server logging is based on a Log4j implementation.
`boolean`	`isRedirectStderrToServerLogEnabled()` Specifies whether the stderr of the JVM in which a WebLogic Server instance runs is redirected to the WebLogic Logging system.
`boolean`	`isRedirectStdoutToServerLogEnabled()` Specifies whether the stdout of the JVM in which a WebLogic Server instance runs is redirected to the WebLogic logging system.
`boolean`	`isServerLoggingBridgeUseParentLoggersEnabled()` 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.
`void`	`setDomainLogBroadcasterBufferSize(int bufferSize)` Sets the size of the log message buffer for broadcasting to the domain log.
`void`	`setDomainLogBroadcastFilter(LogFilterMBean filter)` Sets the filtering criteria for log events going to the domain log.
`void`	`setDomainLogBroadcastSeverity(String severity)`
`void`	`setLog4jLoggingEnabled(boolean enableLog4j)` Sets the value of the Log4jLoggingEnabled attribute.
`void`	`setLogFileFilter(LogFilterMBean filter)` Sets the value of the LogFileFilter attribute.
`void`	`setMemoryBufferFilter(LogFilterMBean filter)`
`void`	`setMemoryBufferSeverity(String severity)`
`void`	`setMemoryBufferSize(int size)`
`void`	`setRedirectStderrToServerLogEnabled(boolean captureStderr)`
`void`	`setRedirectStdoutToServerLogEnabled(boolean captureStdout)`
`void`	`setServerLoggingBridgeUseParentLoggersEnabled(boolean value)`
`void`	`setStdoutFilter(LogFilterMBean filter)` Sets the value of the StdoutFilter attribute.

Methods inherited from interface weblogic.management.configuration.CommonLogMBean
`getLogFileSeverity, getLoggerSeverity, getLoggerSeverityProperties, getStdoutFormat, getStdoutSeverity, isStdoutLogStack, setLogFileSeverity, setLoggerSeverity, setLoggerSeverityProperties, setStdoutFormat, setStdoutLogStack, setStdoutSeverity`

Methods inherited from interface weblogic.management.configuration.LogFileMBean
`getBufferSizeKB, getDateFormatPattern, getFileCount, getFileMinSize, getFileName, getFileTimeSpan, getLogFileRotationDir, getRotateLogOnStartup, getRotationTime, getRotationType, isNumberOfFilesLimited, setBufferSizeKB, setDateFormatPattern, setFileCount, setFileMinSize, setFileName, setFileTimeSpan, setFileTimeSpanFactor, setLogFileRotationDir, setNumberOfFilesLimited, setRotateLogOnStartup, setRotationTime, setRotationType`

Methods inherited from interface weblogic.management.configuration.LogFileMBean

getBufferSizeKB, getDateFormatPattern, getFileCount, getFileMinSize, getFileName, getFileTimeSpan, getLogFileRotationDir, getRotateLogOnStartup, getRotationTime, getRotationType, isNumberOfFilesLimited, setBufferSizeKB, setDateFormatPattern, setFileCount, setFileMinSize, setFileName, setFileTimeSpan, setFileTimeSpanFactor, setLogFileRotationDir, setNumberOfFilesLimited, setRotateLogOnStartup, setRotationTime, setRotationType

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
`freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet`

Methods inherited from interface weblogic.management.WebLogicMBean
`getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent`

Methods inherited from interface javax.management.DynamicMBean
`getAttribute, getAttributes, invoke, setAttribute, setAttributes`

Methods inherited from interface javax.management.MBeanRegistration
`postDeregister, postRegister, preDeregister, preRegister`

Methods inherited from interface javax.management.NotificationBroadcaster
`addNotificationListener, getNotificationInfo, removeNotificationListener`

Methods inherited from interface weblogic.descriptor.DescriptorBean
`addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener`

Method Detail

getLogFileFilter

LogFilterMBean getLogFileFilter()

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.

Returns:: The LogFilterMBean configuration for the log file.

setLogFileFilter

void setLogFileFilter(LogFilterMBean filter)

Sets the value of the LogFileFilter attribute.

Parameters:: filter - The filter configuration for filtering messages being written to the log file.
See Also:: LogMBean.getLogFileFilter()

getStdoutFilter

LogFilterMBean getStdoutFilter()

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

Returns:: The LogFilterMBean configuration for stdout.

setStdoutFilter

void setStdoutFilter(LogFilterMBean filter)

Sets the value of the StdoutFilter attribute.

Parameters:: filter - The filter configuration for filtering messages being written to the stdout.
See Also:: LogMBean.getStdoutFilter()

getDomainLogBroadcastSeverity

String getDomainLogBroadcastSeverity()

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.

Default Value:: weblogic.logging.Severities.NOTICE_TEXT
Valid Values:: weblogic.logging.Severities.DEBUG_TEXT, weblogic.logging.Severities.INFO_TEXT, weblogic.logging.Severities.WARNING_TEXT, weblogic.logging.Severities.ERROR_TEXT, weblogic.logging.Severities.NOTICE_TEXT, weblogic.logging.Severities.CRITICAL_TEXT, weblogic.logging.Severities.ALERT_TEXT, weblogic.logging.Severities.EMERGENCY_TEXT, weblogic.logging.Severities.OFF_TEXT

setDomainLogBroadcastSeverity

void setDomainLogBroadcastSeverity(String severity)

getDomainLogBroadcastFilter

LogFilterMBean getDomainLogBroadcastFilter()

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

Returns:: The LogFilterMBean configuration for broadcast to the domain log.

setDomainLogBroadcastFilter

void setDomainLogBroadcastFilter(LogFilterMBean filter)

Sets the filtering criteria for log events going to the domain log.

Parameters:: filter - The filter configuration for filtering messages being broadcast to the domain log.

getMemoryBufferSeverity

String getMemoryBufferSeverity()

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.

Default Value:: weblogic.logging.Severities.TRACE_TEXT
Valid Values:: weblogic.logging.Severities.TRACE_TEXT, weblogic.logging.Severities.DEBUG_TEXT, weblogic.logging.Severities.INFO_TEXT, weblogic.logging.Severities.WARNING_TEXT, weblogic.logging.Severities.ERROR_TEXT, weblogic.logging.Severities.NOTICE_TEXT, weblogic.logging.Severities.CRITICAL_TEXT, weblogic.logging.Severities.ALERT_TEXT, weblogic.logging.Severities.EMERGENCY_TEXT, weblogic.logging.Severities.OFF_TEXT

setMemoryBufferSeverity

void setMemoryBufferSeverity(String severity)

getMemoryBufferFilter

LogFilterMBean getMemoryBufferFilter()

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

setMemoryBufferFilter

void setMemoryBufferFilter(LogFilterMBean filter)

getMemoryBufferSize

int getMemoryBufferSize()

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.

Default Value:: LogMBean.DEV_MODE_MEMORY_BUFFER_SIZE
Maximum Value:: 5000
Minimum Value:: 10
Default value in production mode:: LogMBean.PROD_MODE_MEMORY_BUFFER_SIZE

setMemoryBufferSize

void setMemoryBufferSize(int size)

isLog4jLoggingEnabled

boolean isLog4jLoggingEnabled()

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.

Default Value:: false

setLog4jLoggingEnabled

void setLog4jLoggingEnabled(boolean enableLog4j)

Sets the value of the Log4jLoggingEnabled attribute.

See Also:: LogMBean.isLog4jLoggingEnabled()

isRedirectStdoutToServerLogEnabled

boolean isRedirectStdoutToServerLogEnabled()

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.

setRedirectStdoutToServerLogEnabled

void setRedirectStdoutToServerLogEnabled(boolean captureStdout)

isRedirectStderrToServerLogEnabled

boolean isRedirectStderrToServerLogEnabled()

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.

setRedirectStderrToServerLogEnabled

void setRedirectStderrToServerLogEnabled(boolean captureStderr)

getDomainLogBroadcasterBufferSize

int getDomainLogBroadcasterBufferSize()

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.

Default Value:: 1
Maximum Value:: 100
Minimum Value:: 1
Default value in production mode:: 10

setDomainLogBroadcasterBufferSize

void setDomainLogBroadcasterBufferSize(int bufferSize)

Sets the size of the log message buffer for broadcasting to the domain log.

Parameters:: bufferSize -

isServerLoggingBridgeUseParentLoggersEnabled

boolean isServerLoggingBridgeUseParentLoggersEnabled()

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.

Default Value:: false

setServerLoggingBridgeUseParentLoggersEnabled

void setServerLoggingBridgeUseParentLoggersEnabled(boolean value)