Enabling Logging for Citrix XenDesktop
Posted on June 06, 2009 in Documentation tagged with Citrix, logging, troubleshooting, vdi, XenDesktopWhen troubleshooting problems, it’s essential you have as much information is possible. Logging is the best passive way to achieve this. Even in these modern times, we’re editing files in Notepad…
Virtual Desktop Agent Logging
1. Create a new directory called c:\ctxlogging\. The Network and Local service accounts should have write access. If you are using standard vDisks, I recommend putting the log file on local storage so that it persists after log out.
2. Navigate to c:\Program Files\Citrix\Virtual Desktop Agent\
3. Open WorkstationAgent.exe.config with your Text Editor of Choice.
4. Find the <appSettings> tag.
5. Within the <appSettings> tag, insert the following two lines:
<add key="LogToCDF" value ="1"/> <add key="LogFileName" value ="C:\ctxlogging\vda.log"/>
6. Restart the Virtual Desktop to start logging.
Desktop Delivery Controller Logging
1. Create a new directory called c:\ctxlogging\. The Network and Local service accounts should have write access.
2. Navigate to c:\Program Files\Citrix\VMManagement\
3. Open CdsPoolMgr.exe.config with your Text Editor of choice.
4. Find the <appSettings> tag.
5. Within the <appSettings> tag, insert the following two lines:
<add key="LogToCDF" value ="1"/> <add key="LogFileName" value ="C:\ctxlogging\ddc_cdspoolmgr.log"/>
6. Navigate to c:\Program Files\Citrix\Desktop Delivery Controller\
7. Open cdscontroller.exe.config with your Text Editor of choice.
8. Find the <appSettings> tag.
9. Within the <appSettings> tag, insert the following two lines:
<add key="LogToCDF" value ="1"/> <add key="LogFileName" value ="C:\ctxlogging\ddc_cdscntrl.log"/>
10. You will need to reboot your DDC for this to take effect. If you have more than 1 DDC, perform these steps on all of them.
Some of the paths may vary depending on OS (x64) and whether you changed the default install paths during installation.
EDIT 8/23/09: Added CTX Article, http://support.citrix.com/article/CTX117452 and CTX Article for Enabling PortICA Logging http://support.citrix.com/article/CTX118837
The user Network Service will need Full Control over the log directory. While this is not officially documented by Citrix, it has been reported by others. (Thanks to Alistair Gillespie)
Why not include a link to the origonal Citrix article http://support.citrix.com/article/CTX117452 and “add value” by pointing out whats wrong with it / what can be done better
1) ACLs for VDA log directory
Based on my experiance – VDA logging dosn’t work unless “Network Service” has Full Control of the log directory.
(this is noted in the DDC logging but crucially not for the VDA! – I’ve already complained to Citrix about this but they still havn’t updated this article – CTX117452)
2) Manual editing of the .XML
It’s crazy that Citrix dont have a better way to enable / diable logging on demand.
IMHO it should be possible to enable logging at a granular level from an admin console (or via GPO)
3) Automate enabling VDA logging.
I got fed-up with editing this file for ad-hoc troublehsooting, so knocked up a quick powershell script to open the file (as XML) and write in the correct entries.
Alistair, I’ve added the CTX article to the post. I posted this as to make the information easier to find. When it was posted I had issues finding the article via Google. Of course searching the CTX knowledge base would have yielded better results.
You are absolutely correct, Network Service does need Full Control of the logging directory. I added that to the post as well.
I also agree that Citrix needs a better way to enable logging. PVS 5.1 went in the right direction, adding it to many GUI components, but XenDesktop needs to catch up.
Thank you for your feedback, it’s much appreciated!