Use the logging commands to configure settings for log files and to view and search log files. Table 8-1 describes the different categories of logging commands.
For additional details about configuring and searching log files, see the chapter "Managing Log Files and Diagnostic Data" in the Oracle Fusion Middleware Administrator's Guide.
Note:
To use these commands, you must invoke WLST from the Oracle home in which the component has been installed. See "Using Custom WLST Commands" in the Oracle Fusion Middleware Administrator's Guide.Table 8-1 Logging Command Categories
Command category | Description |
---|---|
Configure settings for log files, such as the level of information written to the file or the maximum file size. |
|
View Oracle Fusion Middleware log files and search log files for particular messages. |
Use the commands in Table 8-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 8-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
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.
configureLogHandler(options)
Argument | Definition |
---|---|
options
|
Comma-separated list of options, specified as name-value pairs. Valid options include:
|
options (continued)
|
|
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 and maxLogSize:
configureLogHandler(name="odl-handler", rotationFrequency="daily", retentionPeriod="week", removeProperty=['maxFileSize','maxLogSize'])
Command Category: Log Configuration
Use with WLST: Online
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.
getLogLevel(options)
Argument | Definition |
---|---|
options
|
Comma-separated list of options, specified as name-value pairs. Valid options include:
|
The following example returns the level for the logger oracle:
getLogLevel(logger='oracle')
The following example returns the level for the logger oracle, specifying only config loggers:
getLogLevel(logger='oracle', runtime=0)
The following example returns the level for the logger oracle on the Oracle WebLogic Server server2:
getLogLevel(logger='oracle', target='server2')
Command Category: Log Configuration
Use with WLST: Online
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.
listLoggers([options])
Argument | Definition |
---|---|
options |
An optional comma-separated list of options, specified as name-value pairs. Valid options include:
|
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
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.
listLogHandlers([options])
Argument | Definition |
---|---|
options |
An optional comma-separated list of options, specified as name-value pairs. Valid options include:
|
Command Category: Log Configuration
Use with WLST: Online
setLogLevel(options)
Argument | Definition |
---|---|
options |
Comma-separated list of options, specified as name-value pairs. Valid options include:
|
The following example sets the log level to NOTIFICATION:1 for the logger oracle.my.logger:
setLogLevel(logger="oracle.my.logger", level="NOTICATION: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)
Use the commands in Table 8-3 to view Oracle Fusion Middleware log files and to search log files for particular messages.
Table 8-3 Search and Display Commands
Use this command... | To... | Use with WLST... |
---|---|---|
List the logs for one or more components. |
Online or Offline |
|
Search and display the contents of log files. |
Online or Offline |
Command Category: Search and Display
Use with WLST: Online or Offline
Search and display the contents of diagnostic log files. The command returns a value only when the returnData option is set to true. By default it will not return any data. The return value depends on the option used.
displayLogs([searchString,][options])
Argument | Definition |
---|---|
searchString |
An optional search string. Only messages that contain the given string (case-insensitive) will be returned.
Note that the displayLogs command can read logs in multiple formats and it converts the messages to ODL format. The search will be performed in the native format, if possible. Otherwise, it may be performed in the message contents, and it may exclude mark-up. Therefore you should avoid using mark-up characters in the search string. |
options |
An optional comma-separated list of options, specified as name-value pairs. Valid options include:
|
options, continued |
|
options (continued) |
|
The following example displays the last 100 messages from all log files in the domain:.
displayLogs(tail=100)
The following example displays all messages logged in the last 15 minutes:
displayLogs(last='15m')
The following example displays log messages that contain a given string:
displayLogs('Exception')
The following example displays log messages that contain a given ECID:
displayLogs(ecid='0000Hl9TwKUCslT6uBi8UH18lkWX000002')
The following example displays log messages of type ERROR or INCIDENT_ERROR:
displayLogs(type=['ERROR','INCIDENT_ERROR'])
The following example displays log messages for a given Java EE application:
displayLogs(app="myApplication")
The following example displays messages for an OPMN-managed component:
displayLogs(target="opmn:instance1/ohs1")
The following example displays a message summary by component and type:
displayLogs(groupBy=['COMPONENT_ID', 'MSG_TYPE'])
The following example displays messages for a particular time interval:
displayLogs(query="TIME from 11:15 and TIME to 11:20")
The following example shows an advanced query:
displayLogs(query="TIME from 11:15 and TIME to 11:20 and ( MSG_TEXT contains exception or SUPPL_DETAIL contains exception )")
A similar query could be written as:
displayLogs("exception", query="TIME from 11:15 and TIME to 11:20")
Command Category: Search and Display
Use with WLST: Online or Offline
Lists log files for Oracle Fusion Middleware components. This command returns a PyArray with one element for each log. The elements of the array are javax.management.openmbean.CompositeData objects describing each log.
listLogs([options]
Argument | Definition |
---|---|
options |
An optional comma-separated list of options, specified as name-value pairs. Valid options include:
|
The following example lists all of the log files for the WebLogic domain:
listLogs()
The following example lists the log files for the WebLogic server server1:
listLogs(target="server1")
The following example lists the log files for the Oracle HTTP Server ohs1:
listLogs(target="opmn:instance1/ohs1")
The following example, used in disconnected mode, lists the log files for the WebLogic server server1:
listLogs(oracleInstance="/middleware/user_projects/domains/base_domain", target="server1")