Configure the Synthetic Private Agent

Related pages:

Install the Synthetic Private Agent

This page describes the configuration options for the Synthetic Private Agent.

Configure Proxy for the Synthetic Private Agent

Although using a proxy for the Synthetic Private Agent is not mandatory, you can potentially improve security or provide load balancing.

Proxy Use Cases

The following are the various ways in which the Synthetic Private Agent could use a proxy to interact with an on-premises or SaaS Synthetic Server:

Synthetic Private Agent interacting with a SaaS Synthetic Server
On-premises Synthetic Server interacting with a SaaS Synthetic Server when Synthetic Hosted Agents are being used by the on-premises Synthetic Server
Synthetic Private Agent interacting with an on-premises Synthetic Server

Proxy Configuration Steps

To configure the proxy:

Log on to the machine hosting the Synthetic Private Agent.
Change to the directory C:\appdynamics\synthetic-agent\synthetic-driver\conf.
Edit the file synthetic-driver.yml.
Find the setting proxyConfig.
Specify the proxy host and port with keys proxyHost and proxyPort as shown in the following example:
```
 proxyConfig: 
        proxyHost: <synthetic_server-hostname>
        proxyPort: 1501
        ...
```
YML

(Optional) If you have enabled authentication with the proxy, specify the proxy username and password with the keys proxyUsername and proxyPassword:

 proxyConfig: 
        proxyHost: <synthetic_server-hostname>
        proxyPort: 1501
        proxyUsername: <proxy-username>
        proxyPassword: <proxy-password>

YML

Set the Port for the Administration Console

The default port for the Administration connections is 8081. To avoid port conflicts, you can configure the Administration to listen to a different port.

In the file C:\appdynamics\synthetic-agent\synthetic-driver\conf\synthetic-driver.yml, navigate to the server section and modify the value of the port property for the adminConnectors.

server:
  applicationConnectors:
  - type: http
    port: 8888
  adminConnectors:
  - type: http
    port: 8091 # You can customize the port by changing the value here.
  requestLog:
    appenders: []

TEXT

Filter Synthetic Traffic

You can configure the request headers in synthetic scripts to do the following:

Set Custom User Agent for Synthetic Scripts

You can set the user The EUM Server ignores requests for browser applications when the string "PTST/1.0" is part of the User Agent.

requestHeader:
   userAgent: "custom user agent"

driver.get('http://127.0.0.1:20000/green.html')

TEXT

Include Synthetic Traffic in Browser RUM Traffic

The request header in synthetic scripts is tagged so that the requests are not included in Browser RUM pages. You can set the property tagUserAgent to false to include the synthetic traffic in the Browser RUM pages as shown below.

requestHeader:
   userAgent: "custom user agent"
   tagUserAgent: false

driver.get('http://127.0.0.1:20000/green.html')

TEXT