Use the commands in Table 7-2 to configure settings for log files, such as the level of information written to the file or the maximum file size. In the Use with WLST column, online means the command can only be used when connected to a running server. Offline means the command can only be used when not connected to a running server. Online or offline means the command can be used in both situations.
Table 7-2 Logging Configuration Commands
| Use this command... | To... | Use with WLST... |
|---|---|---|
|
Configure an existing log handler, add a new handler, or remove existing handlers. |
Online |
|
|
Get the level for a given logger. |
Online |
|
|
Get the list of loggers and the level of each logger. |
Online |
|
|
List the configuration of one of more log handlers. |
Online |
|
|
Set the level for a given logger. |
Online |
Command Category: Log Configuration
Use with WLST: Online
Description
Configures an existing Java logging handler, adds a new handler, or removes an existing handler. It returns a java.util.List with one entry for each handler. Each entry is a javax.management.openmbean.CompositeData object describing the handler.
With this command, you can change the location of the log files, the frequency of the rotation of log files, and other log file properties.
Syntax
configureLogHandler([target,] name [, maxFileSize] [,maxLogSize] [, rotationFrequency] [, baseRotationTime] [, retentionPeriod] [, format] [, encoding] [, path] [, handlerType] [, propertyName] [, propertyValue] [, addProperty] [, removeProperty] [, addHandler] [, removeHandler] [, level] [, addToLogger] [, removeFromLogger] [, useParentHandlers] )
| Argument | Definition |
|---|---|
target |
Optional. The name of a WebLogic Server instance, or a string describing a system component. For system components, refer to the component's documentation for details. The default value is the server to which WLST is connected. |
name |
Required. The name of a log handler. |
maxFileSize |
Optional. The value of the maximum file size for an ODL handler. The value is a string representing a numeric value, optionally followed by a suffix indicating a size unit ( If you do not specify a suffix, the value is returned in bytes. Note that this option does not apply to the QuickTrace handler. |
maxLogSize |
Optional. The value of the maximum size of the log files for an ODL handler. The value is a string representing a numeric value, optionally followed by a suffix indicating a size unit ( Note that this option does not apply to the QuickTrace handler. |
rotationFrequency |
Optional. The value of the rotation frequency for an ODL handler. The value is a string representing a numeric value, optionally followed by a suffix indicating a time unit ( Note that this options does not apply to the QuickTrace handler. |
baseRotationTime |
Optional. The base rotation time, to be used with the rotationFrequency option. The value must be a string representing a date/time value. It can be a full date/time in ISO 8601 date/time format, or a short form including only hours and minutes. The default baseRotationTime is 00:00. Note that this option does not apply to the QuickTrace handler. |
retentionPeriod |
Optional. The amount of time that the log file is retained. The value must be a string representing a numeric value, optionally followed by a suffix indicating a time unit ( Note that this option does not apply to the QuickTrace handler. |
format |
Optional. The format for the ODL handler. Valid values are one of the following strings: "ODL-Text" or "ODL-XML". The default format is ODL-Text. |
encoding |
Optional. The character encoding for the log file. |
path |
Optional. The log file path. Note that this option does not apply to the QuickTrace handler. |
handlerType |
Optional. The name of the Java class that provides the handler implementation. It must be an instance of java.util.logging.Handler or oracle.core.ojdl.logging.HandlerFactory. |
propertyName |
Optional. The name of an advanced handler property to be added or updated. The property value is specified with the propertyValue option. See the documentation for the handler for valid properties. |
propertyValue |
Optional. The new value for the handler property defined by the propertyName option. |
addProperty |
Optional. A Jython boolean value. Used in conjunction with the propertyName and propertyValue options to define that a new property is to be added to the handler. |
removeProperty |
Optional. A list of one or more handler properties to be removed. |
addHandler |
Optional. A boolean value. If the value is true, then the named handler will be added. |
removeHandler |
Optional. A boolean value. If the value is true, then the named handler is removed. |
level |
Optional. A Java or ODL level value. The handler level will be set to the given level. |
addToLogger |
Optional. A list of logger names. The handler is added to the given logger names. |
removeFromLogger |
Optional. A list of logger names. The handler is removed from the given loggers. |
useParentHandlers |
Optional. A boolean value. Sets the useParentHandlers flag on the loggers defined by the addToLogger or removeFromLogger options. |
The following table lists the properties for the quicktrace-handler. This handler allows you to trace messages from specific loggers and store the messages in memory. For more information, see "Configuring QuickTrace" in Administering Oracle Fusion Middleware.
| QuickTrace Property | Description |
|---|---|
|
bufferSize |
The approximate size of the circular QuickTrace buffer, in which log records are stored in memory. Note that actual memory consumption may be less than, but not more than this value. |
|
enableDMSMetrics |
If specified as true, DMS metrics are enabled for the quicktrace-handler. The default is true. |
|
enableUserBuffer |
If specified as true, the handler maintains an individual buffer for each user specified in the reserveBufferUserID property. If the user is not defined in the reserveBufferUserID property, the messages are cached in the COMMON buffer. If specified as false, the handler maintains only one buffer, COMMON. The default is false. |
|
flushOnDump |
If specified as true, the buffer is flushed when you execute the executeDump command. The default is true. |
|
includeMessageArguments |
If specified as true, message arguments are included with the formatted log messages that have a message ID. The default is false. |
|
maxFieldLength |
The maximum length, in bytes, for each field in a message. The fields can include the message text, supplemental attributes, thread name, source class name, source method name, and message arguments. The default is 240 bytes. A small number can restrict the amount of information returned for a message. An excessively number can reduce the amount of log records in the buffer because each message uses more bytes. |
|
reserveBufferUserID |
A list of user IDs, separated by a comma. If enableUserBuffer is specified as true, any log messages related to the user are written to a separate buffer. |
|
supplementalAttributes |
A list of supplemental attribute names. The attributes are listed in the logging.xml file. Setting supplemental attributes requires additional memory or CPU time. |
|
useDefaultAttributes |
If specified as true, default attribute values are added to each log message. The default attributes are HOST_ID, HOST_NWADDR, and USER_ID. |
|
useLoggingContext |
If specified as true, the log message includes DMS logging context attributes. The default is false. If you enable this option, the trace requires additional CPU time. |
|
useRealThreadID |
If specified as true, the handler attempts to use the real thread ID instead of the thread ID that is provided by the jave.util.logging.logRecord. The default is false. If you enable this option, the trace requires additional CPU time. |
|
useThreadName |
If specified as true, the log message includes the thread name instead of the thread ID. The default is false. |
Examples
The following example specifies the maximum file size for the odl-handler:
configureLogHandler(name="odl-handler", maxFileSize="5M")
The following example specifies the rotation frequency for the odl-handler:
configureLogHandler(name="odl-handler", rotationFrequency="daily")
The following example specifies the rotation frequency and the retention period for the odl-handler. It also removes the properties maxFileSize:
configureLogHandler(name="odl-handler", rotationFrequency="daily", retentionPeriod="week", removeProperty='maxFileSize'])
The following example configures the quicktrace-handler, adding the logger oracle.adf.faces, and enabling user buffers for user1 and user2:
configureLogHandler(name="quicktrace-handler", addToLogger="oracle.adf.faces", propertyName="enableUserBuffer", propertyValue="true", propertyName="reserveBufferUserID", propertyValue="user1, user2")
The oracle.adf logger is associated with the handlers odl-handler, wls-domain, and console-handler. When you set the level of the logger, these handlers will use the same level (TRACE:1) for the logger oracle.adf. As a result, much information will be written to the log files, consuming resources. To avoid consuming resources, set the level of the handlers to a lower level, such as WARNING or INFORMATION. For example:
configureLogHandler(name="odl-handler", level="WARNING:1") configureLogHandler(name="wls-domain", level="WARNING:1") configureLogHandler(name="console-handler", level="WARNING:1")
Command Category: Log Configuration
Use with WLST: Online
Description
Returns the level of a given Java logger.
The returned value is a string with the logger's level, or None if the logger does not exist. An empty string indicates that the logger level is null.
Syntax
getLogLevel( [target,] logger [, runtime] )
| Argument | Definition |
|---|---|
target |
Optional. The name of a WebLogic Server instance, or a string describing a system component. For system components, refer to the component's documentation for details. The default value is the server to which WLST is connected. |
logger |
A logger name. An empty string denotes the root logger. This option is required and has no default. |
runtime |
Optional. A Jython boolean value (0 or 1) that determines if the operation is to list runtime loggers or config loggers. The default value is 1 (runtime). |
Examples
The following example returns the level for the logger oracle:
getLogLevel(logger='oracle')
NOTIFICATION:1
The following example returns the level for the logger oracle, specifying only config loggers, not runtime loggers:
getLogLevel(logger='oracle', runtime=0)
NOTIFICATION:1
The following example returns the level for the logger oracle on the Oracle WebLogic Server server2:
getLogLevel(logger='oracle', target='server2')
NOTIFICATION:1
Command Category: Log Configuration
Use with WLST: Online
Description
Lists Java loggers and their levels. The command returns a PyDictionary object where the keys are logger names and the associated values are the logger levels. An empty level is used to indicate that the logger does not have the level set.
Syntax
listLoggers([target] [, pattern] [,runtime])
| Argument | Definition |
|---|---|
target |
Optional. The name of a WebLogic Server instance, or a string describing a system component. For system components, refer to the component's documentation for details. The default value is the server to which WLST is connected. |
pattern |
Optional. The name of a WebLogic Server instance, or a string describing a system component. For system components, refer to the component's documentation for details. |
runtime |
Optional. A Jython boolean value (0 or 1) that determines if the operation is to list runtime loggers or config loggers. The default value is 1 (runtime). |
Examples
The following example lists all of the loggers:
listLoggers()
The following example lists all of the loggers that start with the name oracle.*.
listLoggers(pattern="oracle.*")
The following example list all config loggers:
listLoggers(runtime=0)
The following example list all loggers for the WebLogic Server server1:
listLoggers(target="server1")
Command Category: Log Configuration
Use with WLST: Online
Description
Lists Java log handlers configuration. This command returns a java.util.List with one entry for each handler. Each entry is a javax.management.openmbean.CompositeData object describing the handler.
Syntax
listLogHandlers([target] [, name])
| Argument | Definition |
|---|---|
target |
Optional. The name of a WebLogic Server instance, or a string describing a system component. For system components, refer to the component's documentation for details. The default value is the server to which WLST is connected. |
name |
Optional. The name of a log handler. If the name is not provided, then all handlers are listed. |
Examples
The following example lists all log handlers:
listLogHandlers()
The following example lists all log handlers named odl-handler:
listLogHandlers(name="odl-handler")
The following example lists all log handlers for the WebLogic Server server1:
listLogHandlers(target="server1")
Command Category: Log Configuration
Use with WLST: Online
Description
Sets the level of information written by a given Java logger to a log file.
Syntax
setLogLevel([target,] logger [, addlogger] , level [, runtime] [, persist] )
| Argument | Definition |
|---|---|
target |
Optional. The name of a WebLogic Server instance, or a string describing a system component. For system components, refer to the component's documentation for details. The default value is the server to which WLST is connected. |
logger |
A logger name. An empty string denotes the root logger. This option is required and has no default. The command throws an exception if the logger does not exist, unless the addLogger option is also used. |
addLogger |
Optional. A Jython boolean value (0 or 1) that determines if the logger should be created if it does not exist. This option is deprecated for runtime mode. Adding a runtime logger may have no effect because the logger may be garbage collected. If you need to set the level for a logger that has not yet been created, use the persist mode. |
level |
The level name. It can be either a Java level or an ODL level. Some valid Java levels are: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, OR FINEST. Valid ODL levels include a message type followed by a colon and a message level. The valid ODL message types are: INCIDENT_ERROR, ERROR, WARNING, NOTIFICATION, TRACE, and UNKNOWN. The message level is represented by an integer value that qualifies the message type. Possible values are from 1 (highest severity) through 32 (lowest severity). An empty string can be used to set the level to null (inherited from parent). This option is required; there is no default value. |
runtime |
Optional. A Jython boolean value (0 or 1) that determines if the operation is to list runtime loggers or config loggers. The default value is 1 (runtime). If the target is a system component that does not support changing runtime loggers, this option is ignored. Note: Because runtime loggers may be garbage collected, you should change the level of the runtime logger only if you know that the logger exists and that there is a strong reference to the logger. If the logger is garbage collected, any changes made to the logger level in runtime mode that are not persisted may be lost. |
persist |
Optional. A Jython boolean value (0 or 1) that determines if the level should be saved to the configuration file. A value of 0 specifies that the level will be saved; a value of 1 that it will not. The default value is 1. |
Examples
The following example sets the log level to NOTIFICATION:1 for the logger oracle.my.logger:
setLogLevel(logger="oracle.my.logger", level="NOTIFICATION:1")
The following example sets the log level to TRACE:1 for the logger oracle.my.logger and specifies that the level should be saved to the configuration file:
setLogLevel(logger="oracle.my.logger", level="TRACE:1", persist=0)
The following example sets the log level to WARNING for the config logger oracle.my.logger on the WebLogic Server server1:
setLogLevel(target="server1", logger="oracle.my.logger", level="WARNING", runtime=0)