Click here to Skip to main content
Click here to Skip to main content

Simple Steps to Enable Tracing in WCF

, 13 Jul 2012
Rate this:
Please Sign up or sign in to vote.
Simple steps to enable tracing in WCF

Introduction

Tracing mechanism in Windows Communication Foundation is based on the classes that reside in System.Diagnostic namespace. Important classes are Trace, TraceSource and TraceListener.

Following are the steps to enable tracing in WCF:

  1. Configuring WCF to emit tracing information/Define Trace Source, we have the following options:
    • System.ServiceModel
    • System.ServiceModel.MessageLogging
    • System.ServiceModel.IdentityModel
    • System.ServiceModel.Activation
    • System.Runtime.Serialization
    • System.IO.Log
    • Cardspace

    In configuration file, we will define a source to enable this configuration as follows:

    <source name="System.ServiceModel.MessageLogging">
  2. Setting Tracing Level, we have the following available options, we need to set this tracing level to available options other than default "Off":
    • Off
    • Critical
    • Error
    • Warning
    • Information
    • Verbose
    • ActivityTracing
    • All

    In configuration file, we can choose the above values for switchValue attribute as follows:

    <source name="System.ServiceModel.MessageLogging"
                                   switchValue="Information">
  3. Configuring a trace listener:

    For configuring a trace listener, we will add the following to config file.

    <listeners>
        <add name="messages"
                type="System.Diagnostics.XmlWriterTraceListener"
                initializeData="d:\logs\messages.svclog" />
    </listeners>
  4. Enabling message logging:
          <system.serviceModel>
             <diagnostics>
                <messageLogging 
                        logEntireMessage="true" 
                        logMalformedMessages="false"
                        logMessagesAtServiceLevel="true" 
                        logMessagesAtTransportLevel="false"
                        maxMessagesToLog="3000"
                        maxSizeOfMessageToLog="2000"/>
             </diagnostics>
           </system.serviceModel>
    • logEntireMessage: By default, only the message header is logged but if we set it to true, the entire message including message header as well as body will be logged.
    • logMalformedMessages: This option logs messages that are rejected by WCF stack at any stage known as malformed messages.
    • logMessagesAtServiceLevel: Messages those are about to enter or leave user.
    • logMessagesAtTransportLevel: Messages those are about to encode or decode.
    • maxMessagesToLog: Maximum quota for messages. Default value is 10000.
    • maxSizeOfMessageToLog: Message size in bytes.

Finally, putting all this together, the configuration file will appear like this:

 <system.diagnostics> 
   <sources>
      <source name="System.ServiceModel.MessageLogging">
        <listeners>
          <add name="messagelistener"
               type="System.Diagnostics.XmlWriterTraceListener" 
                      initializeData="d:\logs\myMessages.svclog"></add>
        </listeners>
      </source>
    </sources>
  </system.diagnostics> 
  <system.serviceModel>       
      <diagnostics>
        <messageLogging logEntireMessage="true"
                        logMessagesAtServiceLevel="false"
                        logMessagesAtTransportLevel="false"
                        logMalformedMessages="true"
                        maxMessagesToLog="5000"
                        maxSizeOfMessageToLog="2000">         
        </messageLogging>
      </diagnostics>
  </system.serviceModel>

Note: In this case, information will be buffered and not published to file automatically. So, we can set the autoflush property of the trace under sources as follows:

<trace autoflush ="true" /> 

Other Top WCF Tutorials

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Imran Abdul Ghani
Software Developer (Senior)
United Arab Emirates United Arab Emirates
Imran Abdul Ghani has more than 10 years of experience in designing/developing enterprise level applications. He is Microsoft Certified Solution Developer for .NET(MCSD.NET) since 2005. You can reach his blogging at WCF Tutorials, Web Development.
Follow on   Twitter   Google+   LinkedIn

Comments and Discussions

 
QuestionMore options for logging Pinmemberkatrash17-Jul-12 6:33 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web04 | 2.8.140721.1 | Last Updated 13 Jul 2012
Article Copyright 2012 by Imran Abdul Ghani
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid