Configuring WVTrace debug level tracing with OM Web Viewer

Products

• Output Management Web Viewer

Issue/Introduction

In order to troubleshoot a problem with OM Web Viewer 12.1- especially for a problem not providing an error message, support may ask you for an OM Web Viewer debug level (debug level WVTrace) trace.

How do I enable then disable WVTrace debug level tracing in Output Management Web Viewer 12.1?

Environment

Output Management Web Viewer 12.1
Apache Tomcat®

Resolution

If you are running Web Viewer with cumulative build 219 or higher, follow these instructions:

Cumulative build 219 was a security update for the log4j vulnerability.  This required changes to the tracing files. Tracing is no longer available for DRAS or CCI.

To turn on tracing

1. In the config directory under your install path, rename the .cfg files to .old
2. Put the OmWVtrace.xml file that is attached to this case into the config directory. 
3. Edit the OMWVtace.xml file in notepad and make sure that the path to write the file is correct for your environment, for example:
           <File name="LogToFile" fileName="C:\Program Files\CA\CA_OM_Web_Viewer\logs\wvtrace.log">
4. restart Web Viewer.

To turn off tracing

1. Edit the OmWVtrace.xml file and replace DEBUG in two places with ERROR.
2. Restart Web viewer

If you are running Web Viewer with cumulative build 218 or lower, follow these instructions:

1. Edit your OmWVTrace.cfg file. Assuming system level external configuration, this is located in the ${CAOMWV12_HOME}/config folder.

2  Look for =DEBUG or =EXIT log4j.logger lines and uncomment these lines by removing the "#" as first character of the line.

3. This will enable low-level tracing in Web Viewer's communications.

4. Stop and start Tomcat or WebSphere to enable this tracing (or you can wait - changes should be picked up in 5 minutes or so).

5. Once this tracing is enabled, wait for the next occurrence of the problem.

6. When the problem occurs, note the approximate time of the problem and the userid.  Or attempt a fresh login while noting the time and the userid.

7.  Then locate and send to us the wvtrace.log file (in the ${CAOMWV12_HOME}/logs folder).

8. Also send the DRAS and Tomcat or WebSphere log files for the same test.

9. Reverse the changes made above when testing is complete to return to a standard logging level. 

Additional Information

Following is an example of how change your OmWVTrace.cfg file. 

C:\Program Files\CA\CA_OM_Web_Viewer\apache-tomcat-7.0.54\webapps\CAOMWebViewer12\config\

OMWVTrace.cfg

#

# Set the categoryFactory to OmTrace category factory.

#

log4j.loggerFactory=com.ca.erm.webviewer.util.OmTraceFactory

#

# Setup the default appender object.  Set the root/default trace priority.

#

 

#log4j.category.com.ca.erm.webviewer=ERROR, A3, stdout

log4j.category.com.ca.erm.webviewer=ERROR, A3  <<== change this from ERROR to DEBUG

log4j.additivity.com.ca.erm.webviewer=false

 

log4j.appender.stdout=org.apache.log4j.ConsoleAppender

log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

 

#log4j.rootCategory=FATAL,A3

#

log4j.appender.A3=org.apache.log4j.DailyRollingFileAppender

log4j.appender.A3.DatePattern='.'yyyy-MM-dd

log4j.appender.A3.File=${JDRAS_HOME}/logs/wvtrace.log

log4j.appender.A3.layout=org.apache.log4j.PatternLayout

log4j.appender.A3.layout.ConversionPattern=%-5p %d{DATE} [%t] %c: %m%n

#

# Appender for rolling file appender.

#

log4j.appender.R3=org.apache.log4j.DailyRollingFileAppender

log4j.appender.R3.DatePattern='.'yyyy-MM-dd

log4j.appender.R3.File=${JDRAS_HOME}/logs/wvtraceroll.log

log4j.appender.R3.layout=org.apache.log4j.PatternLayout

log4j.appender.R3.layout.ConversionPattern=%-5p %d{DATE} [%t] %c: %m%n

#

# Appender for NT file system appender

#

log4j.appender.NT3=org.apache.log4j.nt.NTEventLogAppender

log4j.appender.NT3.layout=org.apache.log4j.PatternLayout

log4j.appender.NT3.layout.ConversionPattern=%-5p %d{DATE} [%t] %c: %m%n

 

 

#

# Set the priority of "com.ca.omgmt" for default tracing.

# Priorities are from lowest to highest: EXIT, ENTRY, DEBUG, INFO, WARN, ERROR, FATAL

# Priorities greater than or equal to that specified are printed.

# EXIT and ENTRY priorities are defined in com.ca.erm.webviewer.util.OmTraceLevel.

#

# Since we set OmTraceFactory as the category factory.

#

log4j.logger.com.ca.erm.webviewer=ERROR#com.ca.erm.webviewer.util.OmTraceLevel <<== change this from ERROR to DEBUG

Log4j Tracing with Apache Tomcat

To temporally debug Log4j, add the following the following parameter to the Tomcat startup:

-Dlog4j.debug