How to enable Transformation Server CPU and Performance Logging

Issue

I would like to enable advanced Transformation Server (TS) logging including performance for diagnostic reasons. 

 

Solution

Backup the existing configs (default location is: C:\Program Files\Kofax\TotalAgility\Transformation Server):

• Kofax.CEBPM.CPUServer.ServiceHost.exe.config
• Kofax.CEBPM.ProcessingService.Host.exe.config
• Kofax.CEBPM.DocumentConversionService.Host.exe.config
  
  In the Kofax.CEBPM.CPUServer.ServiceHost.exe.config update the system diagnostics section with the following lines:  Set the TraceLevelSwitch to All and uncomment the Performance source:
  
  Kofax.CEBPM.CPUServer.ServiceHost.exe.config

<add name="TraceLevelSwitch" value="All"/>
<source name="Performance" switchValue="All" >
        <listeners>
          <clear />
          <add name="CPUServerPerf" />
        </listeners>
      </source>

In the Kofax.CEBPM.ProcessingService.Host.exe.config and Kofax.CEBPM.DocumentConversionService.Host.exe.config files update the system diagnostics section with the following line: Set the TraceLevelSwitch to All:

 

<add name="TraceLevelSwitch" value="All"/>

By default, the logs will be generated in the Transformation Server folder:  C:\Program Files\Kofax\TotalAgility\Transformation Server. If you wish to save the logs in a different path, the initializeData can be updated to a different drive/path to save the log file.

For example:

<add name="CPUServerLogTxt" type="Kofax.CEBPM.CPUServer.Common.Diagnostics.DateTimeTaggedTraceListener, Kofax.CEBPM.CPUServer.Common" initializeData="d:\logs\KofaxCPUServerLog.log">
        <filter type="System.Diagnostics.EventTypeFilter" initializeData="All" />
 </add>

Restart the Kofax Transformation Server service and verify that the updated log file is written to the new directory.

Then replicate the behaviour to capture the advanced diagnostic logging. Please attach the Transformation Server logs to your Kofax Support case.

Important 

This should not be enabled for a long period of time and should be closely monitored as the logs can become large quickly.  Once the advanced logging information is gathered within a short time period, please ensure to revert to the original .config versions and restart the Transformation server to apply the change.

Level of Complexity 

Moderate

 

Applies to  

Product	Version	Build	Environment	Hardware
KTA 7	All	n/a	Windows	n/a

References

Add any references to other internal or external articles

​