The instructions below show you how to fetch and install a Synthetic Private Agent.
The installation of the Synthetic Private Agent will make the following changes to your system:
- Install the Synthetic Private Agent.
- Install browsers.
- Configure many aspects of Windows to make it amenable for collecting performance data from browsers, including changing several Windows registry settings.
- Turn on the Windows firewall and prevent any inbound network connections to the server.
Before beginning the installation, confirm that you have completed the following:
- Met the requirements for the Synthetic Private Agent
- Prepared the Host Machine for the Synthetic Private Agent
Follow the steps below to install the Synthetic Private Agent:
Fetch the Synthetic Private Agent
Navigate to the AppDynamics Downloads and download the Synthetic Private Agent.
Log in as the Administrator
Before you can copy and run the Synthetic Private Agent installer, you are required to log in as the administrator to the dedicated Windows machine for the Synthetic Private Agent.
Copy/Move the Synthetic Private Agent to Your Dedicated Machine
Move or copy the compressed archive file
SyntheticAgentInstaller.zipcontaining the Synthetic Private Agent to this machine.
- Unzip and decompress the archive file.
- Confirm that the directory
SyntheticAgentInstallercontains the installer script
Prepare Account and Location Information
Before you install the Synthetic Private Agent, you will need the following information:
- EUM Account Name / EUM License Key:
- Go to your SaaS Controller.
- Navigate to License > Peak Usage.
- Scroll down to the User Experience section.
- Copy the values for the Account Name and License Key fields.
- Location name: A user-friendly string for the location. You can use the same location information on multiple computers to add capacity to that location. For example, if the private location is for multiple machines running from the company office in SF, you might use "SF Office".
- Location ID: A unique alphanumeric string from 4-10 characters identifying a location where one or more agents may be running. You should create this ID based on the location name.
Latitude and longitude of the location: Navigate to the GPS Coordinates with Google Maps tool at
https://www.gps-coordinates.netto get the latitude and longitude of your location.
Run the Installer
After you unzip and decompress the archive file:
- Open a PowerShell console.
Change to the directory
Set the PowerShell execution policy to
Execute the PowerShell script
install.ps1to install the Synthetic Private Agent, Internet browsers, and make changes to the Windows configuration:
- At the command prompts, enter the information that you prepared in the last step.
Connect the Agent to the Synthetic Server (Optional)
By default, the Synthetic Private Agent will report measurement results to the SaaS Synthetic Server located in the Americas business region. Thus, if your Synthetic Private Agent is located in the Americas business region and reporting to our SaaS Synthetic Server, continue to Start the Synthetic Private Agent.
If your Synthetic Private Agent is reporting measurement results to an on-prem Synthetic Server, see Connect Synthetic Agents to the Synthetic Server for configuration instructions.
To configure your Synthetic Private Agent to report to a SaaS Synthetic Server in the EMAC or APAC business regions, follow these instructions:
Select the EMAC or APAC tab in the following table to find the URL to the SaaS Synthetic Server in your region.
- Change to the directory
- Edit the file
Set the URL to SaaS Synthetic Shepherd in your region to the
shepherdUrlas shown below:
Save your changes and close the
Start the Synthetic Private Agent
After installation is complete (the installer may restart your computer), start the Synthetic Private Agent by double-clicking the desktop shortcut Start Agent.
Confirm the Installation Was Successful
- Go to your SaaS Controller and to the Synthetic Job List.
- Click Create a Job.
- From Choose Locations, select Private from the dropdown to view all the Synthetic Private Agents associated with your account.
- Verify that your private location shows up as one of the available locations.
You should configure autologon so that the machine after booting up will automatically log on to the Administrator account. You are recommended to use the free Microsoft Sysinternals utility
Autologon.exe for configuring autologon.
Autologon.exe is easy to use, and more importantly, encrypts the account credentials stored in the Windows Registry.
To configure autologon:
- Double-click the executable Autologon.exe.
- Enter the requested information (username, domain, password, etc.).
- Click Enable.
You can also run
Autologon.exe from the command line, but be sure to escape any special characters in your password.
To manually configure autologon by editing the registry, see How to turn on automatic logon in Windows. Note that the given instructions can change slightly depending on the version of Windows being used.
Schedule the Synthetic Private Agent to Start on Logon
After you have set up autologon, you still need to schedule the Synthetic Private Agent to automatically start after the machine logs on to the Administrator account.
- Open a PowerShell console.
Download and save the file
- Change to your
- If you are logged on as a different user than "Administrator", edit the
startagent.xmlfile and replace the value "Administrator" for the following XML elements with your user name. (Remember, your user account still must have Administrator permissions.)
Schedule the task of starting the Synthetic Private Agent:
Restart your machine.
- After the machine boots up, you should see the Windows console open titled "Administrator: Windows PowerShell" that displays the log message "Synthetic-agent is running".
Install Multiple Agents
After installing one Synthetic Private Agent, you should consider whether you need to install more Synthetic Private Agents.
Installing multiple agents is recommended for the following use cases:
- You want to test multiple locations. You need to install the Synthetic Private Agent on multiple machines and provide different location information during the installation. Each location will appear separately in the Job Editor.
- You need more throughput to run more tests. If you run a lot of synthetic jobs from a location, you may see errors like “Location is overloaded”. This means the machine is at capacity and you need to add another machine. You can simply install the agent on another machine and provide the same location information.
- You want support for multiple versions of Internet Explorer. See Software Requirements for more information.