This page guides you through the installation and initial setup of Eggplant Performance.
The Eggplant Performance installer is available for Windows only, and includes software for:
- Eggplant Performance Studio
- Eggplant Test Controller
- Eggplant Performance Injectors.
For a high-level summary of these applications, see Eggplant Performance Components.
The machine where you install the software is your Controller machine. The Eggplant Performance installer includes injector software, so that you can run an injector on the Controller machine. See Managing Injectors for information about how this injector works.
You can also run injectors on other, remote machines. This allows you to:
- Run bigger tests
- Run tests on other operating systems besides Windows.
See Injector Installation for information about installing injectors on separate machines.
Eggplant Performance Analyzer installation
Eggplant Performance Analyzer is in a separate installer, and is available for Windows only.
You can install the Eggplant Performance Analyzer application on your Controller machine, or you can install Analyzer on another machine. For information, see Installing Eggplant Performance Analyzer.
Prerequisites for Installation
- At least 1 GB free disk space on the installation drive
- Additional disk space for recordings and test run data. This data can range from a few kilobytes to gigabytes, depending on:
- The test run options selected
- The level of logging
- The duration of your test runs
- The number of simulated virtual users (VUs).
- Supported operating systems
- Hardware requirements
- Java (JDK) requirements
- .NET requirements.
Step by Step: Installing Eggplant Performance
Below are step-by-step instructions for installing Eggplant Performance on the computer that will be your Controller machine.
On the Windows PC that will act as the Controller, log in as a user with local administrator privileges and execute the
Run the installation program, which installs a local (localhost) Injector alongside the Studio and Test Controller executables.
Review and agree to comply with the terms of the Keysight EULA
You can also install Eggplant Performance from the command line.
Eggplant Performance is updated regularly, so periodically check the Downloads page for new releases, and for details of new features.
Licensing Eggplant Performance
Licensing for Eggplant Performance is handled through Eggplant Performance Test Controller.
- A license for running tests is required because this happens on the Test Controller.
- No license is required for performing tasks in Studio, such as:
- Recording, generating, and writing scripts
- Creating test definitions.
- Additional licensing is required for Eggplant Functional VUs
Use the Keysight Software Manager (KSM) website to enter or manage your license keys.
Understanding Eggplant Performance License Types
The Term for Eggplant Performance licenses is always Expiring. This means that the license expires after a period of time defined by Keysight.
There are two types of license:
- Node Locked (fixed) license: If you have obtained a Node Locked license, you may install one copy of the Software on one computer, instrument, or machine and use the Software only on that computer, instrument, or machine for your internal business use. You may not display or access the Software on a separate computer.
- Floating license: If you have obtained a Floating license, you may install one or more copies of the Software on any computer, instrument, or machine within your internal computer network or on dedicated server resources provided by a third party for your internal business use, provided the total number of users who are accessing or using any of the Software at the same time does not exceed the maximum number of licenses.
Most Eggplant Performance licenses are Floating, which means that they can be installed on either the Controller machine or a remote license server. Test Controller checks out the number of Virtual Users it needs to run a test, up to the maximum number of licensed Virtual Users.
Some Eggplant Performance licenses are Node Locked, such as the Free VU types and JMeter licenses.
You can check the details of an installed license at any time:
License expiry date: Look at the Eggplant Performance Licenses dialog in Test Controller.
License type: Look in the license file for one of these phrases:
Node-Locked License Filefor Node Locked licenses.
Team License Filefor Floating licenses.
The default location of the license file is
Both license types provide a maximum number of Virtual Users that can be run at the same time. Licensing conditions may also restrict the types of Virtual Users that can be run.
Licensing the Eggplant Performance Controller Machine
When you launch Eggplant Performance Test Controller for the first time, the Eggplant Performance Licenses dialog box is displayed. You can also access the same dialog box by navigating to Tools > Licenses.
To enter a new license:
- Click Copy to clipboard to copy your Host ID.
- Click Keysight Software Manager at the bottom of the dialog box to open the license request page for Keysight products.
- Follow the appropriate steps on the Keysight Software Manager (KSM) website to generate your license file, then download it to the Controller machine. See License Administration with Keysight Software Manager (KSM) for information about accessing and using the Keysight Software Manager page.
- Return to the Eggplant Performance Licensing dialog box, and click + Add a license.
- Browse to the downloaded license file, select it, and then click Open. Eggplant Performance copies the file into the directory where it expects license files to be, and you receive a confirmation message that the license has been accepted.
- Click Close.
Whenever you launch Test Controller, it checks for a valid license:
- If there is no license, or the license has expired, Test Controller opens the Eggplant Performance Licenses dialog.
- If the license is 30 days or less from expiration, you receive a warning.
To turn off the license expiration warning in Test Controller:
Navigate to Tools > Preferences. The Test Controller Preferences dialog box is displayed.
Clear the Display license warnings on startup checkbox. This has the same effect as clearing the checkbox on the Eggplant Performance Licenses dialog.
Eggplant Performance licenses are either Node Locked Expiring, or Floating Expiring. For more information, see Understanding Eggplant Performance license types.
Licensing Eggplant Performance using Reprise License Manager
Most Eggplant Performance licenses are Floating Expiring licenses, so they may be applied to a remote server running Reprise License Manager (RLM) and retrieved in the same way as Eggplant Functional retrieves licenses from RLM.
To learn about how to identify whether your license is Floating or Node Locked, see Understanding Eggplant Performance license types.
To connect to RLM, follow these steps:
On the Eggplant Performance Licenses dialog box, in the Remote license server panel, click Configure. The Remote License Server Details dialog box opens.
Clear the Do not use a remote license server checkbox.
Enter the Hostname/IP address and Port information of the remote machine where the RLM server is running.
If you reuse an existing RLM license server, depending on when you downloaded it from the Eggplant website, you may encounter a missing
vuLicenses.lic error message. This error prevents the Test Controller from using or displaying information about licenses on the remote server.
To resolve this issue:
On the Test Controller, navigate to
C:\Program Files (x86)\eggPlant Performance\re\rlm.
vuLicenses.licfile and copy it to the same directory as the RLM executable on the remote license server.
Viewing Existing Licenses
In Eggplant Performance Test Controller, navigate to Tools > Licenses. The Eggplant Performance Licenses dialog box opens.
From here, you can view your computer's Host ID and copy it to the clipboard by clicking the button.
You can also see a list of licenses installed on the computer, each of which allows you to run a certain number of VUs. Eggplant Performance licenses are either:
- Node Locked Expiring
- Floating Expiring.
The expiry date of each license is shown in the list. For more information, see Understanding Eggplant Performance license types.
If you have multiple licenses, the number of VUs available for each license is added together to give the total number of VUs you have available to assign to tests.
Adding VUs for a limited period
Under certain circumstances, you might need to increase your testing capacity for a limited period.
You're licensed to run 100 Java VUs for several months, but need to run 1000 Java VUs for a short period for some intensive testing.
In this case, you can request a week-long license for 1000 Java VUs in addition to the existing license. The additional license increases the capacity of your tests by 1000 Java VUs while it is active so that in total 1100 VUs are available.
To add a license:
- Click Add a license to enter a new license, as described above.
- On the Eggplant Performance Licenses dialog box, click Refresh to update the list of licenses to show the newly added license.
Uninstalling Eggplant Performance
To remove Eggplant Performance, follow these steps:
Close all Eggplant Performance component instances.
In Windows, navigate to Control Panel > Add or Remove Programs and uninstall the application.
The Eggplant Performance uninstall program does not remove your workspace or project data. If you do not want to save any of your workspaces, projects, or test results, you must manually delete them.
Re-Installation on the Same Controller Machine
If you intend to update your installation with a new release, you must carry out the following steps.
Uninstall Eggplant Performance as described in the previous section.
Install the latest version of Eggplant Performance.