This checklist serves as a guide during the intake process for consultancy services of LoadGen with LoadGen Load & Performance Testing. LoadGen staff can assist, if needed, with on-site implementation and configuration of required components, together with your IT team. Since implementing and configuring some components can be time-consuming, this may affect on-site time. The more components that are already present and configured before the start, the more time is available to explain various parts, make informed decisions, review best practices, and/or run multiple benchmark tests.
In this article, we delve deeper into the terminology associated with LoadGen.
Instructions
The first column indicates when the component can or must be implemented:
- Before: This component must be implemented before the performance test begins.
- During: The LoadGen staff will, if necessary, assist in implementing this component with your IT team during the setup process.
- Optional: Some components can influence performance results. To demonstrate and improve where possible, these components can be optionally configured.
LoadGen Management Machine (LoadGen Director, Studio, and Analyzer) setup checklist
LoadGen comprises several components, including the LoadGen Director, LoadGen Studio, and LoadGen Analyzer. These can be installed on a single system to provide a consolidated management interface. Below is a checklist of the necessary components and prerequisites for setting up a LoadGen management machine. Read more in this article.
| When | Activities / Components | Present (Yes/No) |
|---|---|---|
| Before | Microsoft Windows 10 or Microsoft Windows Server 2016 or higher with a minimum of 4(v)CPU and 16GB RAM | |
| Before | .NET Framework 4.8.1 or higher | |
| Before | Microsoft Visual C++ 2015, 2017, and 2019 (x64 and x86) | |
| You can download the necessary Visual C++ Redistributables from here | ||
| Before | Access to the following TCP/UDP ports (Refer to the LoadGen TCP/UDP port numbers chapter for more details) | |
| Before |
Access to the following websites: |
|
| Before | Local administrator rights are required to install and configure LoadGen components. |
Notes:
- Ensure that all the necessary system requirements are met before installation.
- Proper access to TCP/UDP ports and specific LoadGen-related websites ensures seamless communication between the LoadGen Director, Studio, Analyzer, and the LoadGen cloud services.
LoadGen Simulated Users setup checklist
For performance scans and benchmark tests, LoadGen utilizes simulated users representing actual employees. These are AD accounts with policies that mirror the real accounts used by your staff.
| When | Activities / Components | Present (Yes/No) |
|---|---|---|
| Before | Sufficient (concurrent) licenses of the software components in use to allow nnnn LoadGen simulated users to access the environment | |
| During | Create nnnn LoadGen simulated users (this can be done in collaboration with the LoadGen team) | |
| During | Simulated users should represent actual (standard) employees (same policies, scripts, etc.) | |
| During | Simulated users must be members of an AD group that is linked to resources | |
| During | Passwords for all LoadGen simulated users should be the same, preferably. A complex password is allowed, and passwords will be securely encrypted in the LoadGen configuration files | |
| Not Required | Internet access is allowed but not required | |
| Not Required | Mailboxes are allowed but not required (they are not used during testing) | |
| Not Required | Additional group drives or applications are allowed but not required |
Notes:
- Ensure that the simulated users have the same policies and permissions as real employees to simulate user load accurately.
- Collaboration with the LoadGen team during the creation of simulated users will ensure they are properly configured for testing.
LoadGen Database setup checklist
LoadGen stores its data in a Microsoft SQL database. Ensure that the following components are set up for optimal performance. Note that we do not recommend using SQL Express due to its limitations in handling large datasets during performance testing. Read more in this article.
| When | Activities / Components | Present (Yes/No) |
|---|---|---|
| Before | Microsoft SQL Server 2019 or higher. It is recommended that a full version of Microsoft SQL Server be used for better performance and scalability. | |
| Before | Ensure there is sufficient disk space (approximately 100GB or more depending on the scale of your tests) to store and archive databases. |
Notes:
- SQL Server Express has limitations in terms of storage and performance and is not suited for large-scale LoadGen performance testing. For optimal results, use the full version of Microsoft SQL Server.
- It is recommended to install SQL Server on a dedicated machine for larger tests to avoid performance bottlenecks.
LoadGen Agents Setup Checklist
LoadGen Agents are responsible for creating and managing the user sessions during performance testing. Since it is logistically impossible to use many physical devices for capacity testing, LoadGen Agents simulate real user sessions on virtual or physical machines. These agents can host between 10 to 15 sessions per machine, depending on the hardware configuration. Read more in this article.
| When | Activities / Components | Present (Yes/No) |
|---|---|---|
| Before | Microsoft Windows 10 or Microsoft Windows Server 2016 or higher with at least 4(v)CPU and 16GB RAM. | |
| Before | Virtual hardware is preferred for easier deployment and management. | |
| Before | If using physical hardware, ensure the wall outlet and switch port are not bottlenecks. After each benchmark test, performance graphs of the wall outlet and switch port must be provided by the management organization. | |
| Before | Ensure the correct client software is installed on the LoadGen Agent (e.g., Microsoft Remote Desktop Client, Citrix Workspace App, or VMware Horizon View). | |
| Before | .NET Framework 4.8.1 or higher. | |
| Before | Microsoft Visual C++ 2015, 2017, and 2019 (x64 and x86). | |
| Before | Local Admin rights on the LoadGen Agents. | |
| Before | UAC (User Account Control) must be disabled on the LoadGen Agent(s). | |
| Before | LoadGen Agents should be hosted on different hosts/storage than the target environments to avoid influencing measurement results. | |
| Before | No idle/disconnect time policies should be active on the LoadGen Agents. | |
| Before | Ensure access to various TCP/UDP ports as per the LoadGen TCP/UDP Port Numbers section. | |
| Before | When using Azure Virtual Desktop, make sure you prepare the LoadGen Agents, read more in this article. | |
| During | Ability to reboot LoadGen Agents without prior notice (potentially in batches of x agents). | |
| During | No printers must be present, or the print spooler service must be disabled on the LoadGen Agents. |
Notes:
- Virtual machines are highly recommended for LoadGen Agents due to their ease of management and scalability.
- Ensure that the physical infrastructure (network ports, switches) is not a bottleneck, particularly when using physical hardware for LoadGen Agents.
- It is essential to avoid interference between the LoadGen Agents and the systems being tested by keeping them on separate storage or hosts.
LoadGen Targets setup checklist
LoadGen Targets refer to the SBC servers, VDI machines, or FAT clients where the LoadGen simulated user sessions are initiated and hosted. The LoadGen Agents launch and manage these sessions on the targets for capacity testing.
| When | Activities / Components | Present (Yes/No) |
|---|---|---|
| Before | All target software (e.g., Microsoft Windows and Microsoft Office) must be activated to avoid unexpected notifications. | |
| Before | Disable or configure customer improvement programs, updates, and first-run setup notifications to prevent any unexpected prompts. | |
| Before | Ensure there are enough machine licenses to allow nnnn LoadGen simulated users to access the environment. | |
| Before | Sufficient IP addresses must be available for the targets (SBC/VDI). | |
| Before | Use short DHCP lease times (preferably less than 1 hour) for the targets. | |
| Before | Ensure properly functioning DNS (e.g., no duplicate records in combination with DHCP lease). | |
| Before | Ensure access to various TCP/UDP ports as outlined in the LoadGen TCP/UDP Port Numbers section. | |
| Before | When using Citrix, ensure the Workspace App is configured not to use SSO; read more in this article. | |
| Before | When using Citrix, ensure the Workspace App version is supported, read more in this article. | |
| During | LoadGen targets must only be accessed by LoadGen simulated users. | |
| Optional | 10-day Microsoft Office 365 trial license for testing purposes: Microsoft 365 Test Licensing. | |
| Optional | Local administrator rights on the LoadGen targets to enable the collection of performance counters. |
Notes:
- Ensure that all target software and configurations are complete and fully licensed before testing to avoid disruptions during the LoadGen performance tests.
- Short DHCP leases and proper DNS management help to ensure smooth session handling, particularly in environments where many sessions are rapidly created and destroyed.
- Install the LoadGen Agent on the target environments (RDSH, AVD, VMware Horizon View, Citrix) to monitor and enhance the performance metrics of the session hosts.
LoadGen Add-in for Citrix Enhanced Profile or Microsoft Remote Desktop Services setup checklist
When using LoadGen Citrix Enhanced Profile or Microsoft Remote Desktop Services (RDS), the LoadGen Add-in needs to be installed on the target environment. While this can be done via the LoadGen Director, it is recommended to install the Add-in in the Golden Image of the Citrix or RDP host/VDI for optimal performance and simplified deployment. Read more in this article.
| When | Activities / Components | Present (Yes/No) |
|---|---|---|
| Before | Verify that the Citrix or RDS host/VDI system is running Microsoft Windows Server or Windows Desktop OS as per testing requirements. | |
| Before | Ensure that TCP/UDP ports required by LoadGen are accessible (refer to LoadGen TCP/UDP port numbers section). | |
| Before | Ensure the availability of a Golden Image for Citrix or RDS host/VDI to install the LoadGen Add-in, streamlining the deployment across multiple instances. | |
| Before | Download the LoadGen Add-in package for manual installation on the Golden Image or VDI. | |
| Before | Install .NET Framework 4.8.1 or higher and Microsoft Visual C++ Redistributables (2015, 2017, 2019) (x64 and x86 versions) on the target system. | |
| Before | Ensure that local administrator rights are available on the Citrix/RDS host or VDI to install and configure the LoadGen Add-in. | |
| Before | Disable any customer improvement programs, updates, and/or first-run setup notifications to avoid unexpected prompts during testing. | |
| Before | When using Citrix, make sure you allow the LoadGen UAI Virtual Channel, read more in this article. | |
| Before | Confirm that all target software (e.g., Microsoft Windows, Microsoft Office) is fully activated to avoid activation prompts during testing. | |
| During | Install the LoadGen Add-in on the Golden Image or target Citrix/RDS host. | |
| During | Configure the LoadGen Director to ensure that the LoadGen Add-in is correctly recognized and connected to the test environment. | |
| During | Execute a test session to confirm that the Add-in is working correctly for Citrix Enhanced Profile or RDS performance testing. |
Notes:
- Golden Image approach: Installing the LoadGen Add-in in the Golden Image ensures consistency across all target environments and simplifies the deployment of new sessions.
- Manual installation: Although the LoadGen Director offers remote installation options, installing the Add-in manually provides better control over the environment and can avoid network-related issues during deployment.
- Validation: Always perform a test run after installation to ensure that all components are functioning properly, especially in performance testing scenarios involving Citrix or RDP hosts.
LoadGen Agent in Azure Virtual Desktop (AVD) and VMware Horizon VDI setup checklist
This checklist outlines the necessary steps and components required for installing the LoadGen Agent manually within a VDI (Azure Virtual Desktop or VMware Horizon). While the installation can be handled by the LoadGen Director, manual installation within the VDI is preferred for smoother operations and efficiency. Read more in this article.
| When | Activities / Components | Present (Yes/No) |
|---|---|---|
| Before | Ensure the hosted desktop (Azure Virtual Desktop or VMware Horizon VDI) is operational and configured for testing. | |
| Before | Ensure the target VDI has Microsoft Windows 10, Windows 11, or Windows Server 2016+ with the required resources (4 vCPU, 16GB RAM). | |
| Before | Confirm that .NET Framework 4.8.1 or higher is installed on the VDI machine. | |
| Before | Ensure Microsoft Visual C++ 2015, 2017, and 2019 (x64 and x86) runtime libraries are installed. | |
| Before | Ensure the machine has local administrator rights to allow LoadGen Agent installation and configuration. | |
| Before | Disable User Account Control (UAC) on the VDI to avoid unnecessary prompts and interruptions during automated tests. | |
| Before | Ensure the machine has access to the necessary TCP/UDP ports for communication (refer to LoadGen documentation for port numbers). | |
| Before | Pre-load the necessary client software on the VDI, such as Microsoft Remote Desktop Client, Citrix Workspace App, or VMware Horizon Client to ensure proper session initialization. | |
| Before | Ensure access to the required LoadGen cloud services (refer to LoadGen documentation for URLs and services). | |
| During | Download the LoadGen Agent installer onto the VDI manually (if not installed via LoadGen Director). | |
| During | Run the LoadGen Agent installer directly within the VDI environment. | |
| During | Configure the LoadGen Agent to connect with the LoadGen Director (use the provided connection strings). | |
| During | Validate that the LoadGen Agent can successfully initiate sessions within the VDI environment. | |
| Optional | Set up performance monitoring on the VDI for further insights during load tests (requires admin privileges). |
LoadGen TCP / UDP Port Numbers
The LoadGen targets are SBC servers, VDI machines, or FAT clients used during the capacity tests. The LoadGen Agents initiate sessions and host them on the LoadGen targets, which require certain ports for communication. Read more in this article.
| When | Activities / Components | Present (Yes/No) |
|---|---|---|
| Before | TCP Port 4840: Used to send status information, metrics, and counters from the LoadGen Agent to the LoadGen Director. | |
| Before | TCP Port 4841: Used to send commands from the LoadGen Director to the LoadGen Agent. | |
| Before | TCP Port 1433: Communication between LoadGen Agents and Microsoft SQL when data is not sent via LoadGen Director. By default, the LoadGen Agents tunnel all data to the LoadGen Director, which then uploads it to Microsoft SQL in bulk. | |
| Before | TCP Port 1433: The LoadGen Analyzer also requires a direct connection to the Microsoft SQL Database. Typically, the LoadGen Analyzer is installed on the same machine as the LoadGen Director. | |
| Optional | TCP Port 135 (DCE/RPC Locator Service) | |
| Optional | TCP Port 139 (NetBIOS Session Service) | |
| Optional | TCP Port 445 (Windows Shares) | |
| Optional | UDP Port 137 | |
| Optional | UDP Port 138 |
The optional item TCP ports are used to collect performance counters from the LoadGen Director to a System Under Test (SUT) machine, including targets and potentially other Microsoft Windows servers.
Customization (Adjusting Workload with Applications)
It is possible to include your own applications in a custom workload so they can be used by simulated users during testing. This process requires customization and should be coordinated in advance with your LoadGen account manager. Customization can be time-intensive, so it is important to clearly define the expectations and scope. Here is a brief overview of what can and cannot be provided as part of this customization:
- If the general response times are negatively impacted, the response times of your custom application will also reflect these issues.
- Only frequently used applications and actions are relevant for testing. The custom workload will show whether the performance of your applications degrades significantly compared to a standard workload.
| When | Activities / Components | Present (Yes/No) |
|---|---|---|
| Before (if customization has been agreed) | The simulated users will also stress the backend of the application. Has this been accounted for in terms of scaling and capacity? | |
| Before (if customization has been agreed) | Are the standard application workflows well known? | |
| Before (if customization has been agreed) | Can the application be fully controlled using keyboard shortcuts? | |
| Before (if customization has been agreed) | Are user accounts required? If so, it is preferable that the usernames match the Active Directory usernames. | |
| Before (if customization has been agreed) | Is dummy data being used in a test environment? If testing is conducted in a production environment, risks and mitigation strategies must be outlined in advance by the IT administration team. |
Permissions
For the performance load test to run smoothly, the workload must continue without interruptions. Sometimes minor adjustments need to be made to the LoadGen target, policies, third-party tools, etc. The LoadGen specialist does not necessarily need the permissions listed below if one of your IT staff members can apply the changes. In certain performance load tests, it may be desirable to disable or isolate certain components to assess their impact on response times or system capacity. This may require further testing with the component turned off, which could involve adjustments to the LoadGen target, policies, third-party tools, hardware BIOS, hypervisor, or antivirus infrastructure. Again, these changes can be made by your IT staff if they have the necessary permissions.
| When | Activities / Components | Present (Yes/No) |
|---|---|---|
| During | Adjust LoadGen target (local admin rights required) | |
| Optional | Modify login script (Netlogon directory) | |
| Optional | Adjust AD policies | |
| Optional | Modify BIOS settings (via ILO access) | |
| Optional | Modify SBC/VDI management software (e.g., Citrix AppCenter, VMware vSphere, etc.) | |
| Optional | Permissions for third-party software (e.g., Ivanti, VMware DEM) to make adjustments needed for LoadGen simulated users | |
| Optional | Modify hypervisor settings | |
| Optional | Adjust gateways (e.g., Citrix NetScaler, load balancers, firewalls) | |
| Optional | Adjust accelerators | |
| Optional | Modify deployment infrastructure | |
| Optional | Adjust provisioning services/imaging infrastructure | |
| Optional | Adjust antivirus (AV) infrastructure, read more in this article. |