Turning on the debug level OM Web viewer 12.1 WVtrace
search cancel

Turning on the debug level OM Web viewer 12.1 WVtrace

book

Article ID: 403667

calendar_today

Updated On:

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 and then disable WVTrace debug level tracing in Output Management Web Viewer 12.1?

Environment

  • Output Management Web Viewer 12.1
  • Apache Tomcat®

Resolution

Build 219 or Higher

If you are running Web Viewer with a 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. Go to the <Installation location>/config directory, rename all the .cfg files to .old
  2. Build 252 introduced the sample OmWVTrace.xml at the <Installation location>/config directory. For builds below 252, copy the sample OmWVTrace.xml from the sample additional information below and place it inside the <Installation location>/config directory.
  3. Open the OmWVTrace.xml and change all the “ERROR” to “DEBUG”.
  4. Restart Web Viewer.

To turn off tracing

  1. Edit the OmWVtrace.xml file and replace all the DEBUG with ERROR.
  2. Restart Web Viewer.

Note: Tracing impacts the performance of any application; please ensure you turn off the tracing after capturing the required/requested trace logs.

Additional Information

Sample OmWVtrace.xml

<?xml version="1.0" encoding="UTF-8"?>

<!--

     This is a sample skeleton to turn on Trace logs in Web Viewer 12.

     Define the log file location using the environment variable CAOMWV12_HOME.

    

     To turn on tracing

     - Edit the OmWVtrace.xml file and replace "ERROR" with "DEBUG".

     - Restart Web viewer

-->

<Configuration monitorInterval="30" status="ERROR">

    <Appenders>

        <File name="LogToFile" fileName="${env:CAOMWV12_HOME}${sys:file.separator}logs${sys:file.separator}wvtrace.log">

            <PatternLayout>

                <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>

            </PatternLayout>

        </File>

    </Appenders>

    <Loggers>

        <!-- avoid duplicated logs with additivity=false -->

        <Logger name="com.ca.erm" level="ERROR" additivity="false">

            <AppenderRef ref="LogToFile"/>

        </Logger>

        <Root level="ERROR">

            <AppenderRef ref="LogToFile"/>

        </Root>

    </Loggers>

</Configuration>

 



 The following is an example of how to change your OmWVTrace.cfg file. 

 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
Powered by Wolken Software