The CDFControl utility is an event tracing controller or consumer for capturing Citrix Diagnostic Facility (CDF) trace messages displayed from various Citrix tracing providers. It is intended to troubleshoot complex Citrix-related issues, parse filter support, and collect performance data. To download the CDFControl utility, see CTX111961.
1.Select the Trace Categories recommended by Citrix Support. (In the following example, Graphics Redirection is selected. That selection is only an example. We recommend that you enable the providers for the specific issue you are troubleshooting.)
2. From Tools→Options, confirm or provide 'Trace file path (for capturing trace)'.
3. Select the checkbox for "Use a ring buffer with" when using Multiple Sequential Log option if you wish to use circular/ring buffer in scenarios where the issue is intermittent and not easily reproducible.
Note
Ring Buffer :
Ring Buffer tracing is a method whereby trace logs are held in a buffer file or set of files that are a fixed size. When this buffer file fills up, the oldest data is "overwritten" in order for the file to be kept to a predefined size. The obvious advantage of this method is the conservation of disk space as compared to the multiple sequential file method. Circular tracing is also useful when the issue is not readily reproducible and is more intermittent.
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.
4. Select Tools→CDFControl Service to launch the CDFControl service manager UI.
5. Install and manage the service using the pop-up dialog box.
Note:
The 'Install Service' option installs and starts the service.
The 'Uninstall Service' option stops and uninstalls the service
6. After the issue is reproduced, stop or uninstall the service as needed.
7. Check and upload the trace logs from the configured path. The traces will be output to the CDFControl_Service_Log_<*> folder.
Installing CDFControl as a service using the command line
1.Similar to the UI option, starting CDFControl from the command line requires the trace guids to be supplied. This can be done via a .ctl file. Either create a .ctl file manually or use an existing one provided in the “TraceControllers” folder.
2. The following two bold parameter arguments must be supplied to run CDFControl as a service:
-installservice (installs CDFControl as a service)
-guids (the path/name of file containing GUIDs must be present.)
-path (specifies the output path for capturing trace logs.If not specified, the 'logpath' parameter from cdfcontrol.xml will be used.)
3. CDFControl.exe -installservice -guids TraceProvider.ctl -path c:\temp\trace\
4. After the issue is reproduced, stop or uninstall the service as needed.
CDFControl.exe -startservice
CDFControl.exe -uninstallservice
Note: To suppress the command line outputs, “-noprompt” can be supplied optionally as an argument.
5. Check and upload the trace logs from the configured path. Traces will be output to the CDFControl_Service_Log_<*> folder.
The trace session name used by the CDFControl service is "CDFCONTROL_TRACE_SESSION".
In the back end, service files are installed to C:\Windows\Cdfcontrol and removed when uninstalled.
Service name is 'CDFControlSvc'.
1.Make sure that trace configuration options are done prior to installing CDFControl as a service. If you need to make further configuration updates after the service has been installed, proceed by uninstalling the service, making necessary configuration updates and reinstalling the service.
2. Check the provided “Trace file path” for trace logs.
3. Verify that Citrix CDFControl is showing as running in the service control panel.
4. Verify that CDFControl.exe is not blocked by AV/Windows Defender.
5. After you run the Uninstall command if the CDFControl service shows as disabled in the service control panel. From the command line run : sc delete "CDFControlSvc",to remove the service manually.