Persistent CDF Tracing Enabler - For Citrix Windows Receiver
Article ID: CTX141067
Updated On:
Description
Persistent CDF Tracing Enabler - For Citrix Windows Receiver
Created Date: July 2014
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
Persistent CDF Tracing Enabler will allow you to set up and configure CDF tracing before an issue has been identified. This will save efforts required for reproducing the problem. Win-ReceiverTrace.ps1 PowerShell script will allow users to enable persistent CDF tracing for all modules in Citrix Windows Receiver. By default, the Win-ReceiverTrace.ps1 script uses the built in Windows tool logman.exe to manage the collection of trace messages emitted by Citrix components (CDF traces) to a cyclic buffer with a specified maximum buffer size (100 megabytes by default). All CDF trace messages are captured by default, with the exception of some specified CDF module name patterns. See the $blacklist parameter in the screenshot below.
Prerequisites
• Operating System: Windows XP or higher with PowerShell installed.
• Before running the script, Execution Policy in PowerShell must be set to “Unrestricted”. See “How to use…” section.
• This script must be run with Administrative privileges.
• On Microsoft Windows Vista and Windows 2008, with UAC enabled, trace capture requires elevation.
Installing Persistent CDF Tracing Enabler
To setup CDF Trace capture, Copy Win-ReceiverTrace.ps1 to the desired location. There is no installer required. If Windows Receiver is not installed at default location (Program files) then CTL file location need to be specified as a parameter. Please see “How to use…” section.
How to Use Persistent CDF Tracing Enabler
- Launch PowerShell. (Launch using “Run as admin”, if needed)
- Change path to downloaded Win-ReceiverTrace.ps1 script
- Type Get-ExecutionPolicy.
- If the result is "Restricted". Type Set-ExecutionPolicy Unrestricted.
- Type y.
- Type .\Win-ReceiverTrace.ps1
- If Receiver is not installed at default location (Program files) then either specify the Ctl file path as a parameter. .\Win-ReceiverTrace.ps1 –ctlLocations <Full file path of CTL file> OR Copy the IcaClientTraceProviders.ctl file in the current directory. CTL file can be found in the Receiver install folder.
- Default location of output trace file in “C:\logs\RcvrLogs.etl” which can be changed using -fileName parameter.
- Type Set-ExecutionPolicy Restricted.
- Type y.
Additional Options:
1. To review advanced options and parameters details, run the script with –help option.
2. To stop trace collection, run the script with –stop option.
3. To debug issues with script, run the script with –verbose option.
Once persistent CDF tracing is enabled and running, you can enable or disable and view the status using performance monitor. See the screen shots below:
Performance Monitor -> Data Collector Sets -> Startup Event Trace Sessions
Performance Monitor -> Data Collector Sets -> Event Trace Sessions
Security Permissions Required by Persistent CDF Tracing Enabler
Administrative permissions are required for all features to be functional.
Data Modified by Persistent CDF Tracing Enabler
Persistent CDF Tracing Enabler creates an Event Trace session which is persistent across system restart. It also generate trace file at the default location specified above in the screenshot or at the location specified by the –fileName parameter.
This script also creates a temporary file to store CDF guids to be used by the script to setup Event trace session which is deleted automatically after use.
Uninstalling Persistent CDF Tracing Enabler
To uninstall Persistent CDF Script and undo changes made to the system, run the script again with –stop parameter and delete the script and trace files generated by script.
Contact Information
Questions? Concerns? Send any feedback for this tool to supporttools@citrix.com.
Disclaimer
The above mentioned sample code is provided to you as is with no representations, warranties or conditions of any kind. You may use, modify 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 sample code 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 sample code 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 sample code. 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 SAMPLE CODE, INCLUDING WITHOUT LIMITATION DIRECT, SPECIAL, INCIDENTAL, PUNITIVE, CONSEQUENTIAL OR OTHER DAMAGES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Although the copyright in the code belongs to Citrix, any distribution of the code should include only your own standard copyright attribution, and not that of Citrix. You agree to indemnify and defend Citrix against any and all claims arising from your use, modification or distribution of the code.
Additional Information
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.
