How to enable/collect logs on WEM Agent machine
book
Article ID: CTX220635
calendar_today
Updated On:
Description
Type of logs available:
There are a number of logs that can be collected from the WEM Agent to help with troubleshooting/diagnosing an issue
Note: Please make sure to revert all changes after completing log collection.
- For logging information related to WEM Brokers, see CTX228742
- WEM Agent Session Logs: These logs are created by default in the base of the user’s profile
- Citrix WEM Agent Init.log
- This is the initialization log for the Agent; will log the Agent once the end user logs in
- If the Agent fails to start up, this log will likely contain the relevant error message
- Errors in this log are listed as Exceptions.
- Created by default after user logs in:
- Filenames: Citrix WEM Agent Init.log & Citrix WEM Agent.log
- Location: %userprofile%
- Citrix WEM Agent.log
- This is the main Agent log, which will list what instructions the Agent is processing.
- If one of the actions assigned to the current user is not showing, this log will likely contain the relevant error message.
- Errors in this log are listed as Exceptions.
- Must be manually enabled
- Filename: Citrix WEM Agent Host Service Debug.log
- Location: "%PROGRAMFILES(X86)%\Citrix\Workspace Environment Management Agent"
- WEM Agent Debug Log: These logs are created by default in the program directory
- Citrix WEM Agent Host Service Debug.log
- This log must be manually enabled for the WEM Agent Service.
- There are 2 ways to manually enable these logs:
- From the WEM Administration Console per “Configuration Set”
-
- Navigate to: “Advanced Settings”
- Select “Configurations” click on “Agent Options” tab & place a checkmark next to “Debug Mode”.
-
-
- In the Registry of the individual WEM Agent Machine:
-
- Navigate to in the registry: HKLM\System\CurrentControlSet\Control\Norskale\Agent Host
- Change the value of AgentDebugModeLocalOverride to 1
- AgentServiceDebugModeLocalOverride to 1
- Restart the Citrix WEM Agent Host Service.
- WEM Agent Event Viewer log: This log is located in the Applications and Services Logs section of Event Viewer
- WEM Agent Service: This event viewer log is present by default and contains basic events pertaining directly to the Agent service (cached settings, refresh event & connection events).
- Created by default
- Event log name: WEM Agent Service
- Location: Inside Event Viewer under the section titled: Applications and Services Logs
- WCF Traces: must be manually configured and are normally helpful when there are communication issues between the WEM Agent and the WEM Broker.
- Example: you may need to review a WCF trace of the VUEMUIAgent.exe service if the WEM Agent is not checking in with the WEM Broker
-
- VUEMUIAgent.exe
-
-
- WCF Traces: Must be manually enabled
- Filename: vuemUIAgent-Traces.svclog
- Location: "C:\Trace"
-
- Steps to enable tracing:
-
-
-
-
- Close the WEM Agent by exiting the Agent from the taskbar at the bottom right hand side of the screen.
- Make a backup copy of the VUEMUIAgent.exe.config file located in the default location of: "%PROGRAMFILES(X86)%\Citrix\Workspace Environment Management Agent".
- Using Notepad or WordPad, edit the original .config file adding the multiple lines of code from the attached document named VuemUIAgent.txt to the file.
- Paste the code into the file starting on the 3rd line in between the <configuration> and </configuration> markers, then save the file.
Here are contents of the file:<system.diagnostics> <sources> <source name="system.servicemodel" switchvalue="information , ActivityTracing" propagateActivity="true"> <listeners> <add name="traceListener" type="system.Diagnostics.xmlWriterTraceListener" initializedata="C:\trace\NorskaleInfrastructureBrokerService-Traces.svclog" /> </listeners> </source> </sources> </system.diagnostics>
-
-
-
-
-
-
- Create a directory on the root of the C: drive called “trace” if one does not already exist.
- Reproduce the issue
- Stop the VUEMUIAgent.exe process if it is still running
- Collect the log file
- Citrix.Wem.Agent.Service.exe
-
-
- Citrix.Wem.Agent.Service.exe
- Filename: NorskaleAgentHostService-Traces.svclog
- Location: "C:\Trace"
-
- Steps to enable tracing:
-
-
-
-
- Close the WEM Agent by exiting the Agent from the taskbar at the bottom right hand side of the screen.
- Stop the Windows Service called Citrix WEM Agent Host Service
- Make a backup copy of the Citrix.Wem.Agent.Service.exe.config file located in the default location of %PROGRAMFILES(X86)%\Citrix\Workspace Environment Management Agent".
- Using Notepad or Wordpad, edit the original .config file adding the multiple lines of code from the attached document named “Norskale Agent Host Service.txt” to the file.
- Paste the code into the file starting on the 5th line just after the </configSections> marker, then save the file.
Here are contents of the file:
<system.diagnostics> <sources> <source name="system.servicemodel" switchvalue="information , ActivityTracing" propagateActivity="true"> <listeners> <add name="traceListener" type="system.Diagnostics.xmlWriterTraceListener" initializedata="C:\trace\ NorskaleAgentHost Service-Traces.svclog" /> </listeners> </source> </sources> </system.diagnostics>
-
-
-
-
-
-
- Create a directory on the root of the C: drive called “trace” if one does not already exist.
- Start the Windows Service called Citrix WEM Agent Host Service, reproduce the issue & collect the log file.
****REVERT ALL CHANGES AFTER COLLECTING THE APPROPRIATE LOGS****
Issue/Introduction
This article speaks about the different types of logs that are available on any WEM Agent machine. Some of those logs are generated by default, whereas, other logs mentioned here must be manually enabled.
Was this article helpful?
thumb_up
Yes
thumb_down
No