About This Release

This is an early technical preview release (v1.0.0.2) of the Crash Reporter utility. This release has not been tested extensively and is not supported. Please send any feedback using the link in Contact Information section.

Where to download ?

Certain legacy Citrix tools are now available on request only. Please submit the request here - https://forms.gle/obA39PEz5qpDiSPq8

Once we verify your request, we will provide access to the download location.

Description

• The Crash Reporter utility provides an alternative way to identify fixes for crashes, without having to upload crash dump files. Crash dump files can be un-necessarily large, cumbersome, difficult to upload and often requires time to analyze.

• The Crash Reporter utility generates a text-based crash report from a memory dump (.dmp) that was collected to debug a crash.

• The resulting text file is approximately ~7KB in size, which is usually much smaller than the size of an actual crash dump file (which can be as large as 128GB depending on RAM and configuration). 

• For crash dump debugging, typically only the exception header and call-stack is needed to check if the crash matches a known issue.

• Citrix Technical Support can use the text files generated by Crash Reporter, instead of the crash dumps, to determine if the crash pattern matches a known issue, and provide recommendations - if any.

• It does not completely remove the need for uploading crash dump files, as they are still required in some cases where additional debugging is needed.

• If you are planning on opening a Citrix Technical Support case to debug a crashing server or application, you may consider uploading these text-based crash reports when contacting Citrix Technical Support - instead of the actual crash dump files.

Prerequisites

No prerequisites. By default, Crash Reporter utilizes the debugging libraries that ships with the operating system.

However, you can achieve optimal functionality by using the newest debugging libraries available from Microsoft.

Important: As a security best practice and for performance considerations, Citrix recommends to run the tool from a dedicated workstation that’s intended for debugging purposes. This avoids having to install the ‘Debugging Tools for Windows’ package on a production server.

On a workstation that’s dedicated for debugging - It’s recommended to install the newest version of the ‘Debugging Tools for Windows’ and then place the corresponding x64/x86 Crash Reporter binaries in the same directory as the WinDbg.exe binaries. For example, if the Debugging Tools for Windows installs to:

    C:\Program Files (x86)\Windows Kits\10\Debuggers 

Then copy the respective x86/x64 ccr.exe, scandbg.dll & ccrutils.dll binaries to the corresponding ‘ Debuggers’ sub-folder below:

    C:\Program Files (x86)\Windows Kits\10\Debuggers\x86

    C:\Program Files (x86)\Windows Kits\10\Debuggers\x64

Then you can run ccr.exe directly from that location to make use of the newest debugging libraries.

At the time of writing this article, the Debugging Tools for Windows could be obtained from the Windows 10 SDK package. The Windows 10 SDK does not need to be install, as the Debugging Tools for Windows package can be explicitly selected for download. See this link: https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/debugger-download-tools 

Quoting the above article:

“If you just need the Debugging Tools for Windows 10, and not Windows Driver Kit (WDK) for Windows 10 or Visual Studio 2017, you can install the debugging tools as a standalone component from the Windows SDK. In the SDK installation wizard, select Debugging Tools for Windows, and deselect all other components.

• Get Debugging Tools for Windows (WinDbg) from the SDK: Windows 10 SDK.”

Installing Crash Reporter

Please note: It’s recommended to run the tool from a dedicated workstation intended for debugging purposes, so it does not impact any production machines.

No installation is required. Simply copy the Crash Reporter files to any desired location on the system and execute from there. There are 3 required files and they all need to exist in the same directory:

• ccr.exe

• scandbg.dll

• ccrutils.dll

Please refer to the section Prerequisites above for details on how to use Crash Reporter together with the Debugging Tools for Windows.

How to Use Crash Reporter

To run the tool, double-click on the ccr.exe executable.

To generate the crash report from the memory dump (.*dmp) file:

• Click on the File menu and then click on the Extract Crash Report sub-menu

• Choose a crash dump file to verify (this may take several minutes) and view the results

• Once the process is complete, you will be prompted to save the output to a text file:

• Alternatively you may manually copy the results from the main app window and paste it into a new text file and save it

• Once you have the crash report saved as a text file, you may provide this to Citrix Technical Support to investigate the cause of the crash

Security Permissions Required by Crash Reporter

User account permission is sufficient.

Data Modified by Crash Reporter

Crash Reporter doesn't modify any data on the system. It may utilize temporary symbol files which are cached in the Windows Temp directory. 

How to Undo the Changes Made by Crash Reporter

• Delete any temporary symbol files in the default Windows Temp directory

• Delete the following binaries:

    - ccr.exe

    - scandbg.dll

    - ccrutils.dll

Uninstalling Crash Reporter

• Delete any temporary symbol files in the default Windows Temp directory

• Delete the following binaries:

    - ccr.exe

    - scandbg.dll

    - ccrutils.dll

Known Issues

List known issues here

Contact Information

Questions?  Concerns?  Send any feedback for this tool to supporttools@citrix.com

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.