CDFMarker On Demand - For XenApp and XenDesktop
Article ID: CTX124577
Updated On:
Description
Created: March 2010
Modified: October 2010
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
CDFMarker is a small utility which allows you to send a customizable CDF trace statement into a running CDF trace, on demand, on either XenApp Servers or XenDesktop Virtual Desktop Agents.
There are three main use cases for CDFMarker:
There could be a delay between when you start your CDF trace and when you actually encounter the event which you are interested in. During this time, thousands of CDF trace statements could have been written to the trace. CDFMarker lets you send a CDF trace statement on demand, so you could send a message just before the event occurs, and another just after it. You can then just search for the CDFMarker CDF statements and get straight to the area of the trace you are interested in.
If you are running a circular CDF trace and are waiting for an event to occur, it can be difficult to figure out exactly where in the CDF trace you should be looking. If you have CDFMarker running in the System Tray, you can press the hotkey (Ctrl+M) or double click the System Tray icon to quickly send a message into the trace to mark the event.
You can use CDFMarker from the command line along with Performance Monitor Alerts to send a CDF trace message whenever a specific event occurs, in the same way Performance Monitor can be used with Userdump to create dumps of spiking processes (see CTX117428 - How to Use PerfMon and Userdump to Capture Intermittently Spiking Process Dumps).
- Citrix Knowledgebase documents many more additional use cases.
Prerequisites
CDFMarker runs on any Citrix platform on which a CDF trace on the module MF_Hook_MMHook is possible (such as: XenApp Servers or XenDesktop Virtual Desktop Agents.)
Installing CDFMarker
CDFMarker is a stand alone executable. There is no installation routine, just copy the CDFMarker.exe file to the target system being traced, and run it.
How to Use CDFMarker
When you run it, the application places an icon in the System Tray:
There are five ways to send the CDF Trace Statement:
- a hotkey (Ctrl+M)
- clicking on the System Tray icon
- clicking on the System Tray icon and selecting Send CDF Trace Message from the popup menu
- the Command Line, by passing a string to be used in the CDF Trace Statement, such as c:\cdfmarker.exe Hello!
- the Command Line, by piping the output of one process to CDFMarker as input i.e. at a Command Prompt type:
C:\echo "Up the Dubs!" | C:\cdfmarker.exe
- results in the following CDF Message being posted to the running CDF trace:
CDFMarker: "Up the Dubs!"
When a CDF Statement has been written by CDFMarker, the System Tray icon briefly displays a yellow ‘x’ to indicate that the statement has been sent.
The CDF Trace is gathered in the normal way. You must ensure that you include the CDF module MF_Hook_MMHook as part of the set of CDF modules being traced. This is because CDFMarker outputs its CDF statements to the MF_Hook_MMHook module.
The included TMF files must be used when later parsing the captured CDF trace to be able to read the inserted CDFMarker statements.
Security Permissions Required by CDFMarker
None.
Data Modified by CDFMarker
CDFMarker is a stand alone executable. It does not write to the registry or create any files other than the CDFMarker.exe executable itself.
Uninstalling CDFMarker
To remove CDFMarker, exit the tool if it is running (right click on the System Tray icon and select Exit), and then delete CDFMarker.exe.
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.
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.
