How to enable/collect logs on WEM Agent machine

TYPES OF LOGS AVAILABLE:

FOR LOGGING INFORMATION RELATING TO WEM BROKERS, SEE CTX228742

There are a number of logs that can be collected from the WEM Agent to help with troubleshooting/diagnosing an issue

#1: WEM Agent Session Logs

These logs are created be default in the base of the user’s profile

a: Citrix WEM Agent Init.log

This is the initialization log for the Agent, which will log the Agent starting up 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.

b: 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.

#2: WEM Agent Debug Log

These logs are created be default in the program directory

a: 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:

#1: 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”.

#2: In the Registry of the individual WEM Agent Machine: Navigate to HKLMSystemCurrentControlSetControlNorskaleAgent Host and change the value of the AgentDebugModeLocalOverride & AgentServiceDebugModeLocalOverride to 1 and restart the Citrix WEM Agent Host Service.

#3: WEM Agent Event Viewer log

This log is located in the Applications and Services Logs section of Event Viewer

a: 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).

#4: WCF Traces:

These WCF traces must be manually configured and are normally helpful when there are communication issues between the WEM Agent and the WEM Broker. For 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

a: VUEMUIAgent.exe

b: Citrix.Wem.Agent.Service.exe

HOW TO IMPLEMENT AND GATHER LOGS:

#1: WEM Agent Session Logs

***Created by default after user logs in***


Filenames: Citrix WEM Agent Init.log & Citrix WEM Agent.log

Location: %userprofile%

#2: WEM Agent Debug Log

***Must be manually enabled***


Filename: Citrix WEM Agent Host Service Debug.log

Location: “%PROGRAMFILES(X86)%CitrixWorkspace Environment Management Agent”


#3: WEM Agent Event Viewer log

***Created by default***


Event log name: WEM Agent Service

Location: Inside Event Viewer under the section titled: Applications and Services Logs

#4: WCF Traces:

***Must be manually enabled***

a: VUEMUIAgent.exe

Filename:
vuemUIAgent-Traces.svclog

Location: “C:Trace”

#1: Close the WEM Agent by exiting the Agent from the taskbar at the bottom right hand side of the screen.

#2: Make a backup copy of the VUEMUIAgent.exe.config file located in the default location of “%PROGRAMFILES(X86)%CitrixWorkspace Environment Management Agent”.

#3: 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 attached file:

User-added image

#4: Create a directory on the root of the C: drive called “trace” if one does not already exist.

#5: Reproduce the issue, stop the VUEMUIAgent.exe process if it is still running & collect the log file.

b: Citrix.Wem.Agent.Service.exe

Filename:
NorskaleAgentHostService-Traces.svclog

Location: “C:Trace” ​

#1: Stop the Windows Service called Citrix WEM Agent Host Service

#2: Make a backup copy of the Citrix.Wem.Agent.Service.exe.config file located in the default location of “%PROGRAMFILES(X86)%CitrixWorkspace Environment Management Agent”.

#3: 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 attached file:

User-added image

#4: Create a directory on the root of the C: drive called “trace” if one does not already exist.

#5: 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****

FOR LOGGING INFORMATION RELATING TO WEM BROKERS, SEE CTX228742

Related:

Leave a Reply