Enable Waltz and Sonata traces

Enable Waltz and Sonata on both the WAS and the FileNet server to see logs for these applications.

Waltz provides the common directory services and its extension such as WPI/WCI framework for Enterprise Web Applications on the Java EE platform. As a sharable common directory service component Waltz focuses on accessing directory profile data and supports Web-based applications running on WebSphere without having to set up an extra set of LDAP parameters. Since it automatically picks up all system-wide, directory-related settings, no additional, application-level configuration for directory profiles is needed.

Sonata provides the common HttpClient services for a RESTful backend with a set of configurable authenticators to support various SSO security tokens and cookies for secure server-to-server communication.

Both Waltz and Sonata support profile and community membership lookups in FileNet.

Enable Waltz and Sonata Traces on the WAS

Select the Runtime tab on the Change Log Detail Levels page to have this trace be capable of taking effect without the need to restart the server. Make sure "Save runtime changes to configuration" as well is selected to have these same trace packages configured and continue taking effect after restarting servers. For example:

1. Waltz:
   com.ibm.connections.directory.services.*=all

2. Sonata:
   com.ibm.connections.httpClient.*=all

3. WAS VMM/WIM:
   com.ibm.websphere.wim.*=all:com.ibm.ws.wim.*=all

4. WAS SPNEGO:
   com.ibm.ws.security.spnego.*=all

5. Apache commons HttpClient:
   org.apache.commons.httpclient.*=all

6. WAS security:
   com.imb.ws.security.*=all:com.ibm.ws.security.policy.*=off;

Waltz

Track all basic Waltz configuration settings and transactions.

com.ibm.connections.directory.services.*=all"

Track all LDAP transactions in between Waltz & LDAP server(s).

WaltzLDAPUsage=all

Track all LDAP entry to be cached and hit from cache upon DN of LDAP entries.

WaltzDNEntryCache=all

Track all LDAP entry to be cached and hit from cache upon ID of LDAP entries.

WaltzExactIDMatchCache=all

Track all group membership (a list of groups) for a given user upon ID.

WaltzGroupMembershipCache=all

Track all members (a list of users) for a given group upon ID.

WaltzMemberExpansionCache=all

Sonata

Basic Sonata configuration settings and transactions.

com.ibm.connections.httpClient.*=all"

Track all numbers of HTTP(S) transactions.

SonataHttpUsage=all

Track all headers received for all HTTP(S) transactions.

SonataHttpHeader=all

Track all bodies received for all HTTP(S) transactions.

SonataHttpBody=all

VMM/WIM Trace

VMM/WIM Trace:

com.ibm.websphere.wim.*=all:com.ibm.ws.wim.*=all"

Apache Commons HttpClient

org.apache.commons.httpclient.*=all”

WebSphere Security

com.ibm.ws.security.*=all:com.ibm.ws.security.policy.*=off

WebSphere SPNEGO:

com.ibm.ws.security.spnego.*=all”

IBM JDK6 JGSS API

com.ibm.security.jgss.debug.*=all”

Set through server’s JVM custom properties.

IBM JDK6 KRB5 API

com.ibm.security.krb5.krb5Debug.*=all”

Set through server’s JVM custom properties.

Enable Waltz and Sonata Traces on the FileNet server

This instruction is derived from the IBM Support Technote: Configure tracing for IBM FileNet Content Engine using log4j. One of the most fundamental components of Connections 4.5, Waltz and Sonata, have been incorporated into the FileNet Content Engine, which becomes part of the FileNet P8 Server 5.2. This integration service enables Enterprise Content Management over the IBM Social Business Platform. However, the FileNet server has been made independent from the common usage of the troubleshooting vehicle provided by the WASs historically. Therefore, the troubleshooting mechanism for the FileNet Application Server could be slightly different from the traditional Enterprise Web-based applications used in Connections.

1. Download and copy the sample waltz.sonata.log4j.xml to user’s home as log4j.xml. For example:

   • Linux: /<absolute_path_for_log4j_file>/log4j.xml

   • Windows:\<absolute_path_for_log4j_file>\log4j.xml

2. Add the following as JVM command line arguments to the FileNet Application Server: -Dlog4j.configuration=file:/<absolute_path_for_log4j_file>/log4j.xml -DskipTLC=true See IBM Support Technote: Configure tracing for IBM FileNet Content Engine using log4j for more information.

   This instructs the Content Engine (CE) server to skip the existing Trace Logging Configuration.

3. Restart the Filenet Application Server.

4. Recreate the problem and collect the trace files for support.

5. Locate the waltz.sonata.trace.log file under the profiles folder. For example:

   • Windows: c:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv01

   • Linux /opt/IBM/WebSphere/AppServer/profiles/AppSrv01

6. Turn tracing off by removing the JVM command line arguments and restarting the Filenet Application Server.

Results

Here is a sample log4J.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd" >

<log4j:configuration debug="false"
    xmlns:log4j="http://jakarta.apache.org/log4j/">
    
    <!-- ====== Appenders ===== -->

    <appender name="Console" class="org.apache.log4j.ConsoleAppender">
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                value="%d [%t] %-5p %c - %m%n" />
        </layout>
    </appender>

    <appender name="DefaultFileAppender"
        class="org.apache.log4j.RollingFileAppender">
        <!-- absolute path to log file -->
        <param name="File" value="logs/waltz.sonata.trace.log" />
        <!-- setting this to false will cause the file to               
                be truncated with each restart -->
        <param name="Append" value="true" />
        <!-- MaxFileSize -->
        <param name="MaxFileSize" value="2000KB" />
        <!-- Oldest file will be deleted if               
                more than n files were generated -->
        <param name="MaxBackupIndex" value="2" />
        <!-- Layout -->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                value="%d [%t] %-5p %c - %m%n" />
        </layout>
    </appender>

    <!-- ====== Categories ===== -->

    <!-- Application category -->
    <category name="com.ibm.connections.directory.services" additivity="true">
        <priority value="debug" />
    </category>
    <category name="com.ibm.connections.httpClient" additivity="true">
        <priority value="debug" />
    </category>
    <category name="SonataHttpHeader" additivity="true">
        <priority value="debug" />
    </category>

    <!-- The root category -->
    <root>
        <priority value="warn" />
        <appender-ref ref="Console"/>
        <appender-ref ref="DefaultFileAppender" />
    </root>
</log4j:configuration>

Parent topic:
Troubleshooting Connections Content Manager (CCM)