Skip to main content

XTM Connect – Sitecore User Guide for Administrators

Separating XTM Connect log entries from Sitecore log entries

In Sitecore, XTM Connect and internal Sitecore log entries are stored in the same place, by default. XTM Connect log files need to be kept separate to improve and speed up troubleshooting. This is configured by the Administrators who manage the Sitecore system.

To configure log4net to save XTM Connect log entries to a separate file:
  1. Add a new log file ($(dataFolder)/logs/XTM.{date}.txt) with log level set to debug.

  2. Make a backup copy of the config file, App_Config\Sitecore.config.

  3. In that config file, now edit the <log4net> section:

    1. Under the <root> tag, add XTMLogFileAppender and change the priority. We recommend DEBUG.

      Note

      Other priority levels are also available. As the Administrator configuring log entries, you must decide which level is the best for you. Available levels:

      • ALL

      • DEBUG

      • INFO

      • WARN

      • ERROR

      • FATAL

      • OFF

    2. Add the XTMLogFileAppender appender.

    3. Change LogFileAppender to filter out debug entries.

<root> 
	<priority value="DEBUG" />
	<appender-ref ref="LogFileAppender" />
	<appender-ref ref="XTMLogFileAppender" />
</root>
<appender name="XTMLogFileAppender" type="log4net.Appender.RollingFileAppender">
	<file value="$(dataFolder)/logs/XTM.{date}.txt" />
	<appendToFile value="true" />
	<rollingStyle value="Size" />
	<maxSizeRollBackups value="10" />
	<maximumFileSize value="10MB" />
	<layout type="log4net.Layout.PatternLayout">
		<conversionPattern value="%4t %d{ABSOLUTE} %-5p %m%n" />
	</layout>
	<encoding value="utf-8" />
	<filter type="log4net.Filter.StringMatchFilter">
		<stringToMatch value="XTM" />
		<!-- Can filter by string or regex -->
	</filter>
	<filter type="log4net.Filter.DenyAllFilter" />
</appender>