This page describes how to configure the Web Monitoring PSA and API Monitoring PSA.
In-Script Metadata Configuration
When you run Synthetic Jobs as scripted measurements, you can specify certain configuration options using in-script metadata. You must include these yaml based configurations at the beginning of the script in the form of a comment block.
Set Custom User Agent for Synthetic Scripts
To modify the default browser specific
user-agent header to a custom
user-agent header, add this in-script metadata at the beginning of the Synthetic script:
'''yml requestHeader: userAgent: "custom user agent" ''' driver.get('http://127.0.0.1:20000/green.html')
Include Synthetic Traffic in Browser RUM Traffic
user-agent request headers in the Synthetic scripts are tagged so that the requests are not included in Browser RUM pages. You can set
false to include the Synthetic traffic in the Browser RUM pages.
Enter the following in-script metadata at the beginning of the Synthetic script:
'''yml requestHeader: userAgent: "custom user agent" tagUserAgent: false ''' driver.get('http://127.0.0.1:20000/green.html')
After you set up the Kubernetes cluster, push the images to the Docker registry, and deploy the Web Monitoring PSA or API Monitoring PSA using
sum-psa-heimdall.tgz Helm chart, a
values.yaml file is generated. Use the
values.yaml file to dynamically configure the values while deploying the Web Monitoring PSA and API Monitoring PSA.
Key-Value Pairs Configuration
You can replace the optional configuration values in the
values.yaml file with the values in the table:
|Heimdall replica count||Indicates the Heimdall replica count.|
|Heimdall Resource allocations||Indicates the Heimdall Resource allocation.|
|Measurement Container Resource allocations|
Web Monitoring PSA:
API Monitoring PSA:
|Indicates the measurement container resource allocations.|
|Postgres DB Resource allocations||Indicates the Postgres DB resource allocations.|
|Custom Postgres DB||To set up Postgres DB instance and to configure Heimdall to connect to the DB instance, ensure that the DB is running in the same namespace as Heimdall (measurement namespace).|
|Logging level||Indicates the logging level. The default value is |
|Node selectors||Apply Node selectors for Heimdall and measurement containers to schedule these components on specific nodes.|
Web Monitoring PSA:
API Monitoring PSA:
Configure the PSA to use a proxy for all requests leaving the cluster. Set the
You can configure the same proxy server for all components or different proxy servers for each component.
Connect Agent to the Synthetic Server
When deploying the Web Monitoring PSA or API Monitoring PSA in the Kubernetes cluster, you must specify the agent registration information in the
values.yaml file. Heimdall uses this information to register itself with the Synthetic Server. Once registered you can view the agent in the Controller and run measurements.
To connect the agent to a hosted Synthetic Cloud region, enter one of these shepherd URLs in the
To connect the agent to your on-premises Synthetic Server, enter the shepherd URL (
http://<on-premises-synthetic-server-host>:10101) in the
On-premises Synthetic Server versions >= 21.4.1 are supported. If you are on an older version, you must upgrade Synthetic Server to connect to the Linux-based PSA.
EUM Account and License Key
To connect the agent to the Controller, you need the EUM account and license key.
Follow the given steps to obtain this information:
- Navigate to the SaaS Controller.
- Click the settings icon at the top-right corner to navigate to License > Account Usage.
Scroll down to the User Experience section.
Enter Account Name and License Key in the
Configuration Key Configuration Value
shepherd > credentials > eumAccount
shepherd > credentials > eumKey
To identify the location of the agent, enter the following
shepherd > location details in the
name- A user-friendly string for the location.
code- A unique alphanumeric string with four to ten characters which identifies the location where the agent is running. You must create this ID based on the location name.
latitude, longitude- Navigate to the GPS Coordinates with Google Maps to get the latitude and longitude of your location.