Article ID: 907490
Article Last Modified on 1/2/2008
APPLIES TO
- Microsoft Dynamics CRM 4.0
- Microsoft Dynamics CRM 3.0
INTRODUCTION
This article describes how to enable tracing in Microsoft Dynamics CRM.
MORE INFORMATION
Microsoft Dynamics CRM lets you create trace files that monitor the actions that are performed by Microsoft CRM. Trace files are helpful when you have to troubleshoot error messages or other issues in Microsoft CRM.
You can create unmanaged trace files and managed trace files. The information in the unmanaged trace files and in the managed trace files is determined by required and optional registry entries that you create manually. You create these registry entries on the Microsoft CRM server or on the computer that is running the Microsoft CRM client for Microsoft Office Outlook after you install Microsoft CRM or the Microsoft CRM client for Outlook.
The following are the required registry entries. For more information about the location of these registry entries, see the "Registry entry locations" section.
| Name | Type | Data value | Notes |
|---|---|---|---|
| TraceEnabled | DWORD | A value of 0 or 1 | If you use a value of 0, tracing is disabled. If you use a value of 1, tracing is enabled. |
| TraceDirectory | String | C:\CRMTrace
|
The TraceDirectory registry entry specifies the directory for the trace log files. The directory must exist, and the user who starts the Microsoft CRMAppPool must have full control over this directory. When you install Microsoft CRM, the default user is NT AUTHORITY\NETWORK SERVICE. |
| TraceRefresh | DWORD | A number between zero and 99 | When the data is changed, the trace settings in the other trace registry entries are applied. |
The following are the optional registry entries.
| Name | Type | Data value | Notes |
|---|---|---|---|
| TraceCategories | String or Multi-String | Category.Feature:TraceLevel
|
The TraceCategories registry entry is a combination of a category, a feature, and a trace level. You can specify multiple categories, features, and trace levels. Separate each combination by using a semicolon. For a list of categories, features, and trace levels and for sample combinations that are valid, see the "Trace level values" section. |
| TraceCallStack | DWORD | A value of 0 or 1 | If you use a value of 0, the call stack is not included in the trace file. If you use a value of 1, the call stack is included in the trace file. |
| TraceFileSizeLimit | DWORD | A size between 1 and 100 megabytes | The TraceFileSizeLimit registry entry specifies the maximum size of trace files. New files are created when the limit is reached. |
If you do not create the optional registry entries, the default data values are used. For more information about the default data values, see the "Default data values for optional registry entries" section. If you create the registry entries but do not specify data values for the registry entries, tracing will not work.
Note When you create a trace in Microsoft Dynamics CRM 4.0, the TraceDirectory registry key is ignored. The trace log file is created in the following directory:
Drive:\Program Files\Microsoft Dynamics CRM\Trace
Registry entry locations
The Microsoft CRM server tracing registry entries are located in the following registry subkey:
HKEY_LOCAL_MACHINE\SOFTWARE\MICROSOFT\MSCRM
The Microsoft CRM client for Outlook tracing registry entries are located in the following registry subkey:
HKEY_CURRENT_USER\SOFTWARE\MICROSOFT\MSCRMClient
Complete list of category values for the TraceCategories registry entry
- *
- Application.*
The Application.* category includes the following:
- Application.Outlook
- Exception
- ObjectModel
- ParameterFilter
- Platform.*
The Platform.* category includes the following:
- Platform.ImportExportPublish
- Platform.Sdk
- Platform.Metadata
- Platform.Sql
- Platform.Workflow
- Platform.Soap
- SchedulingEngine.*
- Unmanaged.*
The Unmanaged.* category includes the following:
- Unmanaged.Outlook
- Unmanaged.Platform
- Unmanaged.Sql
Trace level values
Complete list of valid trace level values for TraceCategories
- Off
- Error
- Warning
- Info
- Verbose
Note A message is logged only if the trace level for the category is equal to or greater than the level of the message. For example, a trace level of Warning logs messages that have a level of Warning and of Error. A trace level of Info logs messages that have a level of Info, of Warning, and of Error. A trace level of Verbose logs all messages. You should only use a trace level of Verbose for short durations.
Sample category and trace level combinations
- *:Verbose
Note The *:Verbose combination logs all messages in all categories. You should only use the *:Verbose combination for short durations.
- Application.*:Error
Note The Application.*:Error combination logs all messages that have a level of Error for the Application.* category.
- Platform.*:Warning
Note The Platform.*:Warning combination logs all messages that have a level of Warning or Error for the Platform.* category.
Default data values for optional registry values
- TraceCategories: *:Error
- TraceCallStack: 0
- TraceFileSizeLimit: 5
How to enable scheduled tracing
- Set up the trace. When you set up the trace, enter all the required values. However, leave the TraceEnabled registry entry set to 0.
- Create a registry file that enables the trace. To do this, start Notepad, copy the following information to the document in Notepad, and then save the document as a .reg file:
Windows Registry Editor Version 5.00 HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\MSCRM] “TraceEnabled”=dword:00000001
- Create a batch file that calls the .reg file. To do this, open a new document in Notepad, and then copy the following lines to the document in Notepad.
Note In the lines that you copy, replace the<C:\Enable.reg>placeholder with the path and the file name of the actual .reg file that you created in step 2.@echo off
regedit /s "<C:\Enable.reg>"
exit - In Control Panel, add a new scheduled task that runs the new batch file that you created in step 3. Schedule the task for the time at which you want the trace to run.
How to disable scheduled tracing
- Create a registry file that disables the trace. To do this, start Notepad, copy the following information to the document in Notepad, and then save the document as a .reg file:
Note You must change the value of the TraceRefresh registry entry. If you do not change the value of the TraceRefresh registry entry, the trace will not be disabled.
Windows Registry Editor Version 5.00 HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\MSCRM] “TraceEnabled”=dword:00000000 "TraceRefresh"=dword:00000003
- Create a batch file that calls the .reg file. To do this, open a new document in Notepad, and then copy the following lines to the document in Notepad.
Note In the lines that you copy, replace the<C:\Disable.reg>placeholder with the path and the file name of the actual .reg file that you created in step 2.@echo off
regedit /s "<C:\disable.reg>"
exit - In Control Panel, add a new scheduled task that runs the new batch file that you created in step 3. Schedule the task for the time at which you want the trace to be disabled.
Additional query words: Log Trace Error Report Unmanaged Managed
Keywords: kbcrmv3c kbmbsmigrate kbinfo KB907490
