Viewing Common Diagnostics Facility Traces Using TraceView

TraceView.exe

Note: The CDFView.exe utility previously provided in this document is no longer available. The following information describes the new utility available for viewing Citrix Diagnostics Facility (CDF) traces.

Note: A related video presentation for this is available at the Citrix VideoTips Web Site.

Description

TraceView.exe is a Microsoft utility that allows you to view the output of a diagnostics log file that is created when a CDF trace session is completed using either the MetaFrame Access Suite Console or Microsoft’s Tracelog utility.

The TraceView.exe utility converts the binary output of a CDF trace log into a readable format. This conversion process is completed by aligning the TraceView.exe utility with trace definition files supplied by Citrix. Trace definition files are in .tmf format and can be downloaded from the links in the “Installing TraceView.exe” section of this article.

Installing TraceView.exe

1. Download the Windows Driver Development Kit (DDK) ISO image from http://www.microsoft.com/whdc/devtools/ddk/default.mspx

2. Burn the ISO image to a CD-ROM.

3. Insert the CD-ROM in to the CD-ROM drive.

4. Navigate to the root directory of the CD-ROM and run setup.exe.

5. Read and accept the license agreement.

6. Select the installation directory.

7. When prompted with the list of items to install, clear all the top-level check boxes.

8. Expand the Tools for Driver Developers node.

9. Select the Software Tracing Tools check box only.

10. Confirm your selection and complete the installation.

Important: In Step 1, the CD image obtained from Microsoft may not be an exact match for the service pack of the system in which it is installed, in which case an error message is displayed when TraceView is run. For example, if the CD image currently available is for Windows Server 2003 with Service Pack 1, and the system in which it is installed already has Service Pack 2, then this error message appears:

"Required DLL missing: MSVCR70.DLL"

The solution is to copy the file msvcr71.dll on C:\Windows\System32 as msvcr70.dll

Note: To parse the information in the tracing log, you must download the proper .tmf parsing files. Use the links below to download the applicable product .tmf files. Unzip the .tmf files to a directory of your choice.

Citrix Presentation Server 4.5 TMF Files (32- and 64-bit)

Citrix Presentation Server 4.0 TMF Files

Citrix Presentation Server 4.0 64-Bit TMF Files

MetaFrame Presentation Server 3.0 TMF Files

MetaFrame XP With Service Pack 4 TMF Files

How to Use TraceView.exe

To parse and view an existing CDF log file:

1. Browse to the installation directory. The default directory is C:\WINDDK\3790.1830\tools\tracing\i386

2. Run TraceView.exe.

3. Go to File > Open Existing Log File.

4. Under the Log File Selection window, click the Log File Name button to find the .etl file you want to view.

5. Click OK.

6. In the next window, select TMF (Trace Format) Files and click OK.

7. Click Set TMF Search Path and use the location where you extracted the TMF files downloaded from the Citrix FTP site.

8. View the trace.

Uninstalling TraceView.exe

To uninstall this tool, navigate to Add or Remove Programs and remove Microsoft Windows Driver Development Kit Uninstall – 3790.1830.

Disclaimer

These software applications are provided to you as is with no representations, warranties or conditions of any kind. You may use and distribute it at your own risk. CITRIX DISCLAIMS ALL WARRANTIES WHATSOEVER, EXPRESS, IMPLIED, WRITTEN, ORAL OR STATUTORY, INCLUDING WITHOUT LIMITATION WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NONINFRINGEMENT. Without limiting the generality of the foregoing, you acknowledge and agree that (a) the software application may exhibit errors, design flaws or other problems, possibly resulting in loss of data or damage to property; (b) it may not be possible to make the software application fully functional; and (c) Citrix may, without notice or liability to you, cease to make available the current version and/or any future versions of the software application. In no event should the code be used to support of ultra-hazardous activities, including but not limited to life support or blasting activities. NEITHER CITRIX NOR ITS AFFILIATES OR AGENTS WILL BE LIABLE, UNDER BREACH OF CONTRACT OR ANY OTHER THEORY OF LIABILITY, FOR ANY DAMAGES WHATSOEVER ARISING FROM USE OF THE SOFTWARE APPLICATION, INCLUDING WITHOUT LIMITATION DIRECT, SPECIAL, INCIDENTAL, PUNITIVE, CONSEQUENTIAL OR OTHER DAMAGES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. You agree to indemnify and defend Citrix against any and all claims arising from your use, modification or distribution of the code.