B
Activating Logging and Tracing

Each tier of the Enterprise Manager framework such as the Console, Management Server, and Intelligent Agents supports its own tracing and logging capabilities. Both tracing and logging will provide the same detailed information on what actions the component is performing; however, tracing would be used to write data to a display for real-time viewing while logging would be used to redirect trace information to a file to view at a later time. This appendix will describe how to enable both tracing and logging of the various Enterprise Manager components.

Intelligent Agent Tracing/Logging

Tracing and logging of the third tier Intelligent Agent allows tracking of all communication between the Intelligent Agent and Management Server(s). For information on activating tracing and logging of the Intelligent Agent, refer to the Oracle Intelligent Agent User's Guide.

Management Server Tracing/Logging

Tracing and logging of the middle tier Management Server provides tracking of all communication between the Management Server and Intelligent Agents as well as communication between the Management Server and Consoles and/or other Enterprise Manager applications.

To enable tracing and/or logging, you must edit the omsconfig.properties file located on the Management Server machine in the $ORACLE_HOME/sysman/config/ directory.

Any properties specified in the omsconfig.properties file are case sensitive. Thus, you must specify the parameters in the same case as you see in the file and/or in this documentation.

Tracing of the Management Server

To enable tracing of the Management Server, add the following properties and appropriate values to the omsconfig.properties file:

TRACING.ENABLED = <true>|<false>

Specifies if trace information is to be generated. If logging is disabled, the trace information will be written to the Console from which the Management Server was started. Default is FALSE.

TRACING.LEVEL = <oem_trace_levels>

Set value to specify the detail of trace information to collect if tracing is enabled.

Possible values for <oem_trace_levels> are listed below:

• 5 - user: displays only messages of a critical or error level.

• 3 - admin: displays user trace level messages and warning messages.

• 2 - dev: displays all messages from admin trace level as well as informational and debug message

VDB_VERBOSE_DEBUG.

Specific JDBC logging can be appended to the OMS.LOG file.

Logging of the Management Server

When logging is enabled, and the trace output is written to a file, the Management Server will create a file called OMS.LOG in the $ORACLE_HOME\SYSMAN\LOG directory.

The Management Server places all its trace messages in Management Server log files (OMS.LOG.0, OMS.LOG.1, OMS.LOG.2, and so on). It writes to one log file, and when the log file is full, it writes to the next file, recycling the last two files.

The Management Server's log files have size limits. By default, when the Management Server starts, it can only create log files with a size of 25 MB. The initial log file name is OMS.LOG.0. If the file reaches its 25 MB limit, a separate log file is created. The separate log file name is OMS.LOG.1. If that file reaches its 25 MB limit, the OMS.LOG.0 file is deleted and a new log file, OMS.LOG.2, is created. The last two log files are kept.

This file will remain in use for as long as the Management Server is running. All messages will be written in that file.

The oms.nohup file is automatically created (on both Windows NT and UNIX). The oms.nohup file has entries corresponding to when the Management Server is started and stopped and if the Management Server restarts itself for any reason. Any critical error messages (for example, running out of sessions, SQL exceptions, and others) are also logged to this file. Any other detailed tracing is directed to the oms.log files (if tracing is turned on)

To enable logging of the Management Server, add the following properties and appropriate values to the omsconfig.properties file:

LOGGING.ENABLED = <true>|<false>

Specifies whether the trace information will to be written to a file. Information will only be written to a file if the TRACING.ENABLED flag is also activated. Default is FALSE.

LOGGING.DIR = <directory_spec>

Directory in which the OMS.log file will be written. Default value is $ORACLE_HOME\SYSMAN\LOG.

LOGGING.FILENAME = <filename>

Filename to use for the Management Server logging. An index counter will be appended to this file. Every time the maximum size is reached a new file with the increased index number will be created. At startup the counter is always 0 (ZERO), and the value of this counter will be increased if the log file reaches its specified maximum size. Defaults to OMS.LOG.0, OMS.LOG.1, OMS.LOG.2, and so on.

LOGGING.MAX_SIZE = <integer>

Controls the total maximum size of the log files. The value you specify for the LOGGING.MAX_SIZE property is in MB. Its default value is 50 and will result in two log files of max size 25MB. When set to 0 (zero), no file limit is imposed, and only 1 OMS.LOG file will be created and used. If a specific size is specified, all of the log files generated will be suffixed with a counter value.

LOGGING.MAX_FILE_CNT = <integer>

Defines the maximum number of files the log will span at any given time. The cumulative size of all the files would be less than or equal to LOGGING.MAXSIZE.

Default value is 2.

If LOGGING.MAX_SIZE=0 (unlimited log size), LOGGING.MAX_FILE_CNT will not make sense and hence ignored.

LOGGING.SAVE_PREVIOUS_LOG = <true>|<false>

Specifies if the previous OMS.LOG files will be renamed to a filename with a timestamp to prevent it from being overwritten when the Management Server is started again. Such log files would be appended with a timestamp (format: yyyyMMddHHmmss) when they are renamed. Default is FALSE.

Reporting Servlet Tracing and Logging

To enable logging and tracing of the reporting servlet, add the appropriate properties and values to the reporting.properties file. The reporting.properties file located on the Management Server machine in the $ORACLE_HOME/sysman/config/ directory. Any properties specified in the reporting.properties file are case sensitive. Thus, you must specify the parameters in the same case as you see in the file and/or in this documentation.

To enable logging (the writing of trace data to a file) and tracing (the writing of data to a display for real-time viewing) of the reporting servlet, perform the following actions:

1. Add the following properties and their appropriate values to the reporting.properties file:

   TRACING.ENABLED = <true>|<false>

   Specifies if trace information is to be generated.

   TRACING.LEVEL = <integer>

   Specifies the detail of trace information to be collected if tracing is enabled. Possible values include:

   • 5 - captures only critical and error level messages

   • 3 - captures only critical, error, and warning level messages

   • 2 - captures all critical, error and warning messages as well as informational and debugging messages

   LOGGING.ENABLED = <true>|<false>

   Controls where the information is written. This flag specifies if tracing information should be written to a file rather than written to a display for real-time viewing. If logging is enabled, output is written to the reporting.log file located in the Management Servers's $ORACLE_HOME/sysman/log/ directory.

2. Stop and restart the webserver that is used for the Enterprise Manager Reporting Web Site; by default, the Oracle HTTP Server is used.

3. Stop and restart the Management Server.

Debugging Client Applications

To obtain more information for debugging a client application, at the command prompt, type

oemapp debug [app]

This would enable tracing at level 2 and ensure that the output is directed to the Console.

Enterprise Manager Client Application Tracing

To enable tracing of the Enterprise Manager Console and its management applications, add the following properties and appropriate values to the ClientConfig.properties file:

TRACING.ENABLED = <true>|<false>

Specifies if trace information is to be generated.

TRACING.LEVEL = <oem_trace_levels>

Set value to specify the detail of trace information to collect if tracing is enabled.

Set <oem_trace_levels> to 2.

For all Windows platforms (Windows NT, Windows 2000, and Windows 98), open a DOS window and set the following environment variable:

C:\>SET ORACLE_OEM_CLIENTTRACE=TRUE 

For UNIX, set the following environment variable

$ export ORACLE_OEM_CLIENTTRACE=TRUE

Then start a client application from the command line using the OEMAPP script and redirect the output to a file.

For example

oemapp console

If you need to perform additional JAVA debugging, you can modify the OEMAPP script file and add debugging parameters.

For example, on Windows, change

SET JRE=jre -nojit -mx32m -ms8m

to

SET JRE=jre -nojit -mx32m -ms8m -verbose -verbosegc

Browser-Based Enterprise Manager Tracing

If you encounter problems bringing up Oracle Enterprise Manager in a browser, collect tracing information before reporting the problem to Oracle Support Services.

To set up tracing for your browser perform the following steps:

1. Exit your browser session

2. Start the Java plug-in Console.

   From the Windows Start menu, click Programs-> JInitiator Control Panel. A window appears.

   1. Check the "Show Java Console" checkbox.

   2. In the Java Run Time Parameters box, append the following to the end of the line:

      -DTRACING.ENABLED = TRUE -DTRACING.LEVEL = 2
      
      

   3. Click the Apply button.

   4. Close the Oracle JInitiator Properties panel.

3. Restart your browser and reload Oracle Enterprise Manager.

   The Java Console window appears, showing the Java classes loaded by the plugin as well as any exceptions that may occur. If no exceptions are displayed, clear the screen (by clicking the Clear button) every 3rd or 4th screen-full of displayed information.

4. If an exception appears in the Java Console window, please cut and paste it into a file and send it to Oracle Support Services along with a description of your problem.

Paging Server Tracing

The Enterprise Manager Paging Server can be debugged and traced separately from the Management Server. Tracing for the paging server is disabled by default. If tracing is enabled, the server writes trace statements for all telephone line handling and any successes or failures to a log file by default. Since information is logged whenever a page is sent, the log file grows proportionally to the number of pages sent. To delete a log file, you must shut down the paging server and delete the file.

The installation of the Oracle Enterprise Manager Paging Server provides a template configuration file, paging.cfg.template, located in the ORACLE_HOME\sysman\config directory.

1. Copy the paging.cfg.template file to the paging.cfg file, which is also located in the ORACLE_HOME\sysman\config directory.

   Oracle recommends copying this file (not renaming it) to retain information. If you do not copy this file, all comments concerning enabling tracing of paging will be removed. In addition, when updates to Enterprise Manager software are made, any configuration will be lost and not retrievable.

2. Based on the instructions in the paging.cfg.template file, modify the paging.cfg file according to your tracing needs and save it.

To enable tracing of the Enterprise Manager Paging Server, add the following properties and appropriate values to the paging.cfg file:

TRACING.ENABLED

Set value for debugging purposes; paging service will then track what paging is occurring by writing trace statements for all telephone line handling and any successes or failures.

The value can be either TRUE or FALSE. If the value is set to TRUE, you must specify a value for TRACEFILENAME and a value for TRACING.LEVEL. If the value is set to FALSE, you need not specify values for TRACEFILENAME and TRACING.LEVEL.

TRACING.LEVEL

Set value to specify the detail of trace information to collect if tracing is enabled.

• 5 - user: collects critical messages and error messages.

• 3 - admin: collects critical, error, and warning messages.

• 2 - dev: collects all messages from admin trace level as well as informational and debug messages

TRACEFILENAME

Set value for where to write tracing output if tracing is enabled.

Oracle recommends setting the value to PAGING_LOG.TRC. By default, this file is located in the Paging Server's ORACLE_HOME\SYSMAN\LOG directory.

If you specify a different directory, you must specify <Drive_Letter>:\\<directory_path>\paging_log.trc. For example, if you want the tracing file stored in C:\temp\, set the value to C:\\temp\paging_log.trc.

SQL Engine Tracing

The SQL engine accepts, executes, and transmits the results of the SQL statements issued by the Enterprise Manager software.

Depending on how the client application was started, the SQL Engine can be running on either the client or the Management Server:

• A client application connecting to the Management Server will use the SQL Engine of the Management Server.

• A client application connecting directly to a database will use its own SQL engine.

Since the engine can be traced on both the client and the Management Server, these parameters can be specified in both the omsconfig.properties and the ClientConfig.properties files.

The possible VDB (SQL Engine) parameters are mutually exclusive. You should use the highest requested tracing.

VDB_DEBUG

When enabled, the SQL Engine will display trace stack traces and messages that are the first level of information. Boolean value. Possible values: TRUE and FALSE. Defaults to FALSE.

VDB_VERBOSE_DEBUG

In this case, the SQL engine will display the methods as they are being entered and exited as well as any DEVELOPER DEBUG information. Boolean value. Possible values: TRUE and FALSE. Defaults to FALSE.

VDB_SESSION_DEBUG

This is validated when displaying the contents of the database session pool. It is also used to trace session creation and destruction, as well as session pool activity. Boolean value. Possible values: TRUE and FALSE. Defaults to FALSE.

VDB_VERBOSE_SESSION_DEBUG

This parameter gives more detail on session activity including stack traces when sessions are opened, closed, released to, or retrieved from the session pool. Like VDB_VERBOSE_DEBUG, it is a verbose version of the session tracing. Boolean value. Possible values: TRUE and FALSE. Defaults to FALSE.

Tracing and Logging of Management Pack Applications

Refer to Database Tuning with the Oracle Tuning Pack for information on tracing for the management packs.