WorkSpaces Performance Monitor Agent

RECOMMENDED FOR FULL FUNCTIONALITY: The WorkSpaces Performance Monitor Agent requires .NET 4.6.2 or above. Ensure that this version or a later version of .NET is installed on the EC2 instance to enable all features of the performance monitoring agent.

The WorkSpaces Performance Monitor Agent collects information for both user and WorkSpace metrics. The Agent installer, named 'WSM Performance Monitor.msi', can be found in the following locations:

  • D:\WorkSpaceAgent on the WorkSpaces Manager (WSM) appliance, or

  • D:\Deploy folder for successive updates.

For the Agent to function properly, it requires specific registry key values to be present in order to locate the API on the Management Portal. A sample format for these registry keys can be found in "D:\WorkSpaceAgent\nuvens.reg", and they are structured as follows:

[HKEY_USERS\.DEFAULT\Software\Nuvens]
"Portal"="https://10.0.1.2"
"UpdateFrequency"="60"
"Frequency"=dword:00000005
"IdleMinutes"=dword:00000015
"Visible"="true"

Replace the value of "Portal" in the registry key file with the IP address or DNS name of your WorkSpaces Manager Portal. Ensure that you select the correct protocol, HTTP or HTTPS, based on your WorkSpaces Manager Portal configuration.

The "Frequency" variable is used to define how often the WorkSpaces Performance Monitor Agent reports back to the portal with metrics, expressed in minutes. For example, setting the value to '5' means the agent will send metrics every 5 minutes.

You can adjust this frequency to a higher value, especially if you manage a large number of WorkSpaces, to reduce the load on the database and optimize performance.

There are several ways to deploy the registry settings on your WorkSpaces. Some common methods include:

  1. Add Manually to Golden Images: Apply the registry settings directly to your golden images, ensuring that all cloned WorkSpaces inherit the correct configurations.

  2. Group Policy (GPO): Distribute the registry settings via Group Policy (GPO) using Active Directory, which automates the process for all WorkSpaces in the domain.

  3. Microsoft Intune (Entra ID Hybrid): Use Intune to distribute the registry settings when managing devices with Entra ID Hybrid for centralized control.

  4. Distribution Tool (e.g., SCCM): Leverage distribution tools like System Center Configuration Manager (SCCM) to push registry settings across your WorkSpaces fleet.

  5. AWS Systems Manager: Use the AWS Systems Manager Run Command or State Manager to push the registry settings across your fleet of WorkSpaces.

  6. PowerShell Scripts: Create a PowerShell script that modifies the registry with the required values.

  7. Logon Scripts: Add a registry modification script to the logon process of the WorkSpaces, ensuring that each user gets the settings applied upon login.

  8. Configuration Management Tools: Use tools like Chef, Puppet, or Ansible to automate the deployment of registry settings across WorkSpaces.

Last updated