ESB Toolkit Tip #15 Enable the ESB Toolkit trace switch in the Machine.config file

When you start developing with the ESB Toolkit it can be difficult to debug an error in an itinerary. When an exception occurs, you can see the error in the Event Viewer, in the BizTalk Administration Console (if you don't use the ESB Exception Management Framework) ore in the Management Portal but sometimes this information is not enough because you want to see which steps are already done in the itinerary and want to trace exactly when and where the error occurs.
Fortunately you can enable tracing in the ESB Toolkit and trace the steps inside the Itinerary.

The following information can be traced in the ESB Toolkit:

  • If the Itinerary could be resolved
  • Which Itineray is attached to the message
  • What the Document Message Type is
  • If a Resolver or Adapter Provider is stored in the Cache
  • Activities inside an Itinerary Service
    • Initializing
    • Resolver information
    • Adapter information
      • Endpoint information


Use a tool like DebugView to see the trace output. DebugView is an application that lets you monitor debug output on your local system, or any computer on the network that you can reach via TCP/IP.



How to configure diagnostics and trace information

To enable the Microsoft BizTalk ESB Toolkit trace switch, add the following <switches> element to the system.diagnostics section of the machine.config file.

          <add name="BizTalkESBToolkit" value="4"/>

In every version of the ESB Toolkit is the switch name a little different. In previous versions it was "BizTalkESBToolkit" with the version number appended to it but in BizTalk 2013 it is only "BizTalkESBToolkit". Unfortunately, the documentation of the ESB Toolkit is not updated every version so beware that if you copy and paste the switches element from the documentation you have to change the switch name.


See Also

For more information on configuring diagnostics and trace information see:

About the author

Tomasso Groenendijk lives in Netherlands and is a senior integration consultant at Motion10. He has over 15 years’ experience in software development and software design. Tomasso is specialized in application integration with a strong interest in the Windows Azure cloud platform. In 2014, 2015 and 2016 Tomasso was awarded with the Microsoft Azure MVP award. He is an active contributor to the integration community through his work on his blog, MSDN samples, TechNet Wiki and also speaking on events.

MVP profile Tomasso Groenendijk
Sentinet Product Specialist
BizTalk360 Product Specialist

Month List