Download PDF
Download page Install the Private Synthetic Agent (Web and API Monitoring).
Install the Private Synthetic Agent (Web and API Monitoring)
This page describes the hardware components required for the Web Monitoring Private Synthetic Agent (PSA) and API Monitoring Private Synthetic Agent (PSA) to run in the Docker engine, Kubernetes cluster, and Minikube.
Web Monitoring PSA supports these platforms:
- SaaS Controllers
- On-premises Controller >=21.4.1 with on-premise Synthetic Server >=21.4.1
- Chrome browser
- x86-64 architecture
API Monitoring PSA supports these platforms:
- SaaS Controllers >=21.11
- Javascript
- x86-64 architecture
- Web Monitoring PSA on Google Cloud Platform is not supported with an on-premise Synthetic server
- API monitoring PSA is not supported with on-premise Controllers
Prerequisites
| Docker | Kubernetes | Minikube |
|---|---|---|
|
|
|
Hardware Requirements
The following tables list the hardware components and their recommended configuration for Docker, Kubernetes, and Minikube environments:
Docker
| Component | Description | Minimum | Recommended | ||||||
|---|---|---|---|---|---|---|---|---|---|
Instance | CPU | RAM (GB) | Disk (GB) | Instance | CPU | RAM (GB) | Disk (GB) | ||
Heimdall | An orchestrator that connects to the Synthetic Cloud to fetch measurement jobs for the PSA cluster. | 1 | 1 | 1 | 1 | 2 | 2 | ||
| Apache Ignite | In memory cache | 1 | 0.5 | 0.5 | 2 | 1 | 1 | 1 | 20 |
Web Monitoring Measurement Container | A temporary or short-lived container auto-orchestrated by Heimdall to execute Web Monitoring measurements. | As per your requirement | 0.5 | 1 | As per your requirement | 1.25 | 2 | ||
API Monitoring Measurement Container | A temporary or short-lived container auto-orchestrated by Heimdall to execute API Monitoring measurements. | As per your requirement | 0.1 | 0.1 | As per your requirement | 0.1 | 0.1 | ||
Kubernetes
Component | Description | Minimum Configuration | Recommended Configuration | ||||
|---|---|---|---|---|---|---|---|
| # Instances | Per Instance | # Instances | Per Instance | ||||
| Heimdall | An orchestrator that connects to the Synthetic Cloud to fetch measurement jobs for the PSA cluster. | 1 | Processor: 2 vCPU Memory: 4 GB RAM | 2 | Processor: 3 vCPU Memory: 5 GB RAM | ||
| Apache Ignite | In memory cache | 1 | Processor: 0.5 vCPU Memory: 0.5 GB RAM | 2 | Processor: 1 vCPU Memory: 1 GB RAM | ||
| Measurement Container | A temporary or short-lived container auto-orchestrated by Heimdall to execute every measurement. (Web Monitoring PSA) The measurement container image can be customized to install additional libraries. | Based on need, a temporary container instance is scheduled for every measurement | Burst-able CPU-RAM | Based on need, a temporary container instance is scheduled for every measurement | Burst-able CPU-RAM | ||
Web Monitoring PSA: Min: 0.5 vCPU, 1 GB RAM Max: 1.25 CPU, 2 GB RAM | API Monitoring PSA: 0.1 vCPU and 100 MB RAM | Web Monitoring PSA: Min: 0.5 vCPU, 1 GB RAM Max: 1.25 CPU, 2 GB RAM | API Monitoring PSA: 0.1 vCPU and 100 MB RAM | ||||
Minikube
| Component | Description | Minimum | Recommended | ||||||
|---|---|---|---|---|---|---|---|---|---|
Instance | CPU | RAM (GB) | Disk (GB) | Instance | CPU | RAM (GB) | Disk (GB) | ||
Minikube | Minikube is a lightweight Kubernetes implementation that creates a VM on your local machine and deploys a simple cluster containing only one node. | 1 | 4 | 4 | 1 | 8 | 8 | ||
| Heimdall | An orchestrator that connects to the Synthetic Cloud to fetch measurement jobs for the PSA cluster. | 1 | 1 | 1 | 2 | 2 | 2 | ||
| Apache Ignite | In memory cache | 1 | 0.5 | 0.5 | 2 | 2 | 1 | 1 | 20 |
Web Monitoring Measurement Container | A temporary or short-lived container auto-orchestrated by Heimdall to execute Web Monitoring measurements. | As per your requirement | 0.5 | 1 | As per your requirement | 1.25 | 2 | ||
API Monitoring Measurement Container | A temporary or short-lived container auto-orchestrated by Heimdall to execute API Monitoring measurements. | As per your requirement | 0.1 | 0.1 | As per your requirement | 0.1 | 0.1 | ||
Number of Measurement Containers
You can calculate the number of required concurrent containers using this formula:
( (Number of Jobs) x (Average job duration in minutes) / (Frequency in minutes))
For example, the number of containers required for 10 jobs with an average duration of 30 seconds per job executed at 5-minute interval needs:
(10 x (30/60) ) / 5 ) = 1 container
Concurrent Measurements
The Kubernetes cluster specifications determine the number of concurrent measurements that can be executed. Any submission of jobs beyond the infra limits leads to the queuing of jobs in the Kubernetes cluster. To scale the number of concurrent jobs automatically, enable cluster auto-scaler. K8S auto-scaler functionality depends on the cloud or the managed service provider.
To set up Web Monitoring PSA and API Monitoring PSA in any of these environments, see: