10 Managing Log Files and Diagnostic Data

10.3.1.1 Searching Log Files Using Fusion Middleware Control

You can search for diagnostic messages using standard and supplemental ODL attributes using the Log Messages page of Fusion Middleware Control. By default, this page shows a summary of the logged issues for the last hour.

You can modify the search criteria to identify messages of relevance. You can view the search results in different modes, allowing ease of navigation through large amounts of data.

The following sections describe how to search log files:

• Searching Log Files: Basic Searches

• Searching Log Files: Advanced Searches

10.3.1.2 Searching Log Files Using the Command Line

You can search the log files using the WLST displayLogs command. You can narrow your search by specifying criteria, such as time, component ID, message type, or ECID.

To search for error messages generated in the last 5 minutes, for the Oracle HTTP Server ohs1, use the following command:

displayLogs(target='opmn:asinst_1/ohs1', last=5)

To search for error messages generated in the last 10 minutes for the Managed Server soa_server1, use the following command:

displayLogs(oracleInstance='/scratch/oracle1/Oracle/Middleware/user_projects/domains/soa_domain', target='soa_server1', last=10)

You can narrow your search by using the query parameter and specifying criteria, such as component ID, message type, or ECID. In the query clause, you can specify a query expression with any of the attributes listed in Table 10-1. Some of the criteria you can use are:

• Types of messages. For example, to search for ERROR and INCIDENT_ERROR messages for the Managed Server soa_server1, use the following command:

  displayLogs(oracleInstance='/scratch/oracle1/Oracle/Middleware/user_projects/domains/soa_domain', target='soa_server1',
            query='MSG_TYPE eq ERROR or MSG_TYPE eq INCIDENT_ERROR')
  

• A particular ECID. For example, to search for error messages with a particular ECID (140.87.134.52:13934:1186078666446:0) for the Managed Server soa_server1, use the following command:

  displayLogs(oracleInstance='/scratch/oracle1/Oracle/Middleware/user_projects/domains/soa_domain', target='soa_server1',
           query='ecid eq 140.87.134.52:13934:1186078666446:0')
  

• Component type. For example, to search for messages from Oracle HTTP Server instances, use the following query:

  displayLogs(query='COMPONENT_ID eq ohs')
  

• Range of time. To search for error messages that occurred within a specified range of time, you specify the attribute TSTZ_ORIGINATING with both from and to operators, using the following format:

  displayLogs(query='TSTZ_ORIGINATING from start_time and 
                   TSTZ_ORIGINATING to end_time')
  

  You specify the date using the following ISO 8601 time format:

  2007-09-30T12:00:00:0000-08:00
  

  For example, to display the error message from between 8:00 a.m. and 11 a.m. on April 17, 2009, use the following command:

  displayLogs(query='TSTZ_ORIGINATING from 2009-04-17T08:00:00-07:00 
              and TSTZ_ORIGINATING to 2009-04-17T11:00:00-07:00')
  

To display a count of messages, grouped by specific attributes, use the groupBy parameter to the WLST command displayLogs. For example, to display the count of WARNING messages by component, use the following command:

displayLogs(groupBy=['COMPONENT_ID'], query='MSG_TYPE eq WARNING')

10.3.2.1 Viewing Log Files and Their Messages Using Fusion Middleware Control

You can view the messages for all of the entities in a domain, an Oracle WebLogic Server, a component, or an application.

For example, to view the log files and their messages for a Managed Server:

1. From the navigation pane, expand the farm, then WebLogic Domain, and then the domain. Right-click the Managed Server name and choose Logs, then View Log Messages.

   The Log Messages page displays the log files for the Managed Server and any applications running in that server.

2. Expand Selected Targets and in the row for a particular component or application, click the Target Log Files icon.

   The View Log Files page is displayed. On this page, you can see a list of log files related to the Managed Server, as shown in the following figure:

   
   Description of the illustration viewlog.gif
   
   

3. Select a file and click View Log File.

   The View Log Files page is displayed. On this page, you can view the list of messages.

4. To view the details of a message, select the message.

   The details are displayed in the pane below the listing, as shown in the following figure:

   
   Description of the illustration viewlog2.gif
   
   

   By default, the messages are sorted by time, in ascending order. You can sort the messages by the columns Time, Message Type, or Message ID by clicking the column name.

5. To view messages that are related by time or ECID, click View Related Messages and select by Time or by ECID (Execution Context ID).

   The Related Messages page is displayed.

10.3.2.2 Viewing Log Files and Their Messages Using the Command Line

You can list the log files for an Oracle WebLogic Server domain, server, an Oracle instance, or component using the WLST listLogs command.

You can use this command while connected or disconnected. While connected, the default target is the Oracle WebLogic Server domain.

To list the log files, first use the domainRuntime command as described in Section 10.3. The following describes how to list and view log files:

• To list all of the log files for the Oracle WebLogic Server soa_server1, use the following command:

  wls:/soa_domain/domainRuntime> listLogs(target='server_soa')
  file://dadvmn0623/scratch/oracle1/Oracle/Middleware/user_projects/domains/SOA_domain/servers/soa_server1/logs/soa_server1.log
  2009-03-17 16:40:45                    4.9M soa_server1.log00001
  2009-03-17 18:35:35                    4.9M soa_server1.log00002
  2009-03-17 20:30:25                    4.9M soa_server1.log00003
  ...
  file://dadvmn0623/scratch/oracle1/Oracle/Middleware/user_projects/domains/SOA_domain/servers/soa_server1/logs/soa_server1-diagnostic.log
  2009-03-22 13:53:32                     10M soa_server1-diagnostic-22.log
  2009-03-22 19:18:32                     10M soa_server1-diagnostic-23.log
  2009-03-23 00:42:32                     10M soa_server1-diagnostic-24.log
  2009-03-23 06:07:32                     10M soa_server1-diagnostic-25.log
  2009-03-23 11:31:32                     10M soa_server1-diagnostic-26.log
  2009-03-23 16:56:32                     10M soa_server1-diagnostic-27.log
  2009-03-23 22:20:32                     10M soa_server1-diagnostic-28.log
  2009-03-24 03:45:32                     10M soa_server1-diagnostic-29.log
  2009-03-24 09:11:32                     10M soa_server1-diagnostic-30.log
  2009-03-24 14:08:32                    9.2M soa_server1-diagnostic.log
  ...
  

• To list the logs for the Oracle HTTP Server ohs1 in the Oracle instance asinst_1, use the following command:

  listLogs(target='opmn:asinst_1/ohs1')
  

• To list the logs while disconnected, you must specify the oracleInstance parameter, passing it either the Oracle WebLogic Server domain or the Oracle instance home for the system component. For example, to list the log files for the Managed Server soa_server1:

  listLogs(oracleInstance='/scratch/Oracle/Middleware/user_projects/domains/SOA_domain',
             target='soa_server1')
  

• To view the diagnostic messages in log files, use the WLST displayLogs command. This command works when you are either connected or disconnected.

  For example, to view the messages generated in the last 10 minutes in the log files for the Oracle WebLogic Server domain, use the following command:

  displayLogs(last=10)
  [2009-05-05T08:05:29.652-07:00] [soa_server1] [NOTIFICATION] [BEA-000628]
   [Common] [host: dadvmn0623] [nwaddr: 10.229.149.27] [tid:
   [ACTIVE].ExecuteThread: '10' for queue: 'weblogic.kernel.Default
   (self-tuning)'] [userId: <WLS Kernel>] [TARGET: /SOA_domain/soa_server1]
   [LOG_FILE: /scratch//Oracle/Middleware/user_projects/domains/SOA_
  domain/servers/soa_server1/logs/soa_server1.log] Created "1" resources for
   pool "SOADataSource", out of which "1" are available and "0" are unavailable.
  [2009-05-05T08:05:29.673-07:00] [soa_server1] [NOTIFICATION] [BEA-000628]
   [Common] [host: dadvmn0623] [nwaddr: 10.229.149.27] [tid: oracle.integration.platform.blocks.executor.WorkManagerExecutor$1@17f5105]
   [userId: <anonymous>] [TARGET: /SOA_domain/soa_server1] [LOG_FILE:
   /scratch/Oracle/Middleware/user_projects/domains/SOA
  _domain/servers/soa_server1/logs/soa_server1.log] Created "1" resources for
   pool "SOADataSource", out of which "1" are available and "0" are unavailable.
  [2009-05-05T08:05:30.448-07:00] [soa_server1] [NOTIFICATION] [BEA-001128]
   [JDBC] [host: dadvmn0623] [nwaddr: 10.229.149.27] [tid:
   oracle.integration.platform.blocks.executor.WorkManagerExecutor$1@17f5105]
   [userId: <anonymous>] [TARGET: /SOA_domain/soa_server1] [LOG_FILE:
   /scratch/Oracle/Middleware/user_projects/domains/SOA
  _domain/servers/soa_server1/logs/soa_server1.log] Connection for pool
   "SOADataSource" closed.
  

  The previous command returns the messages sorted by time, in ascending order.

• To display the log files for the Oracle HTTP Server ohs1 in the Oracle instance asinst_1, use the following command:

  displayLogs(target='opmn:asinst_1/ohs1')
   
  

You can search the messages by specifying particular criteria and sort the output, as described in Section 10.3.1.

See Also:

"Logging Custom WLST Commands" in the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference for more information about the listLogs and displayLogs commands

10.3.3.1 Downloading Log Files Using Fusion Middleware Control

You can download the log messages to a file, either the matching messages from a search or the messages in a particular log file.

To download the matching messages from a search to a file using Fusion Middleware Control:

1. From the navigation pane, select target, such as the domain.

2. From the dynamic target menu, choose Logs, then View Log Messages.

   The Log Messages page is displayed.

3. Search for particular types of messages as described in Section 10.3.1.1.

4. Select a file type by clicking Export Messages to File and select one of the following

   • As Oracle Diagnostic Log Text (.txt)

   • As Oracle Diagnostic Log Text (.xml)

   • As Comma-Separated List (.csv)

   An Opening dialog box is displayed.

5. Select either Open With or Save to Disk. Click OK.

To export specific types of messages or messages with a particular Message ID to a file:

1. From the navigation pane, expand the farm, then WebLogic Domain, and then domain. Select a Managed Server.

2. From the dynamic target menu, choose Logs, then View Log Messages.

   The Log Messages page is displayed.

3. Search for particular types of messages as described in Section 10.3.1.1.

4. For Show, select Group by Message Type or Group by Message ID.

5. To download the messages into a file, if you selected Group by Message Type, select the link in one of the columns that lists the number of messages, such as the Errors column. If you selected Group by Message ID, select one of the links in the Occurrences column.

   The Messages by Message Type page or Message by Message ID is displayed.

6. Select a file type by clicking the arrow near Export All to File.

   You can select one of the following:

   • As Oracle Diagnostic Log Text (.txt)

   • As Oracle Diagnostic Log Text (.xml)

   • As Comma-Separated List (.csv)

   An Opening dialog box is displayed.

7. Either select Open With or Save to Disk. Click OK.

To download the log files for a specific component using Fusion Middleware Control:

1. From the navigation pane, expand the farm. For system components, expand the installation type, such as Web Tier and select the component. For Java components, expand the farm, then the component type, and then select the component.

2. From the dynamic target menu, choose Logs, then View Log Messages.

   The Log Messages page is displayed.

3. In the Log Files column, click a log file.

   The Log Files page is displayed. On this page, you can see a list of log files related to the component or application.

4. Select a log file and click Download.

5. An Opening dialog box is displayed.

6. Select either Open With or Save to Disk. Click OK.

10.3.3.2 Downloading Log Files Using the Command Line

You can download log files using the WLST displayLogs command and redirecting the output to a file. For example:

displayLogs(type=['ERROR','INCIDENT_ERROR'], export='download_log.txt')

The messages are written to the file download_log.txt.

10.4.1.1 Changing Log File Locations Using Fusion Middleware Control

To change the location of a component's log file using Fusion Middleware Control, navigate to the component's home page and choose Logs, then Log Configuration from the dynamic target menu.

For example, to change the name and location of a component log file using Fusion Middleware Control:

1. From the navigation pane, select the component.

2. From the dynamic target menu, choose Logs, then Log Configuration.

   The Log Configuration page is displayed.

3. Select the Log Files tab.

4. In the table, select the logger and click Edit Configuration.

   The Edit Log File dialog box is displayed, as shown in the following figure:

   
   Description of the illustration logedit3.gif
   
   

5. For Log Path, enter a new path.

6. Click OK.

7. In the confirmation window, click Close.

10.4.1.2 Changing Log File Locations Using WLST

To change the log file location using WLST, use the configureLogHandler command. For example, to change the path of the logger named odl-handler, use the following command:

configureLogHandler(name='odl-handler', path='/scratch/Oracle/logs')

10.4.2.1 Specifying Size-Based or Time-Based Rotation Using Fusion Middleware Control

To configure log file rotation using Fusion Middleware Control for a component:

1. From the navigation pane, select the component.

2. From the dynamic target menu, choose Logs, then Log Configuration.

   The Log Configuration page is displayed.

3. Select the Log Files tab.

4. In the table, select the logger and click Edit Configuration.

   The Edit Log File dialog box is displayed.

5. In the Rotation Policy section, you can select one of the following:

   • Size Based: If you select this, enter the following:

     • For Maximum Log File Size, enter the size in MB, for example, 15.

     • For Maximum Size of All Log Files, enter the size in MB, for example, 150.

   • Time Based: If you select this, enter the following:

     • For Start Time, enter the date when you want the rotation to start. For example, enter 10-APR-2009.

     • For Frequency, you can select Minutes and enter the number of minutes, or you can select Hourly, Daily, or Weekly.

     • For Retention Period, you can specify how long the log files are kept. You can select Minutes and enter the number of minutes, or you can specify Day, Week, Month, or Year.

       Specifying a shorter period means that you use less disk space, but are not able to retrieve older information.

6. Click OK.

7. In the confirmation window, click Close.

10.4.2.2 Specifying Size-Based or Time-Based Rotation Using the Command Line

To specify log file rotation using WLST, use the configureLogHandler command. You can specify size-based rotation or time-based rotation.

For example, to specify that the log files rotate daily and that they are retained for a week, use the following command:

configureLogHandler(name='odl-handler', rotationFrequency='daily', retentionPeriod='week')

To specify that the size of a log file does not exceed 5MB and rotates when it reaches that size, use the following command:

configureLogHandler(name='odl-handler', maxFileSize='5M')

10.4.3.1 Configuring Message Levels Using Fusion Middleware Control

You can set the message level for a particular log file or for loggers.

To set the message level for a component log file:

1. From the navigation pane, select the component.

2. From the dynamic target menu, choose Logs, then Log Configuration.

   The Log Configuration page is displayed.

3. Select the Log Files tab.

4. In the table, select the log file and click Edit Configuration.

   The Edit Log File dialog box is displayed, as shown in the following figure:

   
   Description of the illustration logedit.gif
   
   

5. For Log Level, select the logging level. For example, select WARNING:1 (WARNING).

6. Click OK.

7. In the confirmation window, click Close.

To set the message level for one or more loggers for a component:

1. From the navigation pane, select the component.

2. From the dynamic target menu, choose Logs, then Log Configuration.

   The Log Configuration page is displayed.

3. Select the Log Levels tab.

4. For View, select Runtime Loggers or Loggers with Persistent Log Level State.

   Run-time loggers are loggers that are currently active. Persistent loggers are loggers that are saved in a configuration file and log levels of these loggers are persistent across component restarts. A run-time logger can also be a persistent logger, but not all run-time loggers are persistent loggers.

5. In the table, to specify the same level for all loggers, select the logging level for Root Logger for run-time loggers or oracle for persistent loggers. Then, for the child loggers, specify Inherit from Parent. For most situations, that is sufficient.

   However, if you need to specify the level for a particular logger, expand Root Logger or oracle, then, for the logger that you want to modify, select the logging level. For example, for the logger oracle.wsm.management.logging, select WARNING:1 (WARNING).

6. Click Apply.

10.4.3.2 Configuring Message Levels Using WLST

To set the message level with WLST, you use the setLoglevel command. To get the current message level, you use the getLogLevel command. You must be connected to WebLogic Server before you use the configuration commands.

You can view the log level for a logger for an Oracle WebLogic Server. For example, to view the log level of the Oracle WebLogic Server soa_server1, use the following command:

 getLogLevel(logger='oracle',  target='soa_server1')
NOTIFICATION:1

You can set the log level for a particular logger. The following example sets the message type to WARNING for the logger oracle.soa:

setLogLevel(target='soa_server1', logger='oracle.soa', level='WARNING')

To get a list of loggers for the Oracle WebLogic Server soa_server1, use the listLoggers command:

listLoggers(target='soa_server1')
.
.
.
oracle.soa                               |  WARNING:1
oracle.soa.adapter                       | <Inherited>
orac                                     | <Inherited>
oracle.soa.b2b.apptransport              | <Inherited>
oracle.soa.b2b.engine                    | <Inherited>
oracle.soa.b2b.repository                | <Inherited>
oracle.soa.b2b.transport                 | <Inherited>
oracle.soa.b2b.ui                        | <Inherited>
.
.
.

You can also filter logger names using the pattern parameter and a regular expression. For example, to return all loggers that begin with oracle in the Oracle WebLogic Server soa_server1, use the following command:

listLoggers(target='soa_server1', pattern='oracle.*')
oracle                                   | NOTIFICATION:1
oracle.adapter                           | <Inherited>
oracle.adapter.jms.logger                | <Inherited>
oracle.adf                               | <Inherited>

10.4.4.1 Specifying the Log File Format Using Fusion Middleware Control

To change the format using Fusion Middleware Control:

1. From the navigation pane, select the component.

2. From the dynamic target menu, choose Logs, then Log Configuration.

   The Log Configuration page is displayed.

3. Select the Log Files tab.

4. In the table, select the log file and click Edit Configuration.

   The Edit Log File dialog box is displayed.

5. For Log File Format, select Oracle Diagnostics Logging - XML.

6. Click OK.

7. In the confirmation window, click Close.

10.4.4.2 Specifying the Log File Format Using WLST

To specify the log file format using WLST, you use the use the configureLogHandler command. You use the format parameter and specify either ODL-Text or ODL-XML. ODL-Text is the default.

For example, to specify ODL XML format, use the following command:

configureLogHandler(name='odl-handler', format='ODL-XML'))

10.4.5.1 Specifying the Log File Encoding Using WLST

To specify the log file encoding using WLST, use the configureLogHandler command. You can use the encoding parameter to specify the character set encoding. JVM default encoding is the default.

For example, to specify UTF-8, use the following command:

configureLogHandler(name="odl-handler", encoding="UTF-8")

10.4.5.2 Specifying the Log File Encoding in logging.xml

To specify the log file encoding in the logging.xml file, use an optional encoding property. You can specify the encoding property to specify the character set encoding. JVM default encoding is the default.

For example, to specify UTF-8, add the following encoding property in the log_handler element:

<property name='encoding' value='UTF-8'/>