How to collect CDF Logs using CDF Control for easily reproducible issues
Article ID: CTX695202
Updated On:
Description
.Follow the below steps to collect CDF logs:
1. Download CDFControl (the Citrix Diagnostic Facility tool) from Citrix’s official tools site https://www.citrix.com/downloads/citrix-tools .
2. Unzip and launch CDFControl.exe with administrator privileges. It must be run as a user with Administrative privileges for all features to be functional.
3. Go to Tools → Options → Trace File Path and set the path for log collection.
4. Select Multiple Sequential Log option. Refer the below details about other logging options:
- Circular Log:
Events are written to the log file, trimming off the oldest events to accommodate for the newer events when log file max is reached. - Sequential Log:
Tracing stops when log file max is reached. - Multiple Sequential Logs (newfile):
Creates a new trace file when the max is reached for the original. This is very useful for capturing an intermittent issue, without fear of capturing an extremely large trace file.
5. When using the Multiple Sequential Log option, enable the "Use a ring buffer with" checkbox if you want to utilize a circular buffer for capturing intermittent or hard-to-reproduce issues.
6. Specify the Max Log Size for the file. By default, it is set to 50 MB. For most scenarios, the size of 250 MB works well.
7. Specify the number of files. By default, it is set to 10. In the below example, If "Use a ring buffer with" option is selected with 10 files. The oldest file in the trace folder will be overwritten once 10 files of 50 MB each are created.
8. Click "Save" after making all the changes.
9. Select the required modules from the "Trace Categories" drop down list:
10. Click "Start Tracing".
11. Reproduce the issue.
12. Click "Stop Tracing".
13. After tracing is stopped, the "Trace Summary" screen appears, displaying the locations of all supplementary files captured alongside the CDF logs.
14. Review these logs and share them with Citrix Support.
Environment
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
Issue/Introduction
CDFControl is an event tracing tool geared towards capturing Citrix Diagnostic Facility (CDF) trace messages that are output from the various Citrix tracing providers.
This article provides steps to collect CDF logs using CDF Control tool when the issue is easily reproducible.
