Page History

{span:style=font-size:2em;font-weight:bold} Debugging and Logging {span}

{toc}

h1. Logging Messages

CXF uses [Java SE Logging|http://www.oracle.com/technology/pub/articles/hunter_logging.html] for both client- and server-side logging of SOAP requests and responses.  Logging is activated by use of separate in/out interceptors that can be attached to the client and/or service as required.  These interceptors can be specified either programmatically (via Java code and/or annotations) or via use of configuration files.

Configuration files are probably best.  They offer two benefits over programmatic configuration:  
# Logging requirements can be altered without needing to recompile the code
# No Apache CXF-specific APIs need to be added to your code, which helps it remain interoperable with other JAX-WS compliant web service stacks

Enabling message logging through configuration files is shown [here|http://cxf.apache.org/docs/configuration.html].  

For programmatic configuration, the logging interceptors can be added to your service endpoint as follows:

{code}
import javax.xml.ws.Endpoint;
import org.apache.cxf.interceptor.LoggingInInterceptor;
import org.apache.cxf.interceptor.LoggingOutInterceptor;
import org.apache.cxf.jaxws.EndpointImpl;

Object implementor = new GreeterImpl();
EndpointImpl ep = (EndpointImpl) Endpoint.publish("http://localhost/service", implementor);

ep.getServer().getEndpoint().getInInterceptors().add(new LoggingInInterceptor());
ep.getServer().getEndpoint().getOutInterceptors().add(new LoggingOutInterceptor());
{code}


For web services running on CXFServlet, the below annotations can be used on either the SEI or the SEI implementation class.  If placed on the SEI, they activate logging both for client and server; if on the SEI implementation class, they are relevant just for server-side logging.

{code}
import org.apache.cxf.feature.Features;

@javax.jws.WebService(portName = "MyWebServicePort", serviceName = "MyWebService", ...)
@Features(features = "org.apache.cxf.feature.LoggingFeature")        
public class MyWebServicePortTypeImpl implements MyWebServicePortType {
{code}

or (equivalent)

{code}
import org.apache.cxf.interceptor.InInterceptors;
import org.apache.cxf.interceptor.OutInterceptors;

@javax.jws.WebService(portName = "WebServicePort", serviceName = "WebServiceService", ...)
@InInterceptors(interceptors = "org.apache.cxf.interceptor.LoggingInInterceptor")
@OutInterceptors(interceptors = "org.apache.cxf.interceptor.LoggingOutInterceptor")
public class WebServicePortTypeImpl implements WebServicePortType {
{code}


For programmatic client-side logging, the following code snippet can be used as an example:

{code}
import org.apache.cxf.endpoint.Client;
import org.apache.cxf.frontend.ClientProxy;
import org.apache.cxf.interceptor.LoggingInInterceptor;
import org.apache.cxf.interceptor.LoggingOutInterceptor;

public class WSClient {
    public static void main (String[] args) {
        MyService ws = new MyService();
        MyPortType port = ws.getPort();
        
        Client client = ClientProxy.getClient(port);
        client.getInInterceptors().add(new LoggingInInterceptor());
        client.getOutInterceptors().add(new LoggingOutInterceptor()); 
        
        // make WS calls...
{code}

h2. Configure logging levels. 

In the [/etc folder|http://svn.apache.org/viewvc/cxf/trunk/distribution/src/main/release/etc/] of the CXF distribution there is a sample Java SE logging.properties file you can use to configure logging.  For example, if you want to change the console logging level from WARNING to FINE, you need to update two properties in this logging.properties file as below:

{code:xml}
.level= FINE
java.util.logging.ConsoleHandler.level = FINE
{code}

Once this is done, you will need to set the *-Djava.util.logging.config.file* property to the location of the logging.properties file.  As an example, the Ant target below has this property set:

{code:xml}
<target name="runClient">
   <java classname="client.WSClient" fork="true">	    	
      <classpath>
         <pathelement location="${build.classes.dir}"/>
         <fileset dir="${env.CXF_HOME}/lib">
            <include name="*.jar"/>
         </fileset>
      </classpath>
      <jvmarg value="-Djava.util.logging.config.file=/usr/myclientapp/logging.properties"/>
   </java>
</target>
{code}

h2. Using Log4j Instead of java.util.logging 

As noted above, CXF uses the {{java.util.logging}} package by default. But it is possible to switch CXF to instead use [Log4J|http://logging.apache.org/log4j/]. This is achieved through the use of configuration files. There are two options to bootstrapping CXF logging and each is listed below: 

* Add the following system property to the classpath from which CXF is initialized: 

{code}
-Dorg.apache.cxf.Logger=org.apache.cxf.common.logging.Log4jLogger
{code}

* Add the file {{META-INF/cxf/org.apache.cxf.Logger}} to the classpath and make sure it contains the following content: 

{code}
org.apache.cxf.common.logging.Log4jLogger
{code}

h2. Using SLF4J Instead of java.util.logging (since 2.2.8)

As noted above, CXF uses the {{java.util.logging}} package by default. But it is possible to switch CXF to instead use [SLF4J|http://www.slf4j.org/]. This is achieved through the use of configuration files. There are two options to bootstrapping CXF logging and each is listed below: 

* Add the following system property to the classpath from which CXF is initialized: 

{code}
-Dorg.apache.cxf.Logger=org.apache.cxf.common.logging.Slf4jLogger
{code}

* Add the file {{META-INF/cxf/org.apache.cxf.Logger}} to the classpath and make sure it contains the following content: 

{code}
org.apache.cxf.common.logging.Slf4jLogger
{code}


h1. Debugging Tools

h2. Eclipse IDE

See this [blog entry|http://www.jroller.com/gmazza/entry/eclipse_debug_web_services] for information on debugging web services using Eclipse.  Note this is primarily for tracing/debugging source code; you will probably still want to use one of the tools below to capture network traffic, view SOAP requests and responses, etc.

h2. NetBeans IDE
NetBeans include a [debugger|http://www.netbeans.org/features/java/debugger.html], [profiler|http://www.netbeans.org/features/java/profiler.html] and an HTTP monitor that can assist in troubleshooting SOA applications.

h2. tcpmon and tcptrace
[tcpmon|http://tcpmon.dev.java.net] allows you to easily view messages as they go back and forth on the wire. The companion utility [tcptrace|http://www.tcptrace.org] can be used for analysis of the dump.

h2. WSMonitor
[WSMonitor|https://wsmonitor.dev.java.net/] in another option to Tcpmon with slightly more functionality.

h2. NetSniffer
[NetSniffer|http://www.miray.de/products/sat.netsniffer.html] makes it possible to track the network traffic between arbitrary devices within a LAN segment.

h2. Wireshark
[Wireshark|http://www.wireshark.org/], a network packet analyzer, is useful for following the routing of SOAP messages.  It can also help when you are getting an HTML error message from the server that your CXF client cannot normally process, by allowing you to see the non-SOAP error message.  See this [blog entry|http://www.jroller.com/gmazza/entry/soap_calls_over_wireshark] for more information.

h2. SOAP UI
[SOAP UI|http://soapui.org] can also be used for debugging. In addition to viewing messages, it allows you send messages and load test your services. It also has plugins for the [Eclipse IDE|http://soapui.org/IDE-Plugins/eclipse-plugin.html], [NetBeans IDE|http://www.soapui.org/IDE-Plugins/netbean.html] and [IntelliJ IDEA|http://www.soapui.org/IDE-Plugins/intellij.html].

h1. Helpful Tools and Utilities

h2. WSDL Viewer
[WSDL Viewer|http://tomi.vanek.sk/index.php?page=wsdl-viewer] is a small tool to visualize the web-service in a more intuitive way. 

h2. cURL
[cURL|http://curl.haxx.se/] is a command line tool for transferring data with URL syntax, supporting DICT, FILE, FTP, FTPS, GOPHER, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS, POP3, POP3S, RTMP, RTSP, SCP, SFTP, SMTP, SMTPS, TELNET and TFTP. curl supports SSL certificates, HTTP POST, HTTP PUT, FTP uploading, HTTP form based upload, proxies, cookies, user+password authentication (Basic, Digest, NTLM, Negotiate, kerberos...), file transfer resume, proxy tunneling and a busload of other useful tricks. 

h2. Sonar
[Sonar|http://www.sonarsource.org/] is an open source quality management platform, dedicated to continuously analyze and measure source code quality, from the portfolio to the method. Here is [CXF on Sonar|http://nemo.sonarsource.org/project/index/117804].

h2. Fisheye
 [Fisheye|http://www.atlassian.com/software/fisheye/] provides a web interface for Subversion, Git, CVS, Perforce & ClearCase source control repositories. Here is [CXF on Fisheye|https://fisheye6.atlassian.com/browse/cxf].


h1. ATOM logging

*This feature is available since CXF 2.3.0, as part of the cxf-rt-management-web component*

CXF supports collecting log events, converting them to [ATOM Syndication Format|http://tools.ietf.org/html/rfc4287] and either pushing them to the Atom-aware consumers or making them available for polling. Logging is based on a custom {{java.util.logging}} (JUL) handler that can be registered with loggers extending today's publishing protocols.

*CXF JAXRS and JAXWS endpoints* can avail of this feature.

h2. Push Style

Push-style handler enqueues log records as they are published from loggers. After the queue size exceeds configurable "batch size", processing of collection of these records (in size of batch size) is triggered. Batch of log events is transformed by converter to ATOM element and then it is pushed out by deliverer to client. Both converter and deliverer are configurable units that allow to change transformation and transportation strategies. Next to predefined own custom implementations can be used when necessary -- see examples. Batches are processed sequentially to allow client side to recreate stream of events. 

*Limitations:* Reliability is not supported out of the box, however there is predefined retrying delivery strategy. Persistence is also not supported, any enqueued and undelivered log events are lost on shutdown. Definitions of delivery endpoints is static, subscription of callback URIs is not yet supported. 

h3. Spring configuration
In simplest case pushing ATOM Feeds can be declared this way:
{code:xml}
   <bean class="org.apache.cxf.management.web.logging.atom.AtomPushBean" init-method="init">
       <property name="url" value="http://somewhere.com/foo/bar"/>
       <property name="level" value="ALL" />
   </bean>
{code}
Spring bean creates ATOM push handler and registers it with root logger for all log levels. This setup leads to logging everything CXF, Spring and others inclued. Since batch size is not specified default value of one is used - each event is packed up as single feed pushed out to specified URL. Default conversion strategy and default WebClient-based deliver are used. 

More complex example shows how to specify non-root logger and define batch size:
{code:xml}
   <bean class="org.apache.cxf.management.web.logging.atom.AtomPushBean" init-method="init">
       <property name="url" value="http://somewhere.com/foo/bar"/>
       <property name="logger" value="org.apache.cxf.jaxrs" />
       <property name="level" value="INFO" />
       <property name="batchSize" value="10" />
   </bean>
{code}

To push to client events generated by different loggers on different levels, "loggers" property must be used instead of pair "logger" and "level":
{code:xml}
   <bean class="org.apache.cxf.jaxrs.management.web.atom.AtomPushBean" init-method="init">
       <property name="url" value="http://somewhere.com/foo/bar"/>
       <property name="loggers" value="
           org.apache.cxf:DEBUG,
           org.apache.cxf.jaxrs,
           org.apache.cxf.bus:ERROR,
           myNamedLogger:INFO" />
   </bean>
{code}
In example above, second logger does not have specified level, in such case default level of "INFO" is used.

In all above cases, when first delivery fails engine of ATOM push handler is shutdown and no events will be processed and pushed until configuration reload. To avoid this frequent case, retrial can be enabled:
{code:xml}
   <bean class="org.apache.cxf.management.web.logging.atom.AtomPushBean" init-method="init">
       <property name="url" value="http://somewhere.com/foo/bar"/>
       <property name="logger" value="org.apache.cxf.jaxrs" />
       <property name="level" value="INFO" />
       <property name="retryPause" value="linear" />
       <property name="retryPauseTime" value="60" />
       <property name="retryTimeout" value="300" />
   </bean>
{code}
In this case for 5 minutes ("retryTimeout") after delivery failure there will be 1 minute pause ("retryPauseTime") repeated every time with same value ("retryPause" as "linear"). Instead of same pause time, "exponential" value of "retryPause" can be used - each next time pause time doubles. When timeout value is set to 0 retrying is infinite. In case of invalid or missing values defaults are used: for pause time 30 seconds and for timeout 0 (infinite). Instead of same pause time, "exponential" value of "retryPauseType" can be used - each next time pause time doubles. When timeout value is set to 0 retrying is infinite. In case of invalid or missing values defaults are used: for pause time 30 seconds and for timeout 0 (infinite).

Ultimate control is given by "converter" and "deliverer" properties. Either beans of predefined or custom classes can be used (see "Programming syle" chapter for more details). Example below shows custom class using different transport protocol than default:
{code:xml}
   <bean id="soapDeliverer" ...
   ...
   <bean class="org.apache.cxf.management.web.logging.atom.AtomPushBean" init-method="init">
       <property name="deliverer">
           <ref bean="soapDeliverer"/>
       </property>
       <property name="loggers" ... />
   </bean>
{code}
Note that specifying custom deliverer cause ignoring "url" and "retryXxx" because underneath configuration replaces employed tandem of RetryingDeliverer and WebClientDeliverer with provided one.

When ATOM feeds must be delivered to more than one endpoint and additionally each endpoint is fed by different loggers simply use multiple ATOM push beans in Spring config:
{code:xml}
   <bean id="atom1" class="org.apache.cxf.management.web.logging.atom.AtomPushBean" init-method="init">
       <property name="url" value="http://someplace.com/foo/bar"/>
       ...
   </bean>
   <bean id="atom2" class="org.apache.cxf.jaxrs.management.web.atom.AtomPushBean" init-method="init">
       <property name="url" value="http://otherplace.com/baz/blah"/>
       ...
   </bean>
   ....
{code}

h3. Properties file
When CXF is used either without Spring or logging is configured with properties file, support for this type of configuration becomes handy. ATOM push handler supports "simple configuration" with properties file; simple means aligned to expressiveness of JUL configuration that is limited to cases, where each type of handler can be used only once and registered with root logger.

Set of properties is very similar to Spring configuration with following exceptions:
* Properties specify classes of custom deliverers and converters, instead of instances.
* Custom deliverer must have public constructor with the only String parameters; created instance will have passed URL of client.
* Multiple client endpoints is not supported out of the box (cannot instantiate multiple handlers as in Spring)

Example:
{code}
 handlers = org.apache.cxf.management.web.logging.atom.AtomPushHandler, java.util.logging.ConsoleHandler
 .level = INFO
 ...
 org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.url = http://localhost:9080
 org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.batchSize = 10
 org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.deliverer = WebClientDeliverer 
 org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.converter = foo.bar.MyConverter
 org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.retry.pause = linear
 org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.retry.pause.time = 10
 org.apache.cxf.jaxrs.ext.management.web.AtomPushHandler.retry.timeout = 360
 ...
{code}

h3. Programming style
In most complex cases direct programming using {{[org.apache.cxf.jaxrs.ext.logging.atom|http://cxf.apache.org/javadoc/latest/org/apache/cxf/management/web/logging/atom/package-summary.html]}} package may be necessary. In this case AtomPushHandler class is main artifact and Deliverer and Converter interfaces and their implementations are necessary components.

Following example:
{code}
    Deliverer d = new WebClientDeliverer("http://somewhere.com/foo/bar");
    d = new RetryingDeliverer(d, 300, 60, true);
    Converter c = new SingleEntryContentConverter();
    AtomPushHandler h = new AtomPushHandler(1, c, d);    
    Logger l = Logger.getLogger("org.apache.cxf.jaxrs");
    l.setLevel(Level.INFO);
    l.addHandler(h);
{code}
is equivalent to Spring configuration:
{code}
   <bean class="org.apache.cxf.management.web.logging.atom.AtomPushBean" init-method="init">
       <property name="url" value="http://somewhere.com/foo/bar"/>
       <property name="logger" value="org.apache.cxf.jaxrs" />
       <property name="level" value="INFO" />
       <property name="retryPause" value="linear" />
       <property name="retryPauseTime" value="60" />
       <property name="retryTimeout" value="300" />
   </bean>
{code}

h2. Poll Style

[AtomPullServer|http://svn.apache.org/repos/asf/cxf/trunk/rt/management-web/src/main/java/org/apache/cxf/management/web/logging/atom/AtomPullServer.java] acts as an Atom feed endpoint and makes all log events it has accumulated or read from some external storage available for polling.

Log events are made available in pages, that is a feed instance will list up to a configurable maximum number of entries and will also include atom links of types 'prev', 'next', 'first' and 'last', thus making it possible to browse through all the log records.

h3. Spring configuration

When configuring AtomPullServer endpoints, one can set the 'loggers' property the same way as it is done for AtomPushBeans, for example :

{code:xml}
   <bean class="org.apache.cxf.management.web.logging.atom.AtomPullServer" init-method="init">
       <property name="loggers" value="
           org.apache.cxf:DEBUG,
           org.apache.cxf.jaxrs,
           org.apache.cxf.bus:ERROR,
           myNamedLogger:INFO" />
       <property name="pageSize" value="30"/>
   </bean>
{code}

In addition to the 'loggers' property, a 'pageSize' property limiting a number of entries per page to 30 is also set (default is 40).

One can have a [ReadWriteLogStorage|http://svn.apache.org/repos/asf/cxf/trunk/rt/management-web/src/main/java/org/apache/cxf/management/web/logging/ReadWriteLogStorage.java] bean injected into AtomPushBean if the log records have to be periodically offloaded from memory and persisted across restarts :

{code:xml}
   <bean id="storage" class="org.apache.cxf.systest.jaxrs.JAXRSLoggingAtomPullSpringTest$Storage"/>

   <bean class="org.apache.cxf.management.web.logging.atom.AtomPullServer" init-method="init">
       <property name="loggers" value="org.apache.cxf.jaxrs" />
       <property name="maxInMemorySize" value="400"/>
       <property name="storage">
           <ref bean="storage"/>
       </property>
   </bean>
{code}

When a number of records in memory reaches 400 (default is 500) then the records will be offloaded into a provided storage and will be read from it after the restart or when a client has requested a relevant page. If no storage is available then after an in-memory limit is reached the oldest records will be discarded, one can set a maxInMemorySize property to a large enough value if needed.

Another option is to require a given AtomPullServer to read from the external read-only storage by registering a [ReadableLogStorage|http://svn.apache.org/repos/asf/cxf/trunk/rt/management-web/src/main/java/org/apache/cxf/management/web/logging/ReadableLogStorage.java] bean. For example, very often, the runtime is already logging to some external file, thus AtomPullServer can be asked to read from this file only with the help of ReadableLogStorage, without AtomPullServer having to catch log events too. 

Once AtomPullServer has been configured, it has to be registered as a service bean with the jaxrs endpoint so that Atom aware clients (blog readers, etc) can start polling it :
{code:xml}
<jaxrs:server id="atomServer" address="/atom">
 <jaxrs:serviceBeans>
   <ref bean="atomPullServer"/>
 </jaxrs:serviceBeans>

 <jaxrs:providers>
  <ref bean="feed"/>
  <ref bean="entry"/>
 </jaxrs:providers>
</jaxrs:server>

<bean id="feed" class="org.apache.cxf.jaxrs.provider.AtomFeedProvider"/>
<bean id="entry" class="org.apache.cxf.jaxrs.provider.AtomEntryProvider"/>
{code}

h3. Linking to Atom endpoints from CXF Services page

If you would like your users to find about the Atom feeds which are collecting log events from your endpoints then AtomPullServers will need to have a CXF bus injected, as well as be told about the address of the corresponding atom feed endpoint and of the jaxrs or jaxws endpoint :

{code:java}
<bean id="atomPullServer" class="org.apache.cxf.management.web.logging.atom.AtomPullServer" init-method="init">
<property name="loggers" value="org.apache.cxf.systest.jaxrs.JAXRSLoggingAtomPullSpringTest$Resource:ALL"/>
<property name="bus">
<ref bean="cxf"/>
</property>
<!-- this is a jaxrs:server/@adrress or jaxws:endpoint/@address of the endpoint generating the log events -->
<property name="endpointAddress" value="/resource"/>
<!-- this is a jaxrs:server/@address of the endpoint for which this atomPullServer bean is registered as a service bean -->
<property name="serverAddress" value="/atom"/>
</bean>
{code}