24.3 Performance Analysis Tools

24.3.2.1 Viewing Log Files

You can view log files in any of the following ways:

• Using Oracle Enterprise Manager (recommended)

• Using WLST Commands

• Using the Command Line

.
<?xml version="1.0"?>
<!DOCTYPE LOG [
<!ENTITY log0 SYSTEM "log.xml">
]>
<LOG>
&log0;
</LOG>
.

Using Oracle Enterprise Manager

See Section 7.11.1, "Viewing and Searching Log Files" in Chapter 7, "Administering Oracle Reports Services Using Oracle Enterprise Manager".

Using WLST Commands

See Section 24.3.4, "Logging-Related WLST Commands".

Using the Command Line

From the command line, navigate to the following directories to open and view the log files:

• For Reports Server:

  ORACLE_INSTANCE/diagnostics/logs/ReportsServerComponent/<servername>
  

• For Oracle Reports Bridge:

  ORACLE_INSTANCE/diagnostics/logs/ReportsBridgeComponent/<bridgename>
  

  Note:

  The Reports Bridge component directory is not created by default. Instead, the directory is created when a Reports Bridge is created.

• For Reports Tools components(which includes rwrun, rwbuilder, rwclient):

  ORACLE_INSTANCEdiagnostics/logs/ReportsToolsComponent/ReportsTools
  

• For Oracle Reports Servlet (For Reports Application):

  $FMW_HOME/user_projects/domains/<domain_name>/servers/WLS_REPORTS/logs/reports
  

  Note:

  You must modify the logging.xml file to enable trace information for Reports components.

  For more information on the location of the logging.xml file, see Section 24.3.7, "Tracing Report Execution".

24.3.2.2 Managing Log Files

You can manage log files in Oracle Enterprise Manager, which provides capabilities such as:

• Specifying logging information.

• Searching inside log files based on various attributes of log entries.

• Viewing trend metrics; that is, how many errors of a particular type there are in log files (for example, 1 INCIDENT_ERROR, 20 ERROR, 35 WARNING, and so on).

For more information, see Section 7.18.1, "Specifying Logging Information" in Chapter 7, "Administering Oracle Reports Services Using Oracle Enterprise Manager".

24.3.2.3 Audit Log Files

Oracle Reports audits important events, such as the following:

• Success or failure of authentication and authorization for In-process Servers and standalone servers

• Success or failure of webcommands check based on user's role for Reports servlet

Configuring Audit Log Files

To configure audit logs, do the following:

• For J2EE application (In-process Server): Use Enterprise Manager to modify the audit log configuration files. For more information, see Section 7.12, "Modifying Reports Server Audit Configuration".

• For J2SE application (Standalone Servers): Edit the audit.filterPreset property in the $DOMAIN_HOME/config/fmwconfig/jps-config-jse.xml file as follows:

  <property name="audit.filterPreset" value="None"/>

  to

  <property name="audit.filterPreset" value="All"/>

Location of Audit Log Files

Oracle Reports audit log files are located at :

• For J2EE applications: $DOMAIN_HOME/servers/WLS_REPORTS/logs/auditlogs/ReportsServer/audit.log

• For J2SE components: $ORACLE_INSTANCE/auditlogs/ReportsServer/<ReportsServerComponent>/audit.log

Audit Log Example

Following is an example for audit log:

2008-09-10 13:15:32.263  - "CheckAuthorization" true "Authorization of user <username> passed for webcommand showjobs." - "0000HlCPYyE2VOJpMkH7ie18lwWx000001,0" - - - - "12" - - - - - - 
2008-09-10 13:15:25.247  - "UserLogin" true "Authentication of user <username>  passed." - "0000HlCPYyE2VOJpMkH7ie18lwWx000001,0" - - - - "12" - - - - - - 
2008-09-10 13:15:25.310  - "CheckAuthorization" true "Authorization of user <username>  passed for webcommand showjobs." - "0000HlCPYyE2VOJpMkH7ie18lwWx000001,0" - - - - "12" - - - - - - 
 
2008-09-10 13:15:32.263  - "CheckAuthorization" true "Authorization of user <username> failed  for webcommand showjobs." - "0000HlCPYyE2VOJpMkH7ie18lwWx000001,0" - - - - "12" - - - - - - 
2008-09-10 13:15:25.247  - "UserLogin" true "Authentication of user <username>  failed." - "0000HlCPYyE2VOJpMkH7ie18lwWx000001,0" - - - - "12" - - - - - - 
2008-09-10 13:15:25.310  - "CheckAuthorization" true "Authorization of user <username>  failed for webcommand showjobs." - "0000HlCPYyE2VOJpMkH7ie18lwWx000001,0" - - - - "12" - - - - - - 

24.3.3.1 Using WLST Commands for System Components

You can use the following WLST commands to run the Reports Components:

You can invoke the WLST shell by running the following command:

ORACLE_HOME/common/bin/wlst.sh
wls:/offline> connect("weblogic","weblogic", "hostname:7001")
wls:/domain2/serverConfig> domainRuntime()
wls:/domain2/domainRuntime> listLogs(target="opmn:cinst56/ReportsServer_hostname_cinst56")
file://hostname/scratch/rrpai/cinst56/diagnostics/logs/ReportsServerComponent/ReportsServer_hostname_cinst56/server_diagnostic.log
2008-10-27 02:59:47                    302K server_diagnostic.log
file://hostname/scratch/rrpai/cinst56/diagnostics/logs/ReportsServerComponent/ReportsServer_hostname_cinst56/rwEng-0_diagnostic.log
2008-10-27 02:59:13                    7.3K rwEng-0_diagnostic.log
 
wls:/domain2/domainRuntime> displayLogs(target="opmn:cinst56/ReportsServer_hostname_cinst56", tail=10)
 
[2008-10-27T02:31:52.133-07:00] [reports] [NOTIFICATION] [] [oracle.reports.server] [host: hostname] [nwaddr: 144.20.207.149] [tid: 10] [ecid: 0000HoxdIF14EwQRyaQ5T0191Oe7000001,0] ServerConfig:logConf  <server version="11.1.1.0.0" xmlns="http://xmlns.oracle.com/reports/server">[[
   
[2008-10-27T02:44:38.684-07:00] [reports] [INCIDENT_ERROR] [REP-50125] [oracle.reports.engine] [host: hostname] [nwaddr: 144.20.207.149] [pid: 18787] [tid: 10] [ecid: 0000HoxgDPr4EwQRyaQ5T00004_Z000000,0] [EngineName: rwEng-0] REP-50125 : org.omg.CORBA.COMM_FAILURE:   vmcid: SUN  minor code: 201  completed: No  [[
……
 
wls:/domain2/domainRuntime> displayLogs(target="opmn:cinst56/ReportsServer_hostname_cinst56", tail=10, query="MODULE_ID equals oracle.reports.server")
 
[2008-10-27T02:31:01.085-07:00] [reports] [NOTIFICATION] [] [oracle.reports.server] [host: hostname] [nwaddr: 144.20.207.149] [tid: 10] [ecid: 0000Hoxd5lP4EwQRyaQ5T0191OdK000001,0] ServerConfig:logConf  <server version="11.1.1.0.0" xmlns="http://xmlns.oracle.com/reports/server">[[
 
[2008-10-27T02:59:47.383-07:00] [reports] [NOTIFICATION] [] [oracle.reports.server] [host: hostname] [nwaddr: 144.20.207.149] [tid: 10] [ecid: 0000HoxjfEr4EwQRyaQ5T0191P4I000001,0] ServerConfig:logConf  Reading server config file
 
wls:/domain2/domainRuntime> exit()

24.3.3.2 Using WLST Commands for Java EE Components

You can use the following WLST commands to run the Reports Components:

You can invoke the WLST shell by running the following command:

ORACLE_HOME/common/bin/wlst.sh
wls:/offline> connect("weblogic","weblogic", "hostname:7001")
wls:/domain2/serverConfig> domainRuntime()
wls:/domain2/domainRuntime> listLoggers(target="WLS_REPORTS") 
-------------------------------------------------------------------------------------+-----------------
Logger                                                                               | Level           
-------------------------------------------------------------------------------------+-----------------
<root>                                                                               | WARNING:1
com.sun.xml.bind.v2.ClassFactory                                                     | <Inherited>
....
oracle.reports.adminlogconfig                                                        | <Inherited>
oracle.reports.configMbeans                                                          | <Inherited>
oracle.reports.engine                                                                | NOTIFICATION:1
oracle.reports.server                                                                | NOTIFICATION:16
oracle.reports.servlet                                                               | NOTIFICATION:1
.....
 
wls:/domain2/domainRuntime> listLoggers(pattern="oracle.reports.*", target="WLS_REPORTS")
------------------------------+-----------------
Logger                        | Level           
------------------------------+-----------------
oracle.reports.adminlogconfig | <Inherited>
oracle.reports.configMbeans   | <Inherited>
oracle.reports.engine         | NOTIFICATION:1
oracle.reports.server         | NOTIFICATION:16
oracle.reports.servlet        | NOTIFICATION:1
 
wls:/domain2/domainRuntime> listLoggers(pattern="oracle.reports.server.*", target="WLS_REPORTS")
----------------------+-----------------
Logger                | Level           
----------------------+-----------------
oracle.reports.server | NOTIFICATION:16
 
wls:/domain2/domainRuntime> listLogHandlers(target="WLS_REPORTS")
 
Handler Name: rwservlet_handler
type:   ODL
path:   /scratch/rrpai/wls55/user_projects/domains/domain2/servers/WLS_REPORTS/logs/reports/rwservlet_diagnostic.log
format: ODL-Text
maxFileSize:    1M
maxLogSize:     10M
Handler Name: wls-domain
type:   oracle.core.ojdl.weblogic.DomainLogHandler
Handler Name: odl-handler
type:   ODL
path:   /scratch/rrpai/wls55/user_projects/domains/domain2/servers/WLS_REPORTS/logs/WLS_REPORTS-diagnostic.log
maxFileSize:    10M
maxLogSize:     100M

24.3.4.1 listLoggers

You can use the listLoggers command to view the list of loggers and the level of each logger.

Table 24-7 describes the parameters supported by listLoggers command.

Return Value

A PyDictionary object where the keys are logger names and the associated values are the logger levels.

Examples

Following are the examples for listLoggers command:

1. listLoggers()

2. listLoggers(pattern="oracle.*")

3. listLoggers(runtime=0)

4. listLoggers(target="server1")

24.3.4.2 getLogLevel

You can use the getLogLevel command to obtain the log level for a given logger.

Table 24-8 describes the parameters supported by getLogLevel command.

Return Value

The logger level as a string.

Examples

The following are the examples of getLogLevel command

1. getLogLevel(logger="oracle")

2. getLogLevel(logger="oracle")

3. getLogLevel(logger="oracle", target="server2")

24.3.4.3 setLogLevel

You can use the setLogLevel command to set the log level for a given logger.

Table 24-9 describes the parameters supported by the setLogLevel command.

Return Value

The return value for the setLogLevel command is none.

Examples

The following are the examples for setLogLevel command.

1. setLogLevel(logger="oracle.my.logger", level="NOTICATION:1")

2. setLogLevel(logger="oracle.my.logger", level="TRACE:1", persist=0)

3. setLogLevel(target="server1", logger="oracle.my.logger", level="WARNING", runtime=0)

   Note:

   • The setLogLevel command is not supported for system components, such as Reports Server and Reports Bridge

   • For more information about WLST commands, see Oracle Fusion Middleware WebLogic Scripting Tool Command Reference guide.

24.3.4.4 listLogHandlers

You can use the listLogHandlers command to view the configuration of one or more log handlers.

Table 24-10 describes the parameters supported by listLogHandlers command.

Return Value

A java.util.List with one entry for each handlers. Each entry is a javax.management.openmbean.CompositeData object describing the handler.

Examples

The following are the examples for listLogHandlers command

1. listLogHandlers()

2. listLogHandlers(name="odl-handler")

3. listLogHandlers(target="server1")

24.3.4.5 configureLogHandlers

You can use the configureLogHandler command to configure and existing log handler, add a new log handler, or remove existing handlers.

Table 24-11 describes the parameters supported by configure LogHandler command.

24.3.4.6 listLogs

You can use the listLogs command to view the list of one or more components.

Table 24-12 describes the parameters supported by listLoggers command.

Return Value

A PyArray with one element for each log. The elements of the array are javax.management.openmbean.CompositeData objects describing each log.

Examples

Following are the examples for listLoggers command:

1. listLogs()

2. listLogs(target="server1")

3. listLogs(target="opmn:instance1/ohs1")

4. listLogs(oracleInstance="/middleware/user_projects/domains/base_domain", target="server1")

24.3.4.7 displayLogs

You can use the displayLogs command to view the contents of diagnostic logs.

Table 24-13 describes the parameters supported by listLoggers command.

Return Value

The command returns a value only when the returnData parameter is set to true. By default it will not return any data. The return value depends on the option used.

Examples

Following are the examples for displayLogs command:

1. displayLogs(tail=100)

2. displayLogs(target='opmn:instance1/ohs1', last=60)

3. displayLogs(groupBy=['COMPONENT_ID', 'MSG_TYPE'])

4. displayLogs(query='MSG_TYPE equals ERROR or MSG_TEXT contains Exception")

5. displayLogs(query='APP equals myApp', last=60)

6. displayLogs(query='ECID equals 0000Hl9TwKUCslT6uBi8UH18lkWX000002')

24.3.5.1 Viewing Metrics Tables

You can use the displayMetricTableNames command to view the list of metric table names available, including the native WebLogic metrics.

Table 24-14 describes the parameter for displayMetricTableNames command.

Example:

Invoke the WLST shell using the following Command:

ORACLE_HOME/common/bin/wlst.sh
> connect('weblogic','weblogic','hostname:7001')

wls:/domain1/serverConfig > displayMetricTableNames()
ContextManager
JVM
JVM_ClassLoader
JVM_Compiler
JVM_GC
JVM_Memory
JVM_MemoryPool
JVM_MemorySet
JVM_OS
JVM_Runtime
JVM_Thread
JVM_ThreadStats
Reports_Server_Information
Reports_Server_Performance
Reports_Server_Response
Reports_Servlet_Response
dms_cProcessInfo
opmn
opmn_component:ResourceUsage
opmn_component:ResourceUsage_by_component
opmn_component:ResourceUsage_no_rate
opmn_component:Response
opmn_connect
opmn_header
opmn_host_statistics
opmn_ias_component
opmn_ias_instance
opmn_ipmon
opmn_ons
opmn_ons_connections

Note:

For more information on using the displayMetricTableNames command, see Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

24.3.5.2 Viewing All Available Metrics

You can use the dumpMetrics command to view all available metrics, including native WebLogic metrics and internal DMS metrics.

Table 24-15 describes the parameters supported by dumpMetrics command

Example:

Invoke the WLST shell using the following Command:

ORACLE_HOME/common/bin/wlst.sh
> connect('weblogic','weblogic','hostname:7001')
wls:/domain1/serverConfig > dumpmetrics()

ContextManager
JVM
JVM_ClassLoader
JVM_Compiler
JVM_GC
JVM_Memory
JVM_MemoryPool
JVM_MemorySet
JVM_OS
JVM_Runtime
JVM_Thread
JVM_ThreadStats
Reports_Server_Information
Reports_Server_Performance
Reports_Server_Response
Reports_Servlet_Response
dms_cProcessInfo
opmn
opmn_component:ResourceUsage
......

Note:

For more information on using the dumpMetrics command, see, Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

24.3.5.3 Viewing Specific Metric Tables

You can use the displayMetricTables command to view the specified metric tables.

Table 24-16 describes the parameters supported by displayMetricTables command.

Example:

Invoke the WLST shell using the following Command:

ORACLE_HOME/common/bin/wlst.sh
> connect('weblogic','weblogic','hostname:7001')
wls:/domain1/serverConfig> displayMetricTables('Reports_Server_Performance')
--------------------------
Reports_Server_Performance
--------------------------
 
Active_Engines.value:   1
Available_Connections.value:    50
Average_Elapsed_Time.value:     0.0     msec
Average_Engines.value:  1.0
Average_Response_Time.value:    0.0     msec
CurrentJobLoad.value:   0
Current_Jobs.value:     0
Failed_Jobs.value:      0
Failed_Jobs_Ratio.value:        0.0
Finished_Jobs.value:    0
Host:   hostname
JobLoad.value:  0
Jobs_Queue_Time.value:  0.0
LongRunning_Jobs.value: 0
Maximum_Engines.value:  1
Maximum_Queue_Size.value:       1000
Name:   Reports_Server_Performance
Parent: /reports/rwserver
Potential_Runaway_Jobs.value:   0
Process:        ReportsServerComponent:8591386:/cinst48/ReportsServer_hostname_cinst48
Reports_Server_Auth_Time.value: 0.0
Reports_Server_Security.value:  0
Reports_Server_Start_Time.value:        1223884972408   msecs
Reports_Version.value:  11.1.1.0.0
Scheduled_Jobs.value:   0
ServerName:     /cinst48/ReportsServer_hostname_cinst48
Transferred_Jobs.value: 0
Used_Connections.value: 0
 
 
 
wls:/domain1/serverConfig> displayMetricTables('Reports_Server_Response')
-----------------------
Reports_Server_Response
-----------------------
 
Host:   hostname
Name:   Reports_Server_Response
Parent: /reports/rwserver
Process:        ReportsServerComponent:8591386:/cinst48/ReportsServer_hostname_cinst48
Reports_Server_Status.value:    1
Reports_Server_Type.value:      1
ServerName:     /cinst48/ReportsServer_hostname_cinst48

Note:

For more information on using the displayMetricTables command, see Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.

24.3.6.1 getAuditPolicy

This online command displays audit policy settings including the filter preset, special users, custom events, maximum log file size, and maximum log directory size. The component mbean name is required for system components like Oracle Internet Directory and Oracle Virtual Directory.

The syntax of the getAuditPolicy command is as follows:

getAuditPolicy(['mbeanName'])

Example

The following command displays the audit settings for a Java EE component:

wls:/domain52/serverConfig> getAuditPolicy()
Location changed to domainRuntime tree. This is a read-only tree with DomainMBean as the root.
For more help, use help(domainRuntime)
 
FilterPreset:None
Max Log File Size:104857600
Max Log Dir Size:0

24.3.6.2 setAuditPolicy

This online command configures the audit policy settings. You can set the filter preset, add or remove users, and add or remove custom events. The component mbean name is required for system components like Oracle Internet Directory and Oracle Virtual Directory.

The syntax of the setAuditPolicy command is as follows:

setAuditPolicy(['mbeanName'],['filterPreset'],['addSpecialUsers'],
['removeSpecialUsers'],['addCustomEvents'],['removeCustomEvents'])

Example

The following command sets audit policies to All level.:

wls:/domain52/domainRuntime> setAuditPolicy(filterPreset='All');
Already in Domain Runtime Tree
Audit Policy Information updated successfully

24.3.6.3 listAuditEvents

This online command displays the attributes and audit events of a component. For system components, pass the component mbean name as a parameter. Java EE applications and services like Oracle Platform Security Services (OPSS) do not need the MBean parameter. Without a component type, all generic attributes applicable to all components are displayed.

The syntax of the listAuditEvents command is as follows:

listAuditEvents(['mbeanName'],['componentType'])

Example

The following command displays all audit events:

wls:/domain52/domainRuntime> listAuditEvents();
Location changed to domainRuntime tree. This is a read-only tree with DomainMBean as the root.
For more help, use help(domainRuntime)
 
Components:
DIP
JPS
OIF
OWSM-AGENT
OWSM-PM-EJB
ReportsServer
WS-PolicyAttachment
WebCache
WebServices
Attributes applicable to all components:
ComponentType
InstanceId
HostId
HostNwaddr
ModuleId
ProcessId
OracleHome
HomeInstance
ECID
RID
...

24.3.8.1 Updating the Database with Queue Activity

The Reports Server job queue is implemented through the use of a PL/SQL case API. It functions to update the queue table with the queue information as requests are made. This implementation is defined in the following path:

ORACLE_HOME\reports\admin\sql\rw_server.sql

This script is certified to worked against Oracle 10g database.

To implement the queue, perform the following steps:

1. Load the rw_server.sql file to a database (this file is included with your Oracle Reports Services installation: ORACLE_HOME\reports\admin\sql).

   This creates a schema that owns the report queue information and has execute privileges on the server queue API. For backward compatibility with Oracle6i Reports, this also creates a view called RW_SERVER_QUEUE.

2. Set the repositoryconn property of the jobStatusRepository element in the server configuration file (ORACLE_INSTANCE\config\ReportsServerComponent\server_name\rwserver.conf for Standalone servers and $DOMAIN_HOME/config/fmwconfig/servers/<WLS_SERVER_NAME>/applications/reports_<version>/configuration/rwserver.conf for In-process servers) to the connection string of the schema that owns the queue data. For more information, see Section 8.2.1.12, "jobStatusRepository".

   Alternatively, you can set the jobstatusRepository in Oracle Enterprise Manager.

When the server starts, it connects as the defined user and logs job submissions.