WorkSpaces Manager Agent
Recommended for Full Functionality: The WSM 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 WSM Agent.
The WSM Agent collects information related to both user activity and WorkSpace metrics. The latest version of the WSM Agent installer is always available at the following URL:
https://nuvensworkspacesmanager.s3.eu-west-1.amazonaws.com/latest/WSMAgent.msi
For the agent to function correctly, certain registry key values must be configured so that the agent can identify and connect to the Management Portal API. An example of the required registry key format is shown below. The keys are structured as follows:
[HKEY_USERS\.DEFAULT\Software\Nuvens]
"Portal"="https://portal.nuvens.co"
"Frequency"=dword:00000005
"Visible"="true"
"IdleMinutes"=dword:0000000f
"DisconnectOnIdle"="false"
"LiveBroadcastEnabled"="false"
"LiveBroadcastFrequencyMs"=dword:00001388
"LiveHubUrl"="https://portal.nuvens.co/hubs/livestats"
"RunElevated"="false"The Portal value specifies the location of the WorkSpaces Manager Portal and the protocol used to access it. This value should be defined as a URL and can reference either an IP address or a DNS hostname. For example:
"Portal"="https://portal.nuvens.co"After deployment, update the Portal value in the registry key file with the IP address or DNS name of your WorkSpaces Manager Portal. Ensure that the correct protocol (HTTP or HTTPS) is specified, according to the configuration of your WorkSpaces Manager Portal.
The "Frequency" value specifies how often the WSM Agent reports metrics to the WorkSpaces Manager Portal. This value is expressed in minutes. For example:
This means the agent reports every 5 minutes.
In environments with a large number of WorkSpaces, increasing this value can help reduce database load and improve overall system performance. For earlier versions of the WSM Agent (version 5), a legacy attribute named "UpdateFrequency" was used for the same purpose.
The "Visible" value determines whether the WSM Agent icon is displayed in the Windows system tray. This value accepts true or false. For example:
When set to "true", the WSM Agent icon is visible in the system tray, allowing users or administrators to easily verify that the agent is running.
When set to "false", the icon is hidden from the system tray. However, the WSM Agent continues to run normally in the background. Its execution can still be verified in Task Manager, where it appears as a process named WSMAgent.
The "IdleMinutes" value defines the number of minutes of user inactivity before the WorkSpace is considered idle by the WSM Agent. For example:
This means the agent will treat the session as idle after 15 minutes of inactivity.
The "DisconnectOnIdle" value controls whether the agent should trigger a disconnect action when the session becomes idle. This value accepts true or false. For example:
When set to "true", the agent will disconnect the session after the configured idle threshold is reached. When set to "false", the session remains active even if the user is marked as idle.
To enable Live Stats (Real-Time Metrics) and Startup Metrics, the following additional registry values must be configured:
The "RunElevated" value specifies whether the WSM Agent should run with elevated privileges. When set to true, the agent is allowed to collect Startup Metrics, which require higher privileges to measure system and login performance events during the user session initialization.
These features require the WSM Agent to be executed through a Windows Scheduled Task running in the user context with elevated privileges.
To ensure that only a single instance of the agent is running, the shortcut "WSMAgent.lnk" located in the Common Startup folder (shell:common startup) must be removed. When Live Stats are enabled, the agent should be started exclusively through the Scheduled Task.
When enabled, the agent transmits Live Stats to the WorkSpaces Manager Portal in real time. These metrics provide detailed visibility into the user login process and system performance, including:
User login time
Time required to load the user profile
Time when Group Policies (GPOs) are applied
Time when the Windows shell becomes ready
Overall user login duration
In addition to login performance metrics, Live Stats also monitor running processes and their CPU and memory consumption, allowing administrators to identify resource usage and potential performance bottlenecks within the WorkSpace.
The "LiveBroadcastFrequencyMs" value controls how frequently these metrics are sent to the portal, expressed in milliseconds.
An example of Startup Metrics and processes is shown below:
If Startup Metrics are required, additional configuration is necessary to modify how the agent is started. Instead of launching from the Windows Startup folder, the agent must be configured to run as a Scheduled Task at user logon.
Running the agent as a Scheduled Task allows it to start with the highest privileges, enabling the collection of startup and login performance metrics without granting elevated permissions to the user.
For detailed configuration steps, refer to the GPO Scheduled Task Setup.
There are several ways to deploy the registry settings on your WorkSpaces. Some common methods include:
Add Manually to Golden Images: Apply the registry settings directly to your golden images, ensuring that all cloned WorkSpaces inherit the correct configurations.
Group Policy (GPO): Distribute the registry settings via Group Policy (GPO) using Active Directory, which automates the process for all WorkSpaces in the domain.
Microsoft Intune (Entra ID Hybrid): Use Intune to distribute the registry settings when managing devices with Entra ID Hybrid for centralized control.
Distribution Tool (e.g., SCCM): Leverage distribution tools like System Center Configuration Manager (SCCM) to push registry settings across your WorkSpaces fleet.
AWS Systems Manager: Use the AWS Systems Manager Run Command or State Manager to push the registry settings across your fleet of WorkSpaces.
PowerShell Scripts: Create a PowerShell script that modifies the registry with the required values.
Logon Scripts: Add a registry modification script to the logon process of the WorkSpaces, ensuring that each user gets the settings applied upon login.
Configuration Management Tools: Use tools like Chef, Puppet, or Ansible to automate the deployment of registry settings across WorkSpaces.
Last updated