• 1: Product Overview
• 1.1: Technical Product Features
• 2: Getting Started
• 2.1: Deployment Types & Architecture
• 2.2: Portal Sign Up and Login
• 2.3: Execute a Simple HTTP/S Test
• 2.4: Convert a Selenium IDE Test to a RealLoad Test
• 3: Release Notes
• 4: Synthetic Monitoring
• 5: API
• 5.1: Remote Admin API
• 5.2: Remote User API
• 5.3: Remote User Monitoring API
• 6: User Guide
• 6.1: AWS Measuring Agents
• 6.2: Recording of a Web Surfing Session
• 6.3: HTTP Test Wizard
• 6.4: HTTP/S Remote Proxy Recorder
• 7: Browser Recorder extensions for both Chrome and Firefox
• 8: Desktop Companion
• 8.1: Release Notes
• 8.2: Desktop Companion - Pre-requisites
• 8.3: Desktop Companion - Download and run
• 8.4: Desktop Companion - Settings Menu
• 8.5: Desktop Companion - File Menu
• 8.6: Desktop Companion - Editor
• 8.7: Desktop Companion - Measuring Agents
• 8.8: Desktop Companion - Proxy Recorder
• 9: Mobile Companion App
• 10: Regression Testing - Test Suites
• 11: Table Server
• 12: Developer Guide
• 12.1: Developing a JUnit Monitoring Test
• 13: Installation
• 13.1: Ubuntu: Measuring Agent manual install
• 13.2: Ubuntu: Cluster Controller manual install
• 13.3: Ubuntu: Portal Server manual install
• 13.4: Ubuntu: Remote Proxy Recorder manual install

1 - Product Overview

What is RealLoad?

RealLoad is an Enterprise Tool to perform next generation Load Testing, Regression Testing, and Synthetic Monitoring.

Due to the universal product architecture, a Test of any Type supported by RealLoad can be executed as:

• Load Test
• Regression Test
• Synthetic Monitoring Job

The following Types of Tests are supported::

• ‘HTTP Test Wizard’ Tests - Web Surfing Sessions and HTTP API Tests.
• JUnit Tests - Testing any type of Network Protocol (such as DNS, SMTP or UDP).
• Selenium IDE and Playwright Tests - Execution of Real Web Browser Tests.

Regardless of what type of test you are running, all measured data are displayed directly in real time in form of statistics and charts.

All work steps can be carried out within the web interface of the RealLoad Portal which:

• contains simple and powerful dialogs.
• contains numerous wizards, so no programming is required in most cases.
• does not require to configure any JSON and XML files.

In addition, using the RealLoad Portal offers many other advantages, for example:

• Web surfing sessions can be recorded with a ready-for-use Remote HTTP/S Proxy Recorder and post-edited with a powerful wizard.
• JUnit tests can measure Additional Statistics and Charts, declared on the fly.
• Selenium IDE tests can be converted into RealLoad tests using a wizard.
• A powerful graphical Test Suite Editor supports the compilation of Regression Tests.
• The Synthetic Monitoring Dashboard gives you a complete overview of the last 24 hours by displaying real-time sparklines (micro charts) per each monitoring job.
• Multiple load generators can be combined into a cluster, with the test results of the cluster members are combined into a single test result - displayed in real time - for all types of tests.

Complete Overview of All Product Features

1.1 - Technical Product Features

Image Title

Universal ‘RealLoad Tests’

‘RealLoad Tests’ are universal, abstract tests which can created from any type of test. All types of tests can be executed as:

• Load Test
• Regression Test
• and as Synthetic Monitoring Job

Creating a ‘RealLoad Test’ is usually easy and supported by wizards and powerful dialogs.

Types of Tests

The following Types of Tests are supported:

• ‘HTTP Test Wizard’ Tests - Web Surfing Sessions and API Tests
  • HTTP Test Wizard’s tests simulate only the network traffic from an HTTP client to HTTP servers - without running a web browser’s rendering engine. This allows extremely efficient testing of the web servers.
  • Web Sessions can be either created manually - by entering URL HTTPS GET/POST… requests - or by recording a Web Browser Surfing Session using a RealLoad HTTP/S Proxy Recorder.
  • No Programming Required - All functionalities can be carried out using powerful dialogs with just a few mouse clicks and form entries.
  • Support of handling dynamically exchanged Session Variables using a wizard and by editing the session in the Remote Debugger.
  • Support of HTTP response verification
  • Support of Session Cookies
  • Support of PKCS12 Client Certificates
  • Support of parallel executed HTTP requests
  • Support of User Input Fields
  • Support of Input Files (from which variables can be extracted)
  • Support of Conditional Jumps to Session Elements (conditional GoTo)
  • Support of ‘HTTP Test Wizard’ Plug-Ins which are invoked during test execution
  • Support of multiple client TCP/IP addresses during test execution (requires special OS configuration on Measuring Agents)
  • Can be debugged using a powerful Remote Debugger
  • The ‘HTTP Test Wizard’ generates powerful, performance optimized code that does not need to be edited manually. Depending on the hardware resources of a load generator (Measuring Agent), up to 5000 virtual users can be executed in parallel per load generator. In addition, by combining multiple load generators into a cluster, an almost unlimited load can be achieved.
  
• ‘RealLoad’ JUnit Tests - Testing any type of network protocol
  • ‘RealLoad’ JUnit Tests can be converted from any JAR file which contains original JUnit Tests by using a wizard, or can be written from scratch.
  • Due to the generic nature of JUnit tests, any type of network protocol can be tested while taking full advantage of the RealLoad infrastructure (e.g. running as load tests, part of a regression test, and executed as monitoring job).
  • Additional Features of RealLoad JUnit Tests written from scratch:
    • Support of User Input Fields
    • Support of Additional Measured Statistics and Charts, declared on the fly inside the JUnit test (in addition to the @Test execution time).
  
• ‘RealLoad’ Selenium IDE and Playwright Tests - Execution of Real Web Browser Tests
  • ‘RealLoad’ Selenium IDE Test can be converted from any exported Selenium IDE Test by using a wizard, or can be written from scratch.
  • Support of Firefox and Google Chrome browser.
  • Support of User Input Fields.
  • The executed tests take a final screenshot of the simulated web browser at the end of each surfing session.
  • The tests can take full advantage of the RealLoad infrastructure (e.g. running as load tests, part of a regression test, and executed as monitoring job). However, due to the high CPU load when executing such tests, only a few simulated users can run per load generator at the same time (typically 5 to 50).
  

Load Tests

• Support of all types of ‘RealLoad Tests’.
• All measured data (and errors) are displayed in real-time during test execution.
• Support Clusters of Load Generators with up to several hundred cluster members (Measuring Agents). This enables you to execute load tests with an almost unlimited strength of load, with more than 1,000,000 concurrent VUs, for ‘HTTP Test Wizard’ Tests and for JUnit Tests.
• Cluster Features:
  • Assembling a cluster of load generators is easy and can be done with just a few mouse clicks.
  • The content of Input Files can be split among the cluster members.
  • The real-time view of the measured data is also available at cluster level.
  • The test results of the cluster members are combined into a single test result.

Regression Tests

• Support of all types of ‘RealLoad Tests’.
• With a powerful Graphical Editor you can create and edit Test Suites and their tests with just a few mouse clicks and form entries.
• All tests of a Test Suite support to be executed with multiple of concurrent users (same as load tests).
• The tests of a Test Suite are grouped into “Execution Groups”, where the Execution Groups can be executed in sequential or parallel order.
• The progress of a Test Suite “run” can be viewed in real-time.
• The results of the Test Suite “runs” are archived and can be compared with each other.
• A “run” of a Test Suite can be triggered either interactively or via an API.

Synthetic Monitoring

• Support of all types of ‘RealLoad Tests’.
• Multiple “Monitoring Groups” can be defined, each containing multiple “Monitoring Jobs”.
• Each “Monitoring Job” references an (abstract) ‘RealLoad Test’, whereby the same properties as for a Load Test Job can be configured per “Monitoring Job”, i.e. the number of executed virtual users.
• Multiple “Measuring Agents” can be configured per “Monitoring Group” which means that the corresponding “Monitoring Jobs” are executed from multiple geographical locations. The measurement results of the Measuring Agents are combined into a single result, whereby the individual result of each Measuring Agent is still available.
• The Real Time Dashboard displays the status of all Monitoring Groups and Jobs, and displays also real time sparklines (micro charts) per Monitoring Job about the availability and the response times of the last 24 hours.
• Statistics about the availability and performance of the Monitoring Groups and Jobs can be displayed in a freely selectable time period, and can be exported to a PDF and MS Word document. This also allows you to check whether the requirements of an SLA (Service Level Agreement) have been met.
• Detailed data for each individual test execution of a Monitoring Job can be displayed.
• Support for Multiple Alert Groups that refer to Alert Devices - which can be configured differently depending on the type of alert.
• Supported Alert Devices: Email, Mobile Companion App (installed on a mobile phone), SMS and Webhooks (RealLoad native, Pagerduty and Slack).
• In addition to release Alert Notifications about measured warnings and errors, an alert can also be triggered if the Performance of a Monitoring Job is poor.
• Support for Delayed Alert Notifications: Alert notifications can be triggered immediately or only after one or several repeats.
• A fully documented API enables developers to implement their own version of a Synthetic Monitoring “Real Time Dashboard”.

RealLoad Portal - Features and Licenses

• Fully integrated functionalities. All work steps can be carried out within the portal.
• Simple and powerful dialogs. All functions can be carried out via the web user interface. And all of this without the need to configure any JSON and XML files.
• Multiple team member accounts can be created per main user account, although certain team members can only have read rights.
• After Sign Up to the portal, a remote HTTP/S Proxy Recorder and two shared Measuring Agents (load generators with limited capacity) are immediately available to you for free. In addition you will get 20 free ‘Cloud Credits’.
• Additional Measuring Agents (load generators), Cluster Controllers and Remote Proxy Recorders that are needed for a short time can be easily started via the portal in the AWS cloud by using of ‘RealLoad Cloud Credits’. The advantage of using ‘Cloud Credits’ is that you do not have any cost risk from forgetting to terminate the instances, and that you don’t need an own AWS account. Depending of your license, you can also start additional (private) Measuring Agents under your own AWS account, by using our Desktop Companion App, or by sign in directly into the AWS console.
• According to your license, you can also operate private Measuring Agents, Cluster Controllers and Remote Proxy Recorders yourself or have us operate them. You can register such components directly in the portal in your account.
• Powerful API with over 70 functions. Such as creating new projects, uploading and downloading files, starting load test jobs and downloading their results, starting regression tests and downloading their results, implementing your own synthetic monitoring dashboard.

RealLoad Core Components

All core components are independent OS processes that can be executed on Linux and Windows:

• Portal Server
• Measuring Agent ¹ - Execution of tests.
• Cluster Controller ¹ - Combines multiple Measuring Agents to a cluster.
• Remote HTTP/S Proxy Recorder ¹ - Recording of HTTP/S web surfing sessions.
• Table Server - Stores values of (previous) tests, which can be used as input for next tests.

¹ = Available as public AWS/EC2 image

RealLoad Apps

Using locally installed RealLoad applications is optional, but can be quite useful:

• Desktop Companion - can be installed on Mac OS X and Windows
  • Generate HTTP Load Test scripts from HTTP archives (.har) files.
  • Locally run the RealLoad HTTP/S Proxy Recorder (local recording of HTTP Test Wizard ‘Tests’).
  • Perform some basic editing of test scripts.
  • Upload test scripts directly to the RealLoad Portal.
  • Manage AWS Measuring Agents by using your own AWS account (launch, terminate, register with RealLoad Portal).
   
• Mobile Companion - can be installed on Android mobile phones
  • Displays a simplified real-time view of the Synthetic Monitoring Dashboard.
  • The mobile phone can be used as a Synthetic Monitoring Alert Device. You will receive instant push notifications when a monitoring job detects an error or warning - and when this issue have been resolved.

RealLoad Browser Extensions

The use of RealLoad browser extensions is optional, but allows you to conveniently control the recording of a web surfing session in combination with a Remote HTTP/S Proxy Recorder.

• Browser Extensions are available for Firefox and Google Chrome.

2 - Getting Started

This section of the documentation will walk you through the first steps in order to getting started with the RealLoad Product.

Follow the next sections of the document and you should be able to run your first basic test script using the SaaS Evaluation scenario within 20 minutes.

Let us know if encounter any issues while getting started, as that will help us updating this documentation to make it as clear and user friendly as possible. Please email us at support@realload.com

2.1 - Deployment Types & Architecture

First of all you’ll have to decide which RealLoad deployment type better suits your needs. These guidelines should assist you in making an informed decision.

Architecture

There a few components that make up the RealLoad solution. Most components are available under an SaaS model which doesn’t require any infrastructure commitment from your side.

If required by security or other constraints, some or all components can be deployed on your own infrastructure. Please reach out to us to discuss requirements if you’re planning to go down this road.

The key components that make up RealLoad’s solution are:

The Portal Server

• Exposes the main GUI to end users.
• All tasks to maintain Load Testing or Synthetic Monitoring scripts are performed here.
• Load Tests are can be triggered via the Portal.
• The Synthetic Monitoring dashboard is visible here and shows the current state of configured tests.

Measuring Agent

• Load Test and Synthetic Monitoring scripts are executed from Measuring Agents.
• For Synthetic Monitoring purposes, you can use shared or dedicated agents to execute your tests from.
• The Measuring Agent needs to be reachable from RealLoad’s portal server and needs to be able to reach the servers to be load tested or monitored.
• You can have multiple Measuring Agents, for example to execute Synthetic Monitoring tests from different locations.

There are 2 options for your to run AWS cloud based Measuring Agents:

• Using our Cloud Credits: The relevant Virtual Machines are spun up from our portal under our own AWS account and you pay a usage fee using Cloud Credits you’ve previously purchased from us.
• By starting pre-configured AWS AMIs under your own AWS account. You’ll be charged directly for AWS related costs.

Cluster Controller (Optional)

• If your Load Testing requirements exceed the load generating capacity of a single Measuring Agent, you can combine multiple agents in a cluster using a Cluster Controller.
• Like measuring agents, Cluster Controllers can be hosted in the cloud or on your own infrastructure, as per your requirements.

Proxy Recorder (Optional)

• You can use the Proxy Recorder component in order to develop test scripts by recording HTTP traffic while it transits through it.
• The Proxy Recorder can be run in the cloud, as a service on your own infrastructure or directly on your Desktop using the Desktop Companion.

Typical deployment scenarios

Load Testing using Cloud Credits

The RealLoad portal gives you the ability to launch load generators (Measuring Agents) in the AWS cloud with a click of button and the execute a load test.

Key features and requirements are:

• You’re not required to have an AWS account, as the Measuring Agent is run under RealLoad’s AWS account.
• You pay for the AWS and RealLoad licensing costs using previously purchased Cloud Credits.
• The application to be load tested needs to be reachable from the Measuring Agent’s public IP address, assigned by AWS at launch.

• Cloud Credits can be purchased in the RealLoad shop, at this link: https://shop.realload.com/cloud-credits-2
• The cost charged by RealLoad to run Measuring Agents using Cloud Credits varies by AWS EC2 instance type. See this table for details: https://shop.realload.com/cloud-credits

Load Testing by running the Measuring Agent behind perimeter firewall

Using Cloud Credits is not an option if the servers to be performance tested are not exposed to the internet. In this scenario, the Measuring Agent will need to be deployed behind perimeter firewalls as follows:

• In AWS: You can launch our pre-configured AMIs under your AWS account and attach them to your VPCs.
• If preferred, Measuring Agent instances can be launched using our convenient Desktop Companion application.
• If running on non-AWS infrastructure: Install the Measuring Agent on a supported Linux Distribution.

Key features and requirements are:

• The Measuring Agent needs to be reachable from the internet based Portal Server. You’ll need to configure firewall and NAT rules on your perimeter firewall to allow communication.
• You’ll need to update the Measuring Agent software from time to time, to stay compatible with updates on the Portal Server.
• You’ll need to purchase a Load Testing license to suit your load requirements.

• See our online shop for pricing of commonly used license sizes. Reach out to us if you have different licensing requirements. https://shop.realload.com/load-test-licenses

Synthetic Monitoring of Internet exposed services

Typically Synthetic monitoring is use to monitor services that are exposed to the internet. RealLoad uses Measuring Agents to implement the monitoring functionality.

We recommend executing Synthetic Monitoring tests from at least 2 Measuring Agents, to cater for transitory local disruptions (like network issues or agent software updates) which might trigger false positive alerts.

There are two types of agents you can use for monitoring purposes:

• Shared Agents: These are Monitoring Agents shared by multiple customers. Using these agents is included in the basic cost of the monitoring service.
• Dedicated Agents: If you need to execute monitoring from a specific location or you don’t want to use a shared agent, we can setup a dedicated agent for you. This will incur additional costs, plz reach out to us to discuss.

Key features and requirements are:

• The application or service to be monitored needs to be reachable from the internet.
• You’ll need to subscribe to a Synthetic Monitoring plan. Reach out to us for pricing.

Synthetic Monitoring of services running behind perimeters firewalls

Should you have the need to monitor services within your perimeter, this can be arranged by deploying Measuring Agents within your networks.

Key features and requirements are:

• You’ll need to deploy two measuring agents behind the firewall perimeter. For AWS deployments your can use our existing AMIs, for other infrastructure install the Measuring Agent on a supported Linux Distribution.
• You’ll need to update the Measuring Agent software from time to time, to stay compatible with updates on the Portal Server.
• The Measuring Agents need to be reachable from the internet based Portal Server. You’ll need to configure firewall and NAT rules on your perimeter firewall to allow communication.
• You’ll need to subscribe to a Synthetic Monitoring plan. Reach out to us for pricing.

2.2 - Portal Sign Up and Login

If you already have an account, you can login at https://portal.realload.com

Signing Up - Free Account Features

In order to login to the portal you’ll first have to setup an account. Go to the portal URL and click on the Sign Up button or go this URL: https://portal.realload.com/SignUp

You’ll need to provide:

• Email address.
• Mobile phone number.
• No credit card required, it’s completely free.

Account deletion

To have your account deleted, please send an email to support@realload.com. We’ll then reach out to you to confirm deletion.

Your account will be immediately disabled and all your data will be removed within 90 days, including backups.

Sign Up Process

Step 1 of 4

Provide your details, including email and mobile number. All data you enter in this form are only required to verify your identity and will not be shared with any third parties.

Step 2 of 4

Validate your email address.

Step 3 of 4

Validate your mobile number

Step 4 of 4

Configure your nickname and password

Welcome Page with Examples

Once you signed up, you will be automatically loggedIn and the welcome page will be displayed. Three examples are shown which are also available online:

• Execution of a Simple HTTP/S Test
• Converting a Selenium IDE Test to a RealLoad Test
• Developing a JUnit Monitoring Test

2.3 - Execute a Simple HTTP/S Test

This example shows how a simple HTTP/S Test can be defined as a RealLoad ‘Test’ and executed as both a Load Test Job and a Monitoring Job.

The test sequence is manually entered into the HTTP Test Wizard to keep this example simple. However, you can also record HTTP/S tests using an HTTP/S Proxy Recorder and convert the recording into a HTTP Test Wizard session.

Pre-Requisites

To configure and execute a simple test you’ll need:

• Access to the RealLoad portal. If you haven’t signed up, do so first Sign Up
• Approx. 20..30 minutes of your time
• A cup of tea or coffee

1. Invoke the HTTP Test Wizard and Create a New Session

Enter the Headline that briefly describes what the test does.

2. Save the (empty) Session

It’s best to save the empty session now. To do this, you must select a Resource Set of a Project. Alternatively, you can also create a new ‘Project’ and/or ‘Resource Set’. ‘Resource Sets’ are something like sub-directories of a Project, which contain all the files necessary to define and execute a test.

Enter the file name for the session, e.g. HttpSession_TestDownloadServer.json and save the session.

In this example, a new Project named ‘HTTP Tests’ is created which also contains a new Resource Set named ‘Download Server’.

3. Add URLs to the Session

Click on the ‘Add’ dropdown and select ‘URL’.

Enter the URL and click on the ‘+’ icon at ‘Verify HTTP Response’.

At ‘Verify HTTP Status Code’ select ‘200 OK’ and then click the ‘Add URL’ button.

You can then add additional URLs to the session. In this example it looks like this:

4. Debug the Session

Before converting the session into a RealLoad ‘Test’ you should Debug the Session first. This way you can check whether all URL calls are working correctly. Click ‘Debug Session’.

This invokes a powerful Remote Debugger that runs always on a Measuring Agent. As shown at the top right of the following image you can also select an alternative Measuring Agent on which the debugger will run.

In the debugger you can also extract values from HTTP responses and assign them to succeeding HTTP requests, whereby the session is automatically synchronized between the debugger and the HTTP Test Wizard.

In the debugger, click Next Step until all URLs have been executed successfully and the end of the session has been reached - or until an error occurs. If an error occurs, exit the debugger, then repair the URL (= HTTP/S request), and then invoke the debugger again.

After debugging is successful, return to the HTTP Test Wizard.

5. Save the (debugged) Session

6. Generate and Compile the Code, and Define the RealLoad ‘Test’

After the source code is compiled, click ‘Define New Test’.

Enter the Test Description, and click ‘Define New Test’.

The RealLoad ‘Test’ is now defined. From here you can now create both a Load Test Job and a Monitoring Job.

Note: In case you (later) modify the session in the HTTP Test Wizard, you will have to generate and compile the source code again.

7. Define and Execute a Load Test Job

In the RealLoad ‘Test’ click ‘Define Test Job’.

In next menu click ‘Continue’ …

… And select the Measuring Agent on which the Load Test Job will be executed, then click ‘Define Load Test Job’.

The Load Test Job is now defined. Click ‘Start Test Job’.

Enter the settings of the Load Test Job here and then click ‘Start Test Job’. We recommend the following settings for the first load test run:

1. Number of Users: 5
2. Max. Test Duration (Seconds): 60
3. Max. Loops per User: [unlimited]
4. Loop Iteration Delay (Milliseconds): 1000
5. Ramp Up Time (Seconds): 10

After a few seconds the Load Test Job is in the state ‘Running’. Click ‘Monitor Jobs’.

The real-time data of the running Load Test Job is now displayed.

Click on ‘Analyze Result’ after the Load Test Job is completed.

The Load Test Job result is then displayed.

To view the Job Output Files navigate to ‘Load Test Jobs’ and click in the dropdown of the Job on ‘Job Log Files’.

Select the file users.out which contains the Log Output of the Job.

If you would like to run the Load Test Job again with the same or changed settings, click on ‘Clone Job’ in the Job dropdown and then start the cloned job.

8. Define a Monitoring Job

If this is your first Monitoring Job, you must first create a Monitoring Group. Navigate to Monitoring, click the ‘Configuration’ tab and then click ‘Add Monitoring Group’. There is also a help available for configuring the Synthetic Monitoring.

Enter the ‘Group Title’ and select at least one ‘Measuring Agent’ on which the Monitoring Job(s) will be executed. Then click ‘Add Monitoring Group’.

In the ‘Monitoring Group’ click ‘Monitoring Jobs’ and then click ‘Add Monitoring Job’.

Select the ‘Test’ of the Monitoring Job.

Click ‘Define Monitoring Job’.

Enable the execution of the Monitoring Group and navigate to ‘Dashboard’.

The Monitoring Job is now defined and will be executed periodically. For additional help configuring monitoring (e.g. adding ‘Alert Devices’), see Monitoring Help.

Tip: If you modify the RealLoad ‘Test’, the corresponding Monitoring Job is not automatically updated to avoid unexpected corruption of the Monitoring Job. After you have verified the modified ‘Test’ by running a small Load Test Job, you must manually update the Monitoring Job.

Done, congrats, you’ve run your first test with Real Load.

9. Conclusion and Prospects

As you have seen, a RealLoad Test can be run as both a Load Test Job and a Monitoring Job.

This example was deliberately kept simple so that you can become familiar with the RealLoad product. To create a test with a web browser session across multiple web pages, you can use a Remote Proxy Recorder to record the test case and then convert the recording into an HTTP Test Wizard session.

Additionally, a Test Job Template can also be defined from any ‘Load Test Job’, which can then be part of a Test Suite. This means that you can add multiple ‘Test Job Templates’ to a Test Suite and execute them in a single run as a Regression Test.

To learn more, we recommend you read the User Guide. There you will find detailed documentation on the steps described in this document.

2.4 - Convert a Selenium IDE Test to a RealLoad Test

This example shows how a Selenium IDE Test - which was recorded with a Chrome or Firefox web browser - can be converted into a RealLoad ‘Test’. The converted RealLoad ‘Test’ can then be executed both as a Load Test Job and as a Monitoring Job. In addition, the converted test can also be part of a Test Suite for performing Regression Tests.

In most cases, the conversion can be done easily with just a few mouse clicks - without the need for any special settings.

At the end of each executed test run (of the converted RealLoad test), a final screenshot of the simulated web browser session is taken for each virtual user so that you can check whether the web browser session of the virtual user has been fully executed.

Tip: If possible, always use the Chrome web browser for Selenium IDE recording, as Chrome sessions are simulated much faster (= more realistic) than Firefox sessions.

Pre-requisites

To configure and execute this test you’ll need:

• Access to the Real Load portal. If you haven’t signed up, do so first: Sign Up
• Approx. 20..30 minutes of your time
• A cup of tea or coffee

1. Export the Selenium IDE Test as JUnit Test

Export the your recorded Selenium IDE Test as Java JUnit file and save the file to any folder on your local device. Note that the 3-dot dropdown icon may initially be hidden and may only appear when you are near to the Selenium ‘Test Case’ area. Do not choose any export option.

2. Upload the exported Selenium JUnit File

At Projects menu click on the ‘Developer Tools’ dropdown and select ‘Convert Selenium IDE Test to Real Load Test’.

Then upload the file by ‘Upload File’ or by dragging and dropping the file into the dashed area.

3. Convert the Uploaded JUnit File

Click on the ‘Convert’ button after uploading the file. The converted Java code is then displayed. Then click on the ‘Save & Compile’ button.

You have to save the converted code in a Resource Set of a Project. You can also first create a new Project with a new Resource Set.

After saving the converted code, you will be automatically redirected to the Compile Java File dialog.

4. Compile the Converted JUnit File

The JAR files required to compile are already preselected, i.e. you need only click the ‘Compile’ button.

After successful compilation, click ‘Define or Update Selenium by JUnit Test’.

You will then be automatically redirected to the Define JUnit & Selenium Test dialog.

5. Define the Selenium RealLoad ‘Test’

Select the JUnit @Test method (in this case only one will be shown) and click ‘Define Test’.

In an intermediate step you can enter an (optional) test description.

Now the Selenium RealLoad ‘Test’ is defined from which you can define a Load Test Job and/or a Monitoring Job.

6. Note about Measuring Agents

Please note that not all Measuring Agents support the execution of Selenium jobs. You can ‘ping’ a Measuring Agent at application level to find out whether Selenium jobs are supported:

Example 1: Measuring Agent ‘Demo Agent 1 (CH)’ does not support Selenium jobs

Example 2: Measuring Agent ‘Demo Agent 2B (CH)’ supports Selenium jobs

3 - Release Notes

4.8.38 | 2024-04-21

• New Features: The User Guide has been completely revised. In this context, the portal’s online documentation was also revised and enhanced, which now refers to the corresponding chapters of the user guide.
• Changes:
  • HTTP Test Wizard ‘Output Files’ are now stored in the in the output directory of the test job.
• Bug Fixes:
  • Compiling the code generated by the HTTP Test Wizard failed if the content of an HTTP request was very large.
• Portal Server version 4.8.38 requires now Measuring Agent and Cluster Controller version 4.5.12

4.8.37 | 2024-03-12

• New Features:
  • New Mobile Companion App released. The Mobile Companion is a small Android App that displays a simplified view of the Synthetic Monitoring Dashboard and can receive and display Synthetic Monitoring Alert Notifications.
    • This App gives you an overview of the status of your Synthetic Monitoring Jobs at any time - without having to sign in to the Portal Server.
    • The App also notifies you immediately if a Monitoring Job detects an error or warning.
    • By installing this App on your mobile device, you are always informed whether the operation of your services and servers is working reliably.
    • Documentation and Installation Instructions
• Announcement: Currently the Mobile Companion App can be installed on Android devices only. Support for Apple iOS will be available in around the next 2 months.

4.8.34 | 2024-02-20

• Synthetic Monitoring API Documentation
  • Full Synthetic Monitoring API documentation is now available to support developers to implement their own version of a real-time dashboard for Synthetic Monitoring that can be displayed on their companies screen.
  • The powerful API also supports receiving data for drawing charts and sparklines. In addition, the API documentation contains helpful information about implementation and runtime behavior.
  • See https://kb.realload.com/docs/api/remoteusermonitoringapi/

4.8.31 | 2024-01-18

• New Features:
  • The Welcome Page that appears after ‘Sign Up’ to the RealLoad Portal now displays 3 ‘Test’ examples, all of which can be run as a Load Test, a Synthetic Monitoring Test, and a Regression Test. These 3 examples are also available in the public documentation:
    • Execution of a Simple HTTP/S Test
    • Converting a Selenium IDE Test to a RealLoad Test
    • Developing a JUnit Monitoring Test

4.8.30 | 2023-12-27

• New Features:
  • Synthetic Monitoring: Added configurable performance alert thresholds for the measured time per loop (= average passed session time). Two performance alert threshold values (in milliseconds) can be configured per monitoring job. One to trigger a warning and another to trigger an error. If one of these thresholds is reached or exceeded, a performance warning or performance error is added to the test result, which has the same effect as measuring a “normal” error with a severity of “Warning” or “Error”.
• Portal Server version 4.8.30 requires now Measuring Agent and Cluster Controller version 4.5.11

4.8.29 | 2023-12-17

• New Features:
  • Synthetic Monitoring: Added real-time Sparklines (microcharts) to the Real Time Dashboard. The sparklines with a time range of the last 24 hours show the measured availability for monitoring groups, and for monitoring jobs the measured availability and the measured response times (milliseconds per loop). The displayed time range of the sparklines can be zoomed by clicking on the chart while holding down the mouse button and panning to the right or left in the chart. After releasing the mouse button, the zoom of the corresponding area appears. If necessary, you can then zoom in again to narrow down the area further.

4.8.28 | 2023-12-14

• New Features:
  • Slightly redesigned Synthetic Monitoring user interface.
    • Real-Time Dashboard: The dashboard supports now to show only monitoring groups or only monitoring jobs - or both of them (as before).
    • Real-Time Dashboard: The displayed availability of Monitoring Groups and Jobs for the last 24 hours is now a hyperlink that, when clicked, displays the corresponding statistical chart.
    • All Synthetic Monitoring menus and popups have been revised to make them more descriptive and user-friendly.
• Bug Fixes:
  • Synthetic Monitoring: Webhook alert calls which return a HTTP status code 202 (instead of 200) are no longer logged as failed.

4.8.27 | 2023-12-07

• New Features:
  • Synthetic Monitoring: Support for delayed alert notifications: Alert notifications can now be triggered immediately (as before) or (new) only after one or several repeats. This means that short-period errors and downtimes can be excluded from alert notifications. This does not affect the measured statistics such as availability and detected errors. Delayed alert notification settings can be configured separately for each “Alert Group”, whereby multiple alerts groups can be assigned to one or multiple “Monitoring Groups” and “Monitoring Jobs”.

4.8.26 | 2023-11-28

• New Features:
  • Synthetic Monitoring: Added support for ‘Monitoring Downtimes’. A Monitoring Downtime is a window of time during which synthetic monitoring is temporarily disabled. Multiple monitoring downtimes can be defined for all monitoring groups, or for specific monitoring groups and also for specific monitoring jobs. In addition, a monitoring downtime can be repeated daily, weekly or monthly.

4.8.24 | 2023-11-12

With this new release we have reached the point where a general load testing tool has been crossed with a monitoring tool and also with a regression testing tool - with both the monitoring tool and the regression testing tool are capable of executing test jobs with hundreds or thousands of concurrent users.

• New Features:
  • Real Load Test Suites
    • Test suites are the grouping of multiple test job templates and are executed as a single “run” with different test scenarios.
    • Due to the universal architecture, test jobs of any kind can be part of a test suite (HTTP Test Wizard Jobs, JUnit Jobs, Selenium Jobs ..).
    • The results of the test suite “runs” are archived and can be compared with each other.
    • In addition, the result of a particular test job of a test suite run can be compared with the result of the same test job executed by other test suite runs.
    • All test jobs of a test suite support the powerful ability to be executed with hundreds or thousands of concurrent users and can even executed on a cluster of measuring agents.
    • The test jobs of a test suite are grouped into “execution groups”, where the test jobs of an execution group can be executed in sequential or parallel order.
    • The execution groups can be nested, whereby a separate measuring agent or measuring agent cluster can be defined for each execution group.
    • A “run” of a test suite can be triggered either interactively or via the Remote User API.
  • The following functions have been added to Remote User API:
    • getTestExecutionSuites
    • getCurrentlyRunningTestExecutionSuiteIds
    • startTestExecutionSuiteTestRun
    • getTestExecutionSuiteTestRunResultDetail
    • getTestExecutionSuiteTestRunTestJobOutputFileContent
    • deleteTestExecutionSuiteTestRun
  • Tests: Delete Test: A warning message will now be displayed if the test is referenced by a Monitoring Job or by a Test Suite.
  • Tests: Option “Delete All Unreferenced Tests” added.
  • Load Test Jobs: The display of load test jobs can now filtered by Project and Resource Set.
• Bug Fixes:
  • Starting a load test job failed in rare cases due to a synchronization problem.
• Portal Server version 4.8.24 requires now Measuring Agent and Cluster Controller version 4.5.10

4.8.23 | 2023-09-18

• New Features:
  • Added support for ‘Test Job Templates’.
  • The following functions have been added to Remote User API:
    • getTestjobTemplates
    • defineNewTestjobFromTemplate
    • submitTestjob
    • makeTestjobReadyToRun
    • startTestjob
    • getMeasuringAgentTestjobs
    • getTestjobOutDirectoryFilesInfo
    • getTestjobOutDirectoryFile
    • saveTestjobOutDirectoryFileToProjectTree
    • deleteTestjob

4.8.21 | 2023-09-13

• New Features:
  • Improved integration of JUnit Test with the Real Load architecture. As already described earlier, any JAR file that contains JUnit test can be uploaded to the portal server and executed directly as a test, i.e. without conversion. However, if you are programming a JUnit test from scratch, you can benefit from the additional enhanced features of the Real Load architecture. These additional features include better log output of the executed JUnit test, support for “User Input Fields” (configurable test input parameters), and the measurement and display of additional statistics obtained during test execution.
  • After logging into the portal server, a new project called “Developer Examples” will appear, which contains an example of a JUnit test and shows how a JUnit test can be fully integrated into the Real Load architecture.

4.8.20 | 2023-09-10

• New Features:
  • Added support for executing Selenium IDE tests with Google Chrome.
  • When a Measuring Agent is pinged at application level, it is displayed whether the Measuring Agent supports the execution of Selenium tests.
• Changes:
  • The Selenium version sent to Measuring Agents is now 4.12.1 instead of 4.10.0. However, this only applies to tests that are newly created.
• Portal Server version 4.8.20 requires now Measuring Agent version 4.5.9 when Selenium IDE tests with Google Chrome are executed.

4.8.19 | 2023-09-04

• New Features:
  • Added support for executing Selenium IDE tests. Selenium IDE tests recorded on your local device can be executed as monitoring job and as load test job - by exporting them in the Selenium IDE as ‘Java JUnit’ test and then importing them into the Real Load portal. The imported tests support also ‘User Input Fields’ (configurable options when starting a test) and take a final screenshot of the (virtual) Web browser display just at the end of each test run - which can then be viewed in the Real Load portal. Currently only tests recorded with Firefox are supported. Support for tests recorded with Chrome and Edge will be added soon.
  • Added support for executing JUnit 4 tests. JAR files which contain ready-to-use JUnit @Test(s) can be uploaded to the Real Load portal and run directly as a monitoring job and as a load test job. The benefit of running JUnit tests on the Real Load infrastructure is firstly that they can be run as a “monitoring job” and secondly that they can be run as a “load test job” with many hundreds of JUnit tests, running concurrently in parallel (or even with many thousands of JUnit tests running in parallel, through the use of a cluster of Real Load Measurement Agents). However, this is usually only useful for JUnit tests which are testing or stressing network services of any kind.
• Portal Server version 4.8.19 requires now Measuring Agent and Cluster Controller version 4.5.8

4.8.17 | 2023-07-29

• New Features:
  • Synthetic Monitoring: Support of ‘Pagerduty V2’ and ‘Slack’ Webhook alert devices added.
  • Test Results: The selected test result can now exported to a PDF and to a MS Word document.
  • ‘HTTPS Server Certificate Tool’ added.
• Changes:
  • HTTP Test Wizard: The URL HTTP timeout can now specified in milliseconds (instead of seconds).

4.8.14 | 2023-06-29

• New Features:
  • Revised Sign-Up: When sign-up, two shared Measuring Agents are now assigned to the new user account.
  • For customers (user accounts) who do not operate their own HTTP/S Remote Proxy Recorder, a temporary HTTP/S Remote Proxy Recorder from a pool is now assigned each time they sign-in.
  • Synthetic Monitoring: A warning sign is now displayed for Monitoring Groups for which no Measuring Agent have been defined.
• Portal Server version 4.8.14 requires now HTTP/S Remote Proxy Recorder version 1.1.3, and Measuring Agent and Cluster Controller version 4.5.7

4.8.13 | 2023-06-20

• New Features:
  • HTTP Test Wizard ‘URL Plugins’ can now be assigned in one step to multiple or all URLs of a HTTP/S session.
• Changes:
  • Sent SMS messages now have the sender ID ‘RealLoad’ instead of a (technical) phone number.
• Bug Fixes:
  • Synthetic Monitoring: No alert was send at monitoring group level when an execution timeout occurred.

4.8.12 | 2023-06-07

• New Features:
  • Measuring Agents which are shared with other Portal Server user accounts (other customers) are now marked with [P] = ‘partial shared’ or [S] = ‘fully shared’ in the Measuring Agents menu. Measuring Agents that are operated exclusively for a specific customer do not have such a mark.
  • The ‘My Account -> Price Plan’ menu shows now the number of sent SMS monitoring alerts of the current month, and also of the last 12 months.
  • Price Plan limits for Synthetic Monitoring have been implemented and are now shown in the ‘My Account -> Price Plan’ menu.
• Changes:
  • The primary Mobile Number for main user accounts and team member accounts no longer needs to be unique across all Real Load accounts.
  • Measuring Agent Housekeeping: The data of executed jobs older than 30 days are now deleted on Measuring Agents (monitoring jobs + load test jobs).
• Bug Fixes:
  • Team member accounts with read/only privileges could make changes to the Synthetic Monitoring configuration.

4.8.10 | 2023-05-11

• New Features:
  • HTTP Test Wizard
    • ‘Conditional Jump’ session element added. For example, this new session element allows a webpage to be called in a loop until the received content contains a certain value, or until a maximum number of conditional jumps is exceeded. Adding multiple conditional jumps per session is supported, with the ability to jump backwards or forwards. The condition of whether to jump and where to jump can be determined by variable values.
    • Java JVM warm-up before starting a test. Tests that run with only one or a few users and loops are now more accurately measuring URL response times by performing a Java JVM warm-up before starting the test.
    • The log-data of measured errors have been improved (less but more meaningful data).
  • Projects Menu
    • The preview of the test results shows now additionally the ‘Avg. Passed Session Time’.
  • Load Test Jobs Menu
    • A new delete option ‘All Completed Jobs - Except the Last Ones’ has been added.
  • Test Results Menu
    • The ‘Avg. Passed Session Time’ is now show in the Summary Statistic.
    • Searching for Text values in an Error Detail ‘Log’ and in an Error Detail ‘Context’ is now supported.
• Changes:
  • HTTP Test Wizard
    • Errors reported at URL level are no longer additional reported at Measurement Group level.
  • Test Execution
    • The number of stored errors is now limited to 2000 fully stored errors plus 8000 partial stored errors (partial stored: without error log and without error context).
• Portal Server version 4.8.10 requires now Measuring Agent and Cluster Controller version 4.5.6
• To take advantage of the new features you have to re-generate and re-compile the Java source code in the HTTP Test Wizard.

4.8.8 | 2023-04-05

• New Features:
  • Menu Measuring Agents
    • Measuring Agent Log File: The log file is displayed faster in the browser and supports now searching for text fragments. The time zone of the log file is now also displayed.
    • List Remote Test Jobs: The display of the Job Type was added (‘Load Test’ or ‘Monitoring’).
• Bug Fixes:
  • In rare cases the start a job failed on Measuring Agents.
  • In rare cases the Synthetic Monitoring Availability Chart did show wrongly a green bar (OK) instead of a red bar (Error).
• Portal Server version 4.8.8 requires now Measuring Agent and Cluster Controller version 4.5.5

4.8.7 | 2023-03-26

• New Features:
  • Synthetic Monitoring
    • “Statistics” Submenu added which shows statistics and charts of monitoring groups and monitoring jobs, such as availability, cumulated error time and performance. The time range can be selected arbitrary. In addition, single, historical measurements can be selected and their details displayed (e.g. to analyze a measured error).
    • The Real Time Dashboard shows now for the monitoring jobs the availability of the last 24 hours in percent.

4.8.4 | 2023-03-03

• New Feature:
  • The Synthetic Monitoring Real Time Dashboard shows now the (average) performance of the last executed monitoring jobs in the unit of milliseconds per passed loop. Background information: A monitoring job can be defined with a strength of up to 5 concurrent users and with up to 5 test-loops per user. This value shows the average execution time of the successful executed test-loops overall concurrent users.

4.8.3 | 2023-02-28

• New Features:
  • Synthetic Monitoring added: The same scripts used for load testing can now also be used to periodically check the uptime and performance of your critical business transactions. This means that a Monitoring Job can be defined from an already existing Test (similar as to define a Load Test Job). The Monitoring Jobs can be combined to Monitoring Groups whereby each Monitoring Group can have its own settings. Multiple Measuring Agents can be assigned to a Monitoring Group in order that the assigned Monitoring Jobs are executed from several, different locations (for example from New York, Berlin and Singapore). Supported Monitoring Alert Devices are Email, SMS and Webhooks.
  • WebSocket API for Synthetic Monitoring added: This WebSocket API enable developers to implement their own version of a Synthetic Monitoring “Real Time Dashboard”.
• Portal Server version 4.8.3 requires now Measuring Agent and Cluster Controller version 4.5.4

4.7.8 | 2022-11-06

• New Features:
  • Desktop Companion: An ‘OS X Intel Installation Kit’ and an ‘OS X ARM Installation Kit’ are now available at https://download.realload.com
  • Remote Proxy Recorder
    • Support of Client Certificates (PKCS12 files) that can uploaded to the Portal Server and applied for target server authentication on all Remote Proxy Recorders. The uploaded client certificates are automatically transmitted to the Remote Proxy Recorder(s) when connecting from the Portal Server to a Remote Proxy Recorder.
    • The log files of Remote Proxy Recorders can now be viewed in the Portal Server Web UI.
    • ‘Ping’ and ‘Connect’ to a Remote Proxy Recorder in the Portal Server Web UI now show an error message for outdated/incompatible Remote Proxy Recorder versions.
    • Any changes made at Remote Proxy Recorder settings for ‘Hosts Recording Filter’, ‘URL Filter’ and ‘URL Filter Quick Setting’ are now saved on the Portal Server and reapplied when connecting from the Portal Server to any Remote Proxy Recorder.
• Bug Fixes:
  • HTTP/S session recording (with Remote Proxy Recorder and Desktop Companion) failed on Apple macOS and iOS client devices.
  • HTTP Test Wizard URL Explorer - Variables Wizard: variable names for JSON HTTP-request ‘variable assigners’ were not displayed.
  • HTTP Test Wizard Generate Code: The “Java Class Name” can now have a lowercase letter at the beginning.
• Portal Server version 4.7.8 now requires Remote Proxy Recorder version 1.1.1

4.7.6 | 2022-10-17

• New Features:
  • HTTP Test Wizard: Variable Assigner for ‘General Request Header Field’ added.
  • HTTP Test Wizard: Select Multiple Session Elements - ‘URL Filter Quick Settings’ menu added.
  • HTTP Test Wizard Debugger: Support to set/update the ‘Recorded Data’ of an executed URL (shown in the HTTP Test Wizard URL Explorer). This functionality can be used for further test optimization (e.g. if the content of a tested URL has been changed on the server side, or if the URL response is as yet unknown).
  • HTTP Test Wizard Debugger: Menu ‘Search in executed URLs’ added.
• Bug Fixes:
  • HTTP Test Wizard URL Explorer | Variables Wizard: Bug Fix for automatically applied variable assigners which replace URL-Encoded/Decoded values.
  • Measuring Agent - Data Collector: Bug Fix for supporting large measured Error Details.
• Portal Server version 4.7.6 requires now Measuring Agent and Cluster Controller version 4.5.2

4.7.3 | 2022-8-28

• New Features:
  • HTTP Test Wizard: New menu “URL Explorer” added. The URL Explorer shows all the details of the recorded HTTP session data and also supports searching within it. Furthermore, the URL Explorer also contains a “Variables Wizard” which displays all distinct values clearly sent in an HTTP session and makes it much easier to extract and assign session variables.
  • HTTP Test Wizard / Review and Edit URL Settings: This menu has been revised and enhanced. Two new auto-configurations wizards are available with which the content of HTTP responses can be automatically checked for keywords and with which the parallel execution of HTTP calls can be configured automatically.
  • HTTP Test Wizard / Debugger: UI improved.
  • A new “Text Phrase Tool” has added. This tool determines the most meaningful human-readable text phrases or keywords from any given content (HTML/JSON/XML). This tool has also been integrated into the HTTP Test wizard.
  • Remote Proxy Recorder: “URL Filter Quick Setting” menu added.
  • Remote Proxy Recorder: “Convert Recording to HTTP Test Wizard Session” improved and enhanced.
  • Portal Server (all menus): Large screen support has been improved.
  • Admin Menu: Mobile Companion API integrated and “Mobile Companion App - Test & Logs” menu added.
• Bug Fixes:
  • HTTP Test Wizard / Generate Code: The measured statistic IDs of executed load tests have now the same values as the indexes of the HTTP Test Wizard session elements.
  • Load test programs generated by the HTTP Test Wizard did not correctly measure the response time in some cases when an HTTP response had no response content (bug fix in com.dkfqs.tools.jar, new version 2.3.0).
• Portal Server version 4.7.3 requires now Measuring Agent and Cluster Controller version 4.5.0, and Remote Proxy Recorder version 1.0.0

4.6.8 | 2022-5-19

• Bug Fixes:
  • Adding of cluster members to AWS/EC2 ‘Cluster Controller’ instances which have launched by cloud credits did fail.
  • The status of cluster jobs was not updated by the real-time monitor.
  • Deleting of test jobs did fail if the corresponding cluster was no longer defined.
  • Starting of cloud instances is now prevented if the portal’s internal monitoring system is no longer working.
• Portal Server version 4.6.8 requires now Measuring Agent version 4.2.0 (bug fix: incorrect measurement results were reported sporadically)

4.6.7 | 2022-5-18

• New Features:
  • AWS/EC2 ‘Remote Proxy Recorders’ can now be started by cloud credits.
  • Preview of ‘Remote Proxy Recorder CA Root Certificate’ added when downloading a remote proxy recorder CA root certificate.
  • 40 seconds countdown to left navigation added when launching EC2 instances by cloud credits.

4.6.5 | 2022-5-10

• New Features:
  • Support for team member accounts added:
    • Depending on the license (price plan), a normal user (main user) can also define sub-users (so-called team member accounts).
    • Team members can login as usual, with their email and password.
    • Team members can either have the same rights as the main user or alternatively only have read rights.
    • The team members (including the main user) can communicate with each other via push messages. The portal also shows which team member is currently online. Offline team members receive an email instead of an online push notification.
    • A list of all team members is provided for each team member (inclusive the main user), which contains the profile text and profile image of each team member.
    • Team member accounts are not portal-wide ‘public users’, and cannot act as public technical expert.
• Bug Fixes:
  • Deleting of test jobs did fail if the corresponding measuring agent was no longer defined.

4.6.4 | 2022-4-18

• New Features:
  • Support of special licenses to top up the amount of ‘Cloud Credits’.
  • License restrictions on the maximum number of Measuring Agents and Remote Proxy Recorders no longer apply when such components are launched by spending Cloud Credits.
  • The Web Browser interface has been optimized to support large screens.

4.6.2 | 2022-4-12

• New Features:
  • Support of ‘Sign in with Microsoft’ added.

4.6.0 | 2022-4-10

• New Features:
  • The list of excluded AWS/EC2 regions can now be edited in the admin menu.
  • The additional data transfer costs of AWS/EC2 instances which are started via the Portal Server are now billed via Cloud Credits.
  • A new Measuring Agent version 4.1.0 is available which is able to automatically configure the Java memory of the ‘Data Collector’ and the Java memory of executed Java test programs.
• Portal Server version 4.6.0 supports Measuring Agent version 4.0.4 and version 4.1.0

In order to enable the automatic Java memory configuration of a Measuring Agent 4.1.0, the following Java program arguments must be set in the startup script: -autoAdjustMemory -osReservedMemory 1GB

Furthermore, the Java memory of the Measuring Agent should be set in the startup script as shown in the table below:

Example: sudo -H -u dkfqs bash -c ‘CLASSPATH=/home/dkfqs/agent/bin/bcpkix-jdk15on-160.jar:/home/dkfqs/agent/bin/bcprov-jdk15on-160.jar:/home/dkfqs/agent/bin/bctls-jdk15on-160.jar:/home/dkfqs/agent/bin/DKFQSMeasuringAgent.jar;export CLASSPATH;nohup java -Xmx512m -DdkfqsMeasuringAgentProperties=/home/dkfqs/agent/config/measuringagent.properties -Dnashorn.args="–no-deprecation-warning" com.dkfqs.measuringagent.internal.StartDKFQSMeasuringAgent -autoAdjustMemory -osReservedMemory 1GB 1>/home/dkfqs/agent/log/MeasuringAgent.log 2>&1 &’

4.5.0 | 2022-3-27

• New Features:
  • Amazon AWS/EC2 instances of ‘Measuring Agents’ and ‘Cluster Controllers’ can now be started directly in the Portal Server - without the customer needing an Amazon AWS account. The costs of such started AWS/EC2 instances are charged to the customer via so-called ‘Cloud Credits’, whereby the number of ‘Cloud Credits’ can be purchased as an integral part of a license or can also be purchased separately. For customers who register for the first time at the Portal Server, a free amount of ‘Cloud Credits’ will be credited to allow them try out this functionality. Note: It is still fully supported to launch Amazon AWS/EC2 instances of ‘Measuring Agents’ and ‘Cluster Controllers’ with your own Amazon AWS account by using the standalone tool ‘Desktop Companion’.
  • User Top Navigation: Link to Download Server and to Real Load Store added (both links are manageable by the administrator menu).
  • HTTP Test Wizard: Review and Edit URLs menu added.
  • Launched Cloud Instances menu added.
  • Cloud Credit Statement menu added.
  • Measuring Agents & Cluster Controllers menu: The ‘List of Predefined AWS/EC2 Measuring Agent AMIs’ shows no longer incompatible AMI versions.
  • The following new functions have been added for administrators:
    • User Accounts menu: Cloud Credit Statement menu per user added.
    • Server Settings menu: AWS/EC2 Cloud Provider API Settings section added.
    • Customize Auth Users Navigation menu: Download Components and Shop sections added.
    • Cloud Providers & Instance Type Credit Costs menu added.
    • Inspect AWS/EC2 Cloud Instances menu added.
    • Launched Cloud Instances menu added.
    • Cloud Credit Transactions menu added.

Advantages and disadvantages of ‘Cloud Credits’ versus launching AWS/EC2 instances by the ‘Desktop Companion’:

Benefits of ‘Cloud Credits’:

• Full cost control. Cloud instances are automatically terminated after a selected time.
• Easy to use. Seamless integration with the portal server.
• No Amazon AWS account required and therefore no security issue for unauthorized AWS access.

Advantages of the ‘Desktop Companion’:

• Lower costs for cloud instances compared to ‘Cloud Credits’(AWS self-cost are charged only).
• Suitable for customers who use cloud instances frequently and are aware of AWS/EC2 costs involved.

4.4.4 | 2022-1-30

• New Features:
  • Load-releasing Clusters of Measuring Agents are now supported. In order to operate a cluster, a separate process/component is required (so-called “Cluster Controller”) which is not part of the portal server and is operated by the customer himself. Cluster-Features:
    • Multiple clusters can be registered in the portal server using the UI, and the cluster members (measuring agents) can be assigned to the clusters with simple clicks.
    • Depending on the power of the Cluster Controller, a cluster can have several 100 members, which allows to perform load tests of almost unlimited strength (up to millions of concurrent users).
    • A cluster job can be started as easily as a normal job. The only difference is that a cluster is selected for execution instead of a single measuring agent.
    • Optionally, the content of input files can be automatically divided among the cluster members (e.g. if they contain user account credentials).
    • Cluster jobs support all runtime features like normal jobs: suspend job, resume job, stop job and kill job. Entering annotations at runtime is also supported.
    • The real-time display of cluster jobs is exactly the same as for normal jobs, but the statistics displayed at real time already contain the combined values of all cluster members. In addition, a table about the current operating status of each cluster member is available.
    • After a cluster job has been completed, the test result contains the combined values of all cluster members (analogous to the real-time display). In addition, the individual test results of the cluster members can also be displayed.
  • The following functions have been added to the “Remote User API”:
    • getMinRequiredMeasuringAgentVersion
    • getMinRequiredClusterControllerVersion
    • getMinRequiredProxyRecorderVersion
    • getMeasuringAgentClusters
    • getClusterControllers
    • pingClusterController
    • addMeasuringAgentCluster
    • addMemberToMeasuringAgentCluster
    • removeMemberFromMeasuringAgentCluster
    • pingMeasuringAgentClusterMembers
    • setMeasuringAgentClusterActive
    • deleteMeasuringAgentCluster
  • Portal Server “Measuring Agents” menu: The AWS/EC2 popup highlights now incompatible AMI versions.
  • Portal Server “Test Jobs” menu: The log files of executed jobs can now directly copied to the project tree.
• Bug Fixes:
  • A test job can now also have the state “execution failed”.
• Portal Server version 4.4.4 requires now Measuring Agent version 4.0.4

4.3.23 | 2021-11-13

• New Features:
  • HTTP Test Wizard: New Session Element ‘Outbound IP Address’ added. In order that this element can be used, multiple valid IP addresses must be assigned to the network interface of the Measuring Agent(s).
  • HTTP Test Wizard: Support of specific HTTP processing timeout per URL added.
  • Test Results: Support of annotation and annotation events added. The annotation and annotation events can be added at runtime during the test and are shown in the test result. In addition, annotation events can also be reported via the All Purpose Interface and generated, for example, by HTTP Test Wizard plug-ins.
• Bug Fixes:
  • The cached HTTP Test Wizard Session in the Portal Server UI is now updated when a variable is defined, modified or deleted, and when a variable extractor or a variable assigner is deleted.
  • Invalid Java code was generated by the HTTP Test Wizard if the error handling of URLs was set to ‘Continue as usual’.
  • Performance bottleneck fixed in com.dkfqs.tools.http.HTTPClient (occurred since previous version 4.3.22).
  • An incorrect error exception was thrown in com.dkfqs.tools.crypto.EncryptedSocket when an SSL handshake timeout occurred
  • Realtime charts sometimes showed inexact measurement results.
• Portal Server version 4.3.23 requires now Measuring Agent version 3.9.33 and DKFQS Tools version 2.2.25

4.3.22 | 2021-10-24

• Documentation: All Purpose Interface added.
• The All Purpose Interface has been extended by 3 new statistics types that can be declared at runtime:
  • average-and-current-value : An average and current value
  • efficiency-ratio-percent : An efficiency ratio in percent (0..100%)
  • throughput-time-chart : A chart of a throughput per second
• The measurement results of the HTTP Test Wizard now contain the following additional test-specific values (if the executed HTTP Test Wizard session contains URL session elements):
  • Total Bytes Sent
  • Total Bytes Received
  • Network Throughput in Mbps (real-time: current value, test result: average value and chart)
  • Average TCP Connect Time in milliseconds (real-time: + latest value)
  • Average SSL Handshake Time in milliseconds (real-time: + latest value)
  • HTTP Keep-Alive Efficiency (0..100%)
• Bug fix: The time in the name of the test result files is now always set in the time zone of the portal server, regardless of which time zone the Measuring Agents are operated.
• Portal Server version 4.3.22 requires now Measuring Agent version 3.9.32 and DKFQS Tools version 2.2.24

4.3.21 | 2021-09-18

• Searching for a text in all files of the project tree is now supported.
• Support to upload files by drag and drop added.
• Bug fix for assigning variables to HTTP requests in HTTP Test Wizard debugger.
• Bug fix on real time statistics and test results if the measured unit is other than ms.
• User profile images can now have a max size of 400 KB instead of 200 KB.
• CA Root Certificates of HTTP/S Proxy Recorder(s) can now be downloaded via the Portal Server UI.
• Documentation: User Guide added.
• SNMP Plug-In published at https://portal.realload.com/publicPublishedPlugins

Portal Server Installation / Ubuntu 20: The “fontconfig” package has to be installed in order that the captcha generator is working:

sudo apt-get update
sudo apt-get install fontconfig

4.3.20 | 2021-08-07

• HTTP Test Wizard Plug-Ins can now be published and are then available to other users.
• The following HTTP Test Wizard Plugin fields are now protected by algorithms and cannot be manually modified by the JSON editor:
  • pluginId
  • authorNickname
• A (new) “Resources Library” project is automatically created for each user in the Project Tree which contains by default the following “Resource Sets”:
  • “HTTP Test Wizard Plug-Ins”: by default empty
  • “Java”: contains always the latest version of com.dkfqs.tools.jar
  • “PowerShell”: contains always the latest version of DKFQSLibrary2.psm1
• The “Resources Library” project contains common resources which are used by multiple projects. The users can add additional resource sets and files as needed to this project.
• The file com.dkfqs.tools.jar is no longer copied to the corresponding resource set when a HTTP Test Wizard test is generated. Instead of this the generated test contain now a reference to “Resources Library / Java / com.dkfqs.tools.jar”.
• New created HTTP Test Wizard Plug-Ins contain now by default a reference to the resource file “Resources Library / Java / com.dkfqs.tools.jar”.
• More than 50 minor bugs have been fixed and some improvements have been made to the portal user interface.
• Portal Server version 4.3.20 requires now Measuring Agent version 3.9.31
• Existing tests and plug-ins should be upgraded to use com.dkfqs.tools.jar version 2.2.21 (located at “Resource Sets / Java”). This means that the tests have to be generated and defined once again.
• The tuning parameters of Linux operating systems on which “Measuring Agents” run must be increased:

in /etc/security/limits.conf add or modify:

# TCP/IP Tuning
# =============
* soft     nproc          262140
* hard     nproc          262140
* soft     nofile         262140
* hard     nofile         262140
root soft     nproc          262140
root hard     nproc          262140
root soft     nofile         262140
root hard     nofile         262140

Enter: systemctl show -p TasksMax user-0

output: TasksMax=8966

if you get a value less than 262140 then add in /etc/systemd/system.conf

# System Tuning
# =============
DefaultTasksMax=262140

Reboot the system and verify the settings. Enter: ulimit -n

output: 262140

Enter: systemctl show -p TasksMax user-0

output: TasksMax=262140

4.3.18 | 2021-07-06

• Support of Licenses added. Multiple licenses per user account are supported. New licenses can be entered via the Admin Menu and via the User Menu. Users whose license has expired can enter a new license during sign-in.
• Pluggable Architecture for License Providers implemented.
• Remote Admin API and Remote User API added. The corresponding API Authentication Tokens can be generated via the Admin Menu and via the User Menu. See API Documentation.
• Unix Time Tool in User Menu added.
• User accounts that are since a long time expired are now automatically deleted - including all user specific data. The number of days between the expiry date and the deletion date can be configured in the Admin Menu.
• Deleted user accounts can now be viewed in the Admin Menu.
• Portal Server version 4.3.18 requires now Measuring Agent version 3.9.30

4.3.14 | 2021-04-08

• Support of multiple Price Plans / Limits for User Accounts such as Disk-Space, Number of Measuring Agents, Account expires time … (Admin Menu).
• Access to Measuring Agents can now (optional) protected by an Authentication Token (password).
• Configurable Default Price Plan for Sign Up (Admin Menu).
• Configurable HTML content for Sign Up steps 1 to 4 and for (new) Sign Up completed “Welcome Page” (Admin Menu).
• Test jobs are now digitally signed. This means that the following job settings on a Measuring Agent cannot be modified after the job has been transmitted to the Measuring Agent: type of job, local test job ID, number of users, maximum test duration.

4 - Synthetic Monitoring

Synthetic Monitoring is an essential part of Digital Experience Monitoring, where organizations can detect their service outages or performance degrade proactively by periodically running the tests.

RealLoad provides an easy way of configuring synthetic tests with an outcome of accurate metrics, alerting and SLA details.

RealLoad Synthetic Monitoring Features

• Due to the universal architecture, RealLoad Tests of any kind can be run as a Monitoring Job (HTTP Test Wizard tests, JUnit tests, Selenium IDE tests).
• Monitoring Jobs can be assigned to multiple Measuring Agents, which means that the job is executed from different geographical locations. The measurement results of the Measuring Agents are combined into a single result, whereby the individual result of each Measuring Agent is still available.
• Support for performance warning thresholds.
• Support for delayed alarm notifications.
• Supported alert devices: Email, Mobile Companion App (installed on a mobile phone), SMS and WebHooks (including Pagerduty and Slack).
• Synthetic monitoring jobs can also run with hundreds of virtual users ¹
  ¹ = does not apply to Selenium IDE and Playwright Tests (max. 5..50 users per Measuring Agent due to the high CPU usage)
• Custom dashboards can be created for third-party products like Grafana using the WebSocket API.

Prerequisite: Define a Test

You have first to define a RealLoad ‘Test’ before you can add it to Synthetic Monitoring.

Configure Synthetic Monitoring

First add a Monitoring Group and then add one or more Monitoring Jobs to the Monitoring Group. If you want to run Monitoring Jobs with different intervals, you can also define several Monitoring Groups. Measuring Agents will be available for selection based on how many agents are already configured on different geographical locations.

Add Monitoring Group

Input Fields:

• Group Title : Must be unique across all monitoring groups.
• Group Description : Optional description.
• Max. Data Storage Time : The maximum retention period of the measured data.
• Execution Interval : The execution interval of the Monitoring Jobs.
• Execution Timeout : The execution timeout of the Monitoring Group. Tip: do not choose this too short, otherwise the Monitoring Jobs will be aborted. The execution timeout can also be greater than the execution interval. The monitoring jobs of a monitoring group are executed in sequential order.
• Primary Measuring Agent & Additional Measuring Agents : Select the Measuring Agent(s) on which the Monitoring Jobs will be executed.

After you have added a monitoring group, its execution is switched off. Switch on the execution now:

Add Monitoring Job

In a Monitoring Group, first click on ‘Monitoring Jobs’ and then in the Monitoring Jobs area on ‘Add Monitoring Job’:

Then select a Test …

… And Configure and Define the Monitoring Job:

Input Fields:

• Monitoring Job Title : Required.
• Monitoring Job Description : Optional description.
• Job Execution Enabled : Controls whether the job is executed.
• Number of Users : The number of simulated users that are started.
• Max. Test Duration : The maximum test duration.
• Max. Loops per User : The maximum number of sessions executed per user (the number of iterations of the test per user).
• Loop Iteration Delay : The delay time after a session of a user has ended until the next session of the user is started.
• Ramp Up Time : The length of time at the beginning of the test until all simulated users are started. Example: with 20 simulated users and a time of 10 seconds, a new user is started each 0.5 seconds.
• Additional Arguments : Additional values which are transferred on the command line when the test script is started. These arguments are test specific. For tests that were created with the “HTTP Test Wizard” you can specify for example the following values: “-tcpTimeout 8000 -sslTimeout 5000 -httpTimeout 60000” (TCP connect timeout / SSL handshake timeout / HTTP processing timeout) which are considered by the executed URL calls and override the default values.
• Debug Execution : This option effects that detailed information are written to the log file of the test. For example variable values which have been extracted from input files or from HTTP responses as well as variable values which are assigned at runtime. Only activate this option if you have problems with the execution of the test.
• Debug Measuring : Effects that the Data Collector of the Measuring Agent writes the JSON objects of the All Purpose Interface to its log file. This option can be enabled to debug self-developed tests that have been written from scratch.
• (User Input Fields) : If the test contains User Input Fields you can enter their values here.
• Performance Warning Alert Threshold : If switched on, a warning alert is triggered if the configured time per user loop (per user session) is exceeded.
• Performance Error Alert Threshold : If switched on, a error alert is triggered if the configured time per user loop (per user session) is exceeded.

Normally you do not have to enter any “Additional Arguments” and leave “Debug Execution” and “Debug Measuring” switched off.

Tip: We recommend that you leave options ‘Performance Warning Alert Threshold’ and ‘Performance Error Alert Threshold’ switched off for now and configure them later - after the new defined Monitoring Job has been running for a few hours.

The following limits apply for Monitoring Jobs which are executed on shared Measuring Agents:

• Number of Users: max. 5
• Max. Test Duration (Seconds): max. 300
• Max. Loops per User: max. 5

If you operate your own, private Measurement Agents (or have us to operate them), these limits do not apply - meaning you can run Monitoring Jobs with hundreds or thousands of concurrent users.

Alerting

Proceed as follows:

1. Add one or more Alert Groups.
2. Define the Alert Devices and assign them to the Alert Group(s).
3. Assign the Alert Groups to Monitoring Groups and/or to Monitoring Jobs

Add Alert Group

First click on the ‘Alert Groups & Devices’ tab and then click on ‘Add Alert Group’.

Input Fields:

• Alert Group Title : Must be unique across all alert groups.
• Alert Group Description : Optional description.
• Alert Group Enabled : Controls whether the alert group is enabled or disabled.
• Report Measured Errors : Controls whether errors measured by monitoring jobs are reported.
• Report Measured Warnings : Controls whether warnings measured by monitoring jobs are reported.
• Report System Failures : Controls whether malfunctions of the monitoring system are reported (for example if a Measuring Agent is not reachable).
• Report Execution Failures : Controls whether execution failures of monitoring jobs on Measuring Agents are reported (meaning that the start of the corresponding test job failed).
• Repeat Alerts : Controls whether the alerts for the same issue are reported repeatedly.
• Report Alerts ‘Instantly’ or ‘After n Repeat’ : Controls whether alerts are reported immediately or delayed.

Tip: For example, you can define two alert groups, one for operations and another for developers. In the developer alert group, you could turn off the switches ‘Report System Failures’ and ‘Report Execution Failures’.

Add Alert Devices

First expand the area of the alert device type and then click the ‘+’ icon:

After adding the alert device, you should test it:

Assign Alert Device to Alert Groups

After an Alert Device has been added, you can assign it to one or more Alert Groups.

Assign Alert Groups to Monitoring Groups and Monitoring Jobs

To receive Alert Notifications, you must assign the Alert Groups to Monitoring Groups and/or to Monitoring Jobs.

If you click on a bell icon you can only assign one Alert Group. However, you can click the icon multiple times to assign multiple Alert Groups.

Synthetic Real-Time Dashboard

Now the created monitoring groups with its monitoring jobs will be available under the Real-Time Dashboard like below with the important metrics and also have the option to drill down into test results

Custom dashboards can be created on third party products like Grafana, using our WebSocket API

Statistics with Performance & Availability

Next explains about the statistics data, which will be the source for many KPIs , for example to calculate the defined SLA for an application or an API service

5 - API

The portal server has three APIs:

• Remote Admin API
• Remote User API
• Remote User Monitoring API

All APIs require so-called “Authentication Tokens” to verify the access authorization. If 5 or more invalid “Authentication Tokens” are sent within 60 seconds, the corresponding remote IP address is blocked for 30 minutes.

5.1 - Remote Admin API

Generating an Authentication Token

To perform a Remote Admin API call, you must first generate an “Admin API Auth Token” in the Administrator Menu of the portal. When generating the token you can enter a purpose (only used as information) and also restrict the remote IP addresses for which the token is valid. You can also specify whether the token has read/write access or read/only access.

API Functions

The API supports the following functions (so-called “actions”):

• getAllUserAccounts (Get all user accounts of the portal server)
• getAllPricePlans (Get all price plans of the portal server)
• addLicenseCertificateToUser (Add a (new) license certificate to an user)
• getServerSettings (Get the server settings)
• setServerMaintenanceMode (Turn the server maintenance mode on or off)

Example

API HTTP/S Request

curl -v --request POST --header "Content-Type: application/json" --data "@getAllUserAccounts.json"  https://portal.realload.com/RemoteAdminAPI

API Request Data

{
  "authTokenValue": "8mKSz1UzaQg17kfu",
  "action": "getAllUserAccounts"
}

API Response Data

{"allUserAccountsArray":
[{"userId":13,"nickname":"DKF","firstName":"Max","lastName":"Fischer","primaryEmail":"max@dkfqa.com","primarySMSPhone":"+41771111111","secondaryEmail":"","secondarySMSPhone":"","accountBlocked":false,"accountCreateTime":1538556183756,"lastLoginTime":1625181623869,"lastLoginIP":"127.0.0.1","pricePlanId":1,"accountExpiresTime":-1,"pricePlanTitle":"Unlimited"},{"userId":18,"nickname":"AX","firstName":"Alex","lastName":"Fischer","primaryEmail":"alexfischer66@yahoo.com","primarySMSPhone":"+41781111111","secondaryEmail":"","secondarySMSPhone":"","accountBlocked":false,"accountCreateTime":1539874749677,"lastLoginTime":1616111301975,"lastLoginIP":"127.0.0.1","pricePlanId":1,"accountExpiresTime":-1,"pricePlanTitle":"Unlimited"},{"userId":22,"nickname":"Kes","firstName":"Kesorn","lastName":"Fischer","primaryEmail":"gsklsta@yahoo.com","primarySMSPhone":"+66000000000","secondaryEmail":"","secondarySMSPhone":"","accountBlocked":false,"accountCreateTime":1605303204754,"lastLoginTime":1624389324770,"lastLoginIP":"127.0.0.1","pricePlanId":6,"accountExpiresTime":-1,"pricePlanTitle":"BASIC1"},{"userId":48,"nickname":"BET","firstName":"Bettina","lastName":"Meier","primaryEmail":"b123456@lucini.id.au","primarySMSPhone":"+61404905702","secondaryEmail":"","secondarySMSPhone":"","accountBlocked":false,"accountCreateTime":1623719604561,"lastLoginTime":-1,"lastLoginIP":"","pricePlanId":6,"accountExpiresTime":1625061600000,"pricePlanTitle":"BASIC1"}],
"isError":false}

If the API call is successful, then the response field “isError” is false. If a numeric field has a value of -1 (minus one), this means “no data” or “unlimited” depending on the context.

getAllUserAccounts

Specific Request Fields:

• [none]

Specific Error Flags:

• [none]

getAllPricePlans

Specific Request Fields:

• [none]

Specific Error Flags:

• [none]

addLicenseCertificateToUser

Specific Request Fields:

• mapToUserEmailAddress
• mapToUserMobilePhone
• licenseProvider
• licenseCertificate

The license is successfully assigned to a user if either mapToUserEmailAddress or mapToUserMobilePhone matches to a user account.

Specific Error Flags:

• writeAccessError
• mapToUserError
• licenseProviderError
• licenseCertificateError
• licenseCertificateAlreadyAddedError
• pricePlanError

JSON Request Example:

{
  "authTokenValue":"8mKSz1UzaQg17kfu",
  "action":"addLicenseCertificateToUser",
  "licenseProvider": "Real Load Pty Ltd / nopCommerce",
  "mapToUserEmailAddress": "max@dkfqa.com",
  "mapToUserMobilePhone": "+41771111111",
  "licenseCertificate": "-----BEGIN CERTIFICATE-----\r\nMIIEnjCCA4agAwIBAgIEyDnukzANBgkqhkiG9w0BA ...... Hn/UMGAGRB6xF4w+TewYqTAZrdhi/WLyYwg==\r\n-----END CERTIFICATE-----"
}

JSON Response Example (Success Case):

{"licenseId":12,"cloudCreditLicenseId":-1,"userId":13,"isCloudCreditsLicense":false,"isError":false}

JSON Response Example (Error Case):

{"isError":true,"genericErrorText":"","writeAccessError":false,"licenseProviderError":false,"mapToUserError":false,"pricePlanError":false,"licenseCertificateAlreadyAddedError":false,"licenseCertificateError":true}

getServerSettings

Specific Request Fields:

• [none]

Specific Error Flags:

• [none]

JSON Response Example:

{
  "isServerMaintenanceMode":false,
  "isSignInSelectPricePlanFromMultipleValidLicenseCertificates":true,
  "isSignInExpiredAccountCanEnterLicenseCertificate":true,
  "isSignUpEnabled":true,
  "isSignUpRequiresInvitationTicket":false,
  "signUpDefaultPricePlanId":2,
  "signUpDefaultAccountExpiresInDays":14,
  "deleteExpiredUserAccountsAfterDays":183,
  "isError":false
}

setServerMaintenanceMode

Specific Request Fields:

• serverMaintenanceMode

Specific Error Flags:

• writeAccessError

JSON Request Example:

{
  "authTokenValue":"8mKSz1UzaQg17kfu",
  "action":"setServerMaintenanceMode",
  "serverMaintenanceMode":true
}

JSON Response Example (Success Case):

{"isServerMaintenanceMode":true,"isError":false}

5.2 - Remote User API

Generating an Authentication Token

To perform a Remote User API call, you must first sign in into the portal and generate an “API Authentication Token”. When generating the token you can enter a purpose (only used as information) and also restrict the remote IP addresses for which the token is valid.

API Functions

The API supports the following functions (so-called “actions”):

Common Functions:

• getUserAccountInfo (Get information about the own user account)
• getPricePlanInfo (Get information about the current price plan)

Projects, Resource Sets and Files Functions:

• getProjectTree (Get the project tree inclusive all resource sets and all file information)
• createProject (Create a new project)
• deleteProject (Delete a project)
• getResourceSetsOfProject (Get all resource sets of a project, inclusive all file information)
• createResourceSet (Create a new resource set)
• deleteResourceSet (Delete a resource set)
• getFilesInfoOfResourceSet (Get all files information of a resource set)
• createFile (Create or overwrite a file)
• getFile (Get the content of a file and the file information)
• deleteFile (Delete a file)

Measuring Agents Functions:

• getMeasuringAgents (Get all defined measuring agents)
• getMinRequiredMeasuringAgentVersion (Get the minimum required measuring agent version)
• addMeasuringAgent (Add a new measuring agent)
• pingMeasuringAgent (Ping a measuring agent)
• setMeasuringAgentActive (Set the state of a measuring agent to active or inactive)
• deleteMeasuringAgent (Delete a measuring agent)

Measuring Agent Cluster Functions:

• getMeasuringAgentClusters (Get all defined measuring agent clusters)
• getClusterControllers (Get all cluster controllers and for each cluster controller a list of measuring agent clusters which are referencing the cluster controller)
• getMinRequiredClusterControllerVersion (Get the minimum required cluster controller version)
• pingClusterController (Ping a cluster controller)
• addMeasuringAgentCluster (Add a new measuring agent cluster)
• addMemberToMeasuringAgentCluster (Add a member to a measuring agent cluster)
• removeMemberFromMeasuringAgentCluster (Remove a member from a measuring agent cluster)
• pingMeasuringAgentClusterMembers (Ping the cluster members of a measuring agent cluster via cluster controller)
• setMeasuringAgentClusterActive (Set the state of a measuring agent cluster to active or inactive)
• deleteMeasuringAgentCluster (Delete a measuring agent cluster)

HTTP/S Remote Proxy Recorders Functions:

• getProxyRecorders (Get all defined HTTP/S proxy recorders)
• getMinRequiredProxyRecorderVersion (Get the minimum required HTTP/S proxy recorder version)
• addProxyRecorder (Add a new HTTP/S proxy recorder)
• pingProxyRecorder (Ping a HTTP/S proxy recorder)
• deleteProxyRecorder (Delete a HTTP/S proxy recorder)
• getProxyRecordersClientCertificates (Get all client certificates for HTTP/S proxy recorders)
• addProxyRecordersClientCertificate (Add a client certificate for HTTP/S proxy recorders)
• setProxyRecordersClientCertificateActive (Set a client certificate for HTTP/S proxy recorders to active or inactive)
• modifyProxyRecordersClientCertificate (Modify a client certificate for HTTP/S proxy recorders)
• deleteProxyRecordersClientCertificate (Delete a client certificate for HTTP/S proxy recorders)

Load Test Jobs Functions:

• getTestjobTemplates (Get all test job templates)
• defineNewTestjobFromTemplate (Define new test job from template)
• submitTestjob (Submit a ‘defined’ test job to the measuring agent or to the cluster controller)
• makeTestjobReadyToRun (Turn a remote test job which is in the state ‘submitted’ into the state ‘ready to run’)
• startTestjob (Turn a remote test job which is in the state ‘ready to run’ into the state ‘running’)
• getMeasuringAgentTestjobs (Get from a measuring agent all test jobs, inclusive their states)
• getTestjobOutDirectoryFilesInfo (Get from test job information about all files located in a measuring agent job or cluster controller job ‘out’ subdirectory)
• getTestjobOutDirectoryFile (Get from a measuring agent or from a cluster controller the content of a file located in a testjob/cluster-job out subdirectory in base64 format)
• saveTestjobOutDirectoryFileToProjectTree (Get from a measuring agent or from a cluster controller the content of a file located in a testjob/cluster-job out subdirectory and save it in a resource set of the project tree)
• deleteTestjob (Delete a test job locally and also on the measuring agent or cluster controller)

Test Execution Suites Functions:

• getTestExecutionSuites (Get all test execution suites with a summary of all results of the executed test runs)
• getCurrentlyRunningTestExecutionSuiteIds (Get the ID(s) of all currently running test execution suites)
• startTestExecutionSuiteTestRun (Start a new run of a test execution suite)
• getTestExecutionSuiteTestRunResultDetail (Get a test run result detail of a test execution suite)
• getTestExecutionSuiteTestRunTestJobOutputFileContent (Get the content of a test job output file of a test execution suite run)
• deleteTestExecutionSuiteTestRun (Delete a test run of a test execution suite)

Example

API HTTP/S Request

curl -v --request POST --header "Content-Type: application/json" --data {\"authTokenValue\":\"jPmFClqeDUXaEk8Q274q\",\"action\":\"getUserAccountInfo\"}  https://portal.realload.com/RemoteUserAPI

API Request Data

{
  "authTokenValue": "jPmFClqeDUXaEk8Q274q",
  "action": "getUserAccountInfo"
}

API Response Data

{
  "userAccountInfo":{
    "userId":48,
    "nickname":"BET",
    "firstName":"Bettina",
    "lastName":"MeierHans",
    "primaryEmail":"bettina@meierhans.id.au",
    "primarySMSPhone":"+61401111111",
    "secondaryEmail":"",
    "secondarySMSPhone":"",
    "accountBlocked":false,
    "accountCreateTime":1623719604561,
    "lastLoginTime":1625348376450,
    "lastLoginIP":"127.0.0.1",
    "pricePlanId":6,
    "accountExpiresTime":1625953109397,
    "pricePlanTitle":"BASIC1"
    },
  "isError":false
}

If the API call is successful, then the response field “isError” is false. If a numeric field has a value of -1 (minus one), this means “no data” or “unlimited” depending on the context.

getUserAccountInfo

Specific Request Fields:

• [none]

Specific Error Flags:

• [none]

getPricePlanInfo

Specific Request Fields:

• [none]

Specific Error Flags:

• [none]

JSON Response Example:

{
  "pricePlanInfo":{
    "pricePlanId":6,
    "title":"BASIC1",
    "description":"",
    "isDeprecated":false,
    "lastModified":1625348413042,
    "maxDiskSpaceMB":1024,
    "maxSubUserAccounts":0,
    "maxMeasuringAgentsOwnedByUser":3,
    "maxRemoteProxyRecordersOwnedByUser":3,
    "executeLoadJobsEnabled":true,
    "executeMonitoringJobsEnabled":false,
    "apiAccessEnabled":true,
    "maxStartLoadJobsLast24h":24,
    "maxUsersPerLoadJob":500,
    "maxDurationPerLoadJob":1800
  },
  "isError":false
}

The unit for “maxDurationPerLoadJob” is seconds.

getProjectTree

Specific Request Fields:

• [none]

Specific Error Flags:

• [none]

JSON Response Example:

{
  "projectsArray": [
    {
      "projectId": 97,
      "projectName": "Common",
      "projectDescription": "",
      "resourceSetsArray": [
        {
          "resourceSetId": 154,
          "resourceSetName": "Input Files",
          "resourceSetDescription": "",
          "filesArray": [
            {
              "fileName": "InputFile.txt",
              "fileSize": 233,
              "fileHashCode": 1873256029,
              "fileLastModified": 1613835992073
            }
          ]
        },
        {
          "resourceSetId": 155,
          "resourceSetName": "Jar Files",
          "resourceSetDescription": "",
          "filesArray": [
            {
              "fileName": "com.dkfqs.tools.jar",
              "fileSize": 578087,
              "fileHashCode": -2033420926,
              "fileLastModified": 1613838181727
            }
          ]
        },
        {
          "resourceSetId": 156,
          "resourceSetName": "Plug-Ins",
          "resourceSetDescription": "",
          "filesArray": [
            {
              "fileName": "HttpSessionPlugin_ChangeCopyright.json",
              "fileSize": 5321,
              "fileHashCode": 1958407366,
              "fileLastModified": 1613838287871
            }
          ]
        }
      ]
    },
...
...
...
  ],
  "isError": false
}

createProject

Specific Request Fields:

• projectName
• projectDescription (optional)

Response Fields:

• projectId

Specific Error Flags:

• projectNameError
• diskSpaceLimitExceededError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"createProject",
  "projectName":"My New Project",
  "projectDescription": "Created by API call"
}

JSON Response Example (Success Case):

{"projectId":113,"isError":false}

JSON Response Example (Error Case):

{"isError":true,"genericErrorText":"","diskSpaceLimitExceededError":false,"projectNameError":true}

deleteProject

Specific Request Fields:

• projectId
• moveToTrash (optional, default: false)

Specific Error Flags:

• projectIdError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"deleteProject",
  "projectId":113,
  "moveToTrash":false
}

getResourceSetsOfProject

Specific Request Fields:

• projectId

Specific Error Flags:

• projectIdError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"getResourceSetsOfProject",
  "projectId":97
}

JSON Response Example (Success Case):

{
  "resourceSetsArray": [
    {
      "resourceSetId": 154,
      "resourceSetName": "Input Files",
      "resourceSetDescription": "",
      "filesArray": [
        {
          "fileName": "InputFile.txt",
          "fileSize": 233,
          "fileHashCode": 1873256029,
          "fileLastModified": 1613835992073
        }
      ]
    },
    {
      "resourceSetId": 155,
      "resourceSetName": "Jar Files",
      "resourceSetDescription": "",
      "filesArray": [
        {
          "fileName": "com.dkfqs.tools.jar",
          "fileSize": 578087,
          "fileHashCode": -2033420926,
          "fileLastModified": 1613838181727
        }
      ]
    },
    {
      "resourceSetId": 156,
      "resourceSetName": "Plug-Ins",
      "resourceSetDescription": "",
      "filesArray": [
        {
          "fileName": "HttpSessionPlugin_ChangeCopyright.json",
          "fileSize": 5321,
          "fileHashCode": 1958407366,
          "fileLastModified": 1613838287871
        }
      ]
    }
  ],
  "isError": false
}

createResourceSet

Specific Request Fields:

• projectId
• resourceSetName
• resourceSetDescription (optional)

Response Fields:

• resourceSetId

Specific Error Flags:

• projectIdError
• resourceSetNameError
• diskSpaceLimitExceededError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"createResourceSet",
  "projectId":97,
  "resourceSetName":"My New Resource Set",
  "resourceSetDescription": "Created by API call"
}

JSON Response Example (Success Case):

{"resourceSetId":172,"isError":false}

JSON Response Example (Error Case):

{"isError":true,"genericErrorText":"","resourceSetNameError":true,"projectIdError":false,"diskSpaceLimitExceededError":false}

deleteResourceSet

Specific Request Fields:

• projectId
• resourceSetId
• moveToTrash (optional, default: false)

Specific Error Flags:

• projectIdError
• resourceSetIdError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"deleteResourceSet",
  "projectId":97,
  "resourceSetId":172,
  "moveToTrash":false
}

getFilesInfoOfResourceSet

Specific Request Fields:

• projectId
• resourceSetId

Specific Error Flags:

• projectIdError
• resourceSetIdError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"getFilesInfoOfResourceSet",
  "projectId":23,
  "resourceSetId":143
}

JSON Response Example:

{
  "filesArray": [
    {
      "fileName": "DKFQSLibrary2.psm1",
      "fileSize": 16339,
      "fileHashCode": -1503445747,
      "fileLastModified": 1603566144851
    },
    {
      "fileName": "powershell-http-bern2.ps1",
      "fileSize": 12900,
      "fileHashCode": -1174212096,
      "fileLastModified": 1603566162094
    },
    {
      "fileName": "TestResult_powershell-http-bern2Neu_2020-10-24@21-06-04.json",
      "fileSize": 14395,
      "fileHashCode": -951574615,
      "fileLastModified": 1603566379097
    },
    {
      "fileName": "TestResult_powershell-http-bern2Neu_2020-10-24@21-09-45.json",
      "fileSize": 55128,
      "fileHashCode": 1499924815,
      "fileLastModified": 1603566591322
    }
  ],
  "isError": false
}

createFile

Specific Request Fields:

• projectId
• resourceSetId
• fileName
• fileContentB64 (the content of the file, in Base64 format)

Response Fields:

• fileName
• fileSize
• fileHashCode
• fileLastModified

Specific Error Flags:

• projectIdError
• resourceSetIdError
• fileNameError
• diskSpaceLimitExceededError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"createFile",
  "projectId":23,
  "resourceSetId":143,
  "fileName":"test.txt",
  "fileContentB64":"VGhpcyBpcyB0aGUgY29udGVudCBvZiB0aGUgZmlsZS4=" 
}

JSON Response Example (Success Case):

{
  "fileName":"test.txt",
  "fileSize":32,
  "fileHashCode":-1460278014,
  "fileLastModified":1625423562384,
  "isError":false
}

JSON Response Example (Error Case):

{"isError":true,"genericErrorText":"","projectIdError":false,"resourceSetIdError":false,"diskSpaceLimitExceededError":false,"fileNameError":true}

getFile

Specific Request Fields:

• projectId
• resourceSetId
• fileName

Response Fields:

• fileName
• fileContentB64 (the content of the file, in Base64 format)
• fileSize
• fileHashCode
• fileLastModified

Specific Error Flags:

• projectIdError
• resourceSetIdError
• fileNameError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"getFile",
  "projectId":23,
  "resourceSetId":143,
  "fileName":"test.txt"
}

JSON Response Example (Success Case):

{
  "fileName":"test.txt",
  "fileContentB64":"VGhpcyBpcyB0aGUgY29udGVudCBvZiB0aGUgZmlsZS4=",
  "fileSize":32,
  "fileHashCode":-1460278014,
  "fileLastModified":1625423562384,
  "isError":false
}

deleteFile

Specific Request Fields:

• projectId
• resourceSetId
• fileName
• moveToTrash (optional, default: false)

Response Fields:

• fileDeleted (a flag which is true if the file was deleted)

Specific Error Flags:

• projectIdError
• resourceSetIdError
• fileNameError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"deleteFile",
  "projectId":23,
  "resourceSetId":143,
  "fileName":"test.txt",
  "moveToTrash":false
}

JSON Response Example (Success Case):

{"fileDeleted":true,"isError":false}

JSON Response Example (Error Case):

{"isError":true,"genericErrorText":"","projectIdError":false,"resourceSetIdError":false,"fileNameError":true}

getMeasuringAgents

Specific Request Fields:

• [none]

Response Fields:

• agentId (the unique measuring agent id)
• createdBySystem (normally false, true = the user cannot modify or delete the measuring agent)
• ownerUserId (always the same as the user account id)
• agentActive (flag: if false then the availability of the measuring agent is not monitored)
• agentDescription
• agentHost
• agentPort
• authToken (the authentication token to access the measuring agent, or an empty string = no access protection | don’t confuse it with the API authTokenValue)

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"getMeasuringAgents"
}

JSON Response Example (Success Case):

{
  "measuringAgentsArray": [
    {
      "agentId": 46,
      "createdBySystem": false,
      "ownerUserId": 13,
      "agentActive": true,
      "agentDescription": "Local Agent",
      "agentHost": "127.0.0.1",
      "agentPort": 8080,
      "authToken": "OrKmpkbyNWEHok"
    },
    {
      "agentId": 49,
      "createdBySystem": false,
      "ownerUserId": 13,
      "agentActive": false,
      "agentDescription": "Rasberry 1",
      "agentHost": "192.168.0.51",
      "agentPort": 8080,
      "authToken": ""
    },
    {
      "agentId": 50,
      "createdBySystem": false,
      "ownerUserId": 13,
      "agentActive": true,
      "agentDescription": "Ubuntu 10",
      "agentHost": "192.168.0.110",
      "agentPort": 8080,
      "authToken": ""
    },
    {
      "agentId": 51,
      "createdBySystem": false,
      "ownerUserId": 13,
      "agentActive": true,
      "agentDescription": "Ubuntu 11",
      "agentHost": "192.168.0.111",
      "agentPort": 8080,
      "authToken": ""
    }
  ],
  "isError": false
}

getMinRequiredMeasuringAgentVersion

Specific Request Fields:

• [none]

Response Fields:

• minRequiredMeasuringAgentVersion (the minimum required measuring agent version)

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"getMinRequiredMeasuringAgentVersion"
}

JSON Response Example (Success Case):

{
  "minRequiredMeasuringAgentVersion":"3.9.34",
  "isError":false
}

addMeasuringAgent

Specific Request Fields:

• agentDescription (must be unique across all measuring agents of the user, cannot be an empty string)
• agentHost
• agentPort
• agentActive (flag: if false then the availability of the measuring agent is not monitored)
• agentAuthToken (the authentication token to access the measuring agent, or an empty string = no access protection)

Response Fields (JSON object “measuringAgent”):

• agentId (the unique measuring agent id)
• createdBySystem (always false for this function)
• ownerUserId (always the same as the user account id)
• agentActive (flag: if false then the availability of the measuring agent is not monitored)
• agentDescription
• agentHost
• agentPort
• authToken (the authentication token to access the measuring agent, or an empty string = no access protection)

Specific Error Flags:

• agentDescriptionError
• agentHostError
• agentPortError
• maxNumberMeasuringAgentsLimitExceededError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"addMeasuringAgent",
  "agentDescription":"Ubuntu 12",
  "agentHost":"192.168.0.112",
  "agentPort":8080,
  "agentActive": true,
  "agentAuthToken": "nixda"
}

JSON Response Example (Success Case):

{
  "measuringAgent": {
    "agentId": 53,
    "createdBySystem": false,
    "ownerUserId": 13,
    "agentActive": true,
    "agentDescription": "Ubuntu 12",
    "agentHost": "192.168.0.112",
    "agentPort": 8080,
    "authToken": "nixda"
  },
  "isError": false
}

pingMeasuringAgent

Specific Request Fields:

• agentId

Response Fields (JSON object “agentResponse”):

• pingFromRemoteIp
• pingFromRemoteUserId
• productVersion (measuring agent version | don’t confuse with portal server version)
• limitMaxUsersPerJob (limit of the measuring agent, -1 = unlimited | don’t confuse with price plan limit)
• limitMaxJobDurationSeconds (limit of the measuring agent, -1 = unlimited | don’t confuse with price plan limit)
• osName
• osVersion
• javaVersion
• javaVendor
• javaMaxMemory
• systemTime
• deltaTimeMillis
• agentStartupTimeStamp
• httpExecuteTimeMillis

Specific Error Flags:

• agentIdError
• agentAccessDeniedError
• agentVersionOutdatedError
• agentNotReachableError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"pingMeasuringAgent",
  "agentId":48
}

JSON Response Example (Success Case):

{
  "agentResponse": {
    "pingFromRemoteIp": "83.150.39.44",
    "pingFromRemoteUserId": 13,
    "productVersion": "3.9.30",
    "limitMaxUsersPerJob": 500,
    "limitMaxJobDurationSeconds": 300,
    "osName": "Linux",
    "osVersion": "4.15.0-136-generic",
    "javaVersion": "11.0.1",
    "javaVendor": "Oracle Corporation",
    "javaMaxMemory":"2048 MB",
    "systemTime": 1625513238236,
    "deltaTimeMillis": 841,
    "agentStartupTimeStamp": 1622836702172,
    "httpExecuteTimeMillis": 247
  },
  "isError": false
}

JSON Response Example (Error Case 1):

{
  "isError": true,
  "genericErrorText": "API V1 request to 192.168.0.51:8080 timed out",
  "agentIdError": false,
  "agentAccessDeniedError": false,
  "agentNotReachableError": true,
  "agentVersionOutdatedError": false
}

JSON Response Example (Error Case 2):

{
  "isError": true,
  "genericErrorText": "Min. measuring agent version required: 3.9.30",
  "agentIdError": false,
  "agentAccessDeniedError": false,
  "agentNotReachableError": false,
  "agentVersionOutdatedError": true
}

setMeasuringAgentActive

Specific Request Fields:

• agentId
• agentActive

Response Fields:

• [none]

Specific Error Flags:

• agentIdError
• agentAccessDeniedError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"setMeasuringAgentActive",
  "agentId":46,
  "agentActive":false
}

JSON Response Example (Success Case):

{"isError":false}

deleteMeasuringAgent

Specific Request Fields:

• agentId

Response Fields:

• [none]

Specific Error Flags:

• agentIdError
• agentAccessDeniedError
• agentDeleteDeniedError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"deleteMeasuringAgent",
  "agentId":54
}

JSON Response Example (Success Case):

{"isError":false}

getMeasuringAgentClusters

Specific Request Fields:

• [none]

Response Fields (JSON array “measuringAgentClustersArray”):

• clusterId (the unique cluster id)
• createdBySystem (normally false, true = the user cannot modify or delete the cluster)
• ownerUserId (always the same as the user account id)
• clusterActive (flag: if false then the availability of the cluster is not monitored)
• clusterDescription
• controllerHost (the hostname or IP address of the cluster controller)
• controllerPort (the IP port of the cluster controller)
• controllerAuthToken (the authentication token to access the cluster controller, or an empty string = no access protection | don’t confuse it with the API authTokenValue)
• clusterMembersArray
  • clusterMemberId (the unique cluster member id)
  • loadFactor (integer 0..100: the default load factor of this cluster member)
  • agentId (the referenced measuring agent id)
  • agentActive (flag: if false then the availability of the measuring agent is not monitored)
  • agentDescription
  • agentHost
  • agentPort
  • agentAuthToken (the authentication token to access the measuring agent, or an empty string = no access protection | don’t confuse it with the API authTokenValue)

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"getMeasuringAgentClusters"
}

JSON Response Example:

{
  "measuringAgentClustersArray": [
    {
      "clusterId": 11,
      "createdBySystem": false,
      "ownerUserId": 13,
      "clusterActive": true,
      "clusterDescription": "C1",
      "controllerHost": "192.168.0.50",
      "controllerPort": 8083,
      "controllerAuthToken": "aberaber",
      "clusterMembersArray": [
        {
          "clusterMemberId": 59,
          "loadFactor": 1,
          "agentId": 64,
          "agentActive": true,
          "agentDescription": "Agent 1",
          "agentHost": "192.168.0.10",
          "agentPort": 8080,
          "agentAuthToken": "OrKmAAbyNWEHok"
        },
        {
          "clusterMemberId": 60,
          "loadFactor": 1,
          "agentId": 59,
          "agentActive": true,
          "agentDescription": "Ubuntu 10",
          "agentHost": "192.168.0.110",
          "agentPort": 8080,
          "agentAuthToken": "asc7jhacab"
        },
        {
          "clusterMemberId": 61,
          "loadFactor": 1,
          "agentId": 60,
          "agentActive": true,
          "agentDescription": "Ubuntu 11",
          "agentHost": "192.168.0.111",
          "agentPort": 8080,
          "agentAuthToken": "66ascascsdac"
        }
      ]
    },
    {
      "clusterId": 14,
      "createdBySystem": false,
      "ownerUserId": 13,
      "clusterActive": true,
      "clusterDescription": "C2",
      "controllerHost": "192.168.0.50",
      "controllerPort": 8083,
      "controllerAuthToken": "aberaber",
      "clusterMembersArray": [
        {
          "clusterMemberId": 66,
          "loadFactor": 1,
          "agentId": 56,
          "agentActive": true,
          "agentDescription": "Test System",
          "agentHost": "192.168.0.60",
          "agentPort": 8080,
          "agentAuthToken": "aberdoch"
        },
        {
          "clusterMemberId": 67,
          "loadFactor": 1,
          "agentId": 59,
          "agentActive": true,
          "agentDescription": "Ubuntu 10",
          "agentHost": "192.168.0.110",
          "agentPort": 8080,
          "agentAuthToken": "asc7jhacab"
        }
      ]
    }
  ],
  "isError": false
}

getClusterControllers

Specific Request Fields:

• [none]

Response Fields (JSON array “clusterControllersArray”):

• controllerHost (the hostname or IP address of the cluster controller)
• controllerPort (the IP port of the cluster controller)
• controllerAuthToken (the authentication token to access the cluster controller)
• measuringAgentClustersArray (an array of measuring agent clusters which are referencing this cluster controller)
  • clusterId
  • clusterDescription
  • clusterActive

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"getClusterControllers"
}

JSON Response Example:

{
  "clusterControllersArray": [
    {
      "controllerHost": "192.168.0.33",
      "controllerPort": 8083,
      "controllerAuthToken": "2fasdtfffe",
      "measuringAgentClustersArray": [
        {
          "clusterId": 11,
          "clusterDescription": "C1",
          "clusterActive": 1
        },
        {
          "clusterId": 13,
          "clusterDescription": "C2",
          "clusterActive": 1
        },
        {
          "clusterId": 14,
          "clusterDescription": "C3",
          "clusterActive": 1
        }
      ]
    },
    {
      "controllerHost": "192.168.0.50",
      "controllerPort": 8083,
      "controllerAuthToken": "asfsdgh763",
      "measuringAgentClustersArray": [
        {
          "clusterId": 15,
          "clusterDescription": "C4",
          "clusterActive": 1
        },
        {
          "clusterId": 16,
          "clusterDescription": "C7",
          "clusterActive": 1
        }
      ]
    }
  ],
  "isError": false
}

getMinRequiredClusterControllerVersion

Specific Request Fields:

• [none]

Response Fields:

• minRequiredClusterControllerVersion (the minimum required cluster controller version)

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"getMinRequiredClusterControllerVersion"
}

JSON Response Example:

{
  "minRequiredClusterControllerVersion":"4.0.4",
  "isError":false
}

pingClusterController

Specific Request Fields:

• controllerHost (the cluster controller host name or IP address)
• controllerPort (the cluster controller IP port)
• controllerAuthToken (the authentication token to access the cluster controller, or an empty string = no access protection)

Response Fields (JSON object “controllerResponse”):

• pingFromRemoteIp
• pingFromRemoteUserId
• productVersion (cluster controller version | don’t confuse with portal server version)
• osName
• osVersion
• javaVersion
• javaVendor
• javaMaxMemory
• systemTime
• deltaTimeMillis
• controllerStartupTimeStamp
• httpExecuteTimeMillis
• clusterControllerOutdated

Specific Error Flags:

• controllerHostError
• controllerPortError
• controllerVersionOutdatedError
• controllerNotReachableError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"pingClusterController",
    "controllerHost":"192.168.0.50",
    "controllerPort":8083,
    "controllerAuthToken":"hagsajjs99"
}

JSON Response Example (Success Case):

{
  "controllerResponse": {
    "pingFromRemoteIp": "192.168.0.100",
    "pingFromRemoteUserId": 13,
    "productVersion": "4.0.4",
    "osName": "Linux",
    "osVersion": "4.15.0-135-generic",
    "javaVersion": "11.0.1",
    "javaVendor": "Oracle Corporation",
    "javaMaxMemory": "512 MB",
    "systemTime": 1643406118552,
    "deltaTimeMillis": 1120,
    "controllerStartupTimeStamp": 1643322597013,
    "httpExecuteTimeMillis": 249,
    "clusterControllerOutdated": false
  },
  "isError": false
}

JSON Response Example (Error Case 1):

{
  "isError": true,
  "genericErrorText": "API call pingGetControllerInfo failed. Error code = 18, Error message = Invalid authentication token",
  "controllerHostError": false,
  "controllerVersionOutdatedError": false,
  "controllerNotReachableError": true,
  "controllerPortError": false
}

JSON Response Example (Error Case 2):

{
  "isError": true,
  "genericErrorText": "Min. cluster controller version required: 4.0.4",
  "controllerHostError": false,
  "controllerVersionOutdatedError": true,
  "controllerNotReachableError": false,
  "controllerPortError": false
}

addMeasuringAgentCluster

Specific Request Fields:

• clusterActive (flag: if false then the availability of the cluster is not monitored)
• clusterDescription (must be unique across all measuring agent clusters and all measuring agents of the user, cannot be an empty string)
• controllerHost (the cluster controller host name or IP address)
• controllerPort (the cluster controller IP port)
• controllerAuthToken (the authentication token to access the cluster controller, or an empty string = no access protection)
• clusterMembersArray (an array of cluster members - can also be empty)
  • agentId (the referenced measuring agent id)
  • loadFactor (integer 0..100: the load factor of this cluster member, recommended value = 1)

Response Fields:

• clusterId (the unique cluster id)
• clusterMembersArray (the array of cluster members)
  • clusterMemberId (the unique cluster member id)
  • agentId (the referenced measuring agent id)
  • loadFactor (integer 0..100: the load factor of this cluster member)

Specific Error Flags:

• clusterDescriptionError
• controllerHostError
• controllerPortError
• agentIdError
• loadFactorError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"addMeasuringAgentCluster",
  "clusterActive":true,
  "clusterDescription":"C7",
  "controllerHost":"192.168.0.50",
  "controllerPort":8083,
  "controllerAuthToken":"aberaber",
  "clusterMembersArray":[
    {
      "agentId":59,
      "loadFactor":1
    },
    {
      "agentId":60,
      "loadFactor":1
    }
  ]
}

JSON Response Example (Success Case):

{
  "clusterId":16,
  "clusterMembersArray":[
    {
      "clusterMemberId":71,
      "agentId":59,
      "loadFactor":1
    },
    {
      "clusterMemberId":72,
      "agentId":60,
      "loadFactor":1
    }
  ],
  "isError":false
}

JSON Response Example (Error Case):

{
  "isError": true,
  "genericErrorText": "Invalid agentId = 101",
  "controllerHostError": false,
  "agentIdError": true,
  "controllerPortError": false,
  "loadFactorError": false,
  "clusterDescriptionError": false
}

addMemberToMeasuringAgentCluster

Specific Request Fields:

• clusterId
• agentId (the referenced measuring agent id)
• loadFactor (integer 0..100: the load factor of this cluster member, recommended value = 1)

Response Fields (JSON object “clusterMember”):

• clusterMemberId (the unique cluster member id)
• agentId
• loadFactor

Specific Error Flags:

• clusterIdError
• clusterAccessDeniedError
• clusterModifyDeniedError
• agentIdError
• agentAccessDeniedError
• loadFactorError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"addMemberToMeasuringAgentCluster",
  "clusterId":17,
  "agentId":64,
  "loadFactor":1
}

JSON Response Example:

{
  "clusterMember": {
    "clusterMemberId": 75,
    "agentId": 64,
    "loadFactor": 1
  },
  "isError": false
}

removeMemberFromMeasuringAgentCluster

Specific Request Fields:

• clusterId
• clusterMemberId

Response Fields:

• [none]

Specific Error Flags:

• clusterIdError
• clusterAccessDeniedError
• clusterModifyDeniedError
• clusterMemberIdError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"removeMemberFromMeasuringAgentCluster",
  "clusterId":17,
  "clusterMemberId":75
}

JSON Response Example:

{"isError":false}

pingMeasuringAgentClusterMembers

Specific Request Fields:

• clusterId

Response Fields (JSON object “controllerResponse”):

• productVersion (cluster controller version)
• clusterConnectResult (the connect information to the cluster members)
  • measuringAgentClusterMemberArray (the array of cluster members)
    • clusterMemberId
    • loadFactor
    • agentId
    • agentActive
    • agentDescription
    • agentHost
    • agentPort
    • agentAuthToken
  • connectSuccessfulClusterMemberArray (the array of cluster member ids to which the connection was successful established)
  • connectFailedClusterMemberArray (the array of cluster members to which the connection has failed)
    • clusterMemberId
    • errorMessage
  • clusterConnectStartTimestamp
  • clusterConnectDurationMillis
• clusterActionResult (the ping result of the cluster members)
  • actionSuccessfulClusterMemberArray (the array of cluster member ids which have performed the ping to the measuring agent)
  • actionFailedClusterMemberArray (the array of cluster members which have not performed the ping to the measuring agent)
    • clusterMemberId
    • errorMessage
  • jsonResponseClusterMemberArray (the array of cluster member which have performed the ping)
    • clusterMemberId
    • jsonResponseObject (the pong response of the cluster member)
      • productVersion (measuring agent product version)
      • systemTime
      • deltaTimeMillis (the OS time difference in milliseconds between the cluster controller and the measuring agent)
      • osName
      • osVersion
      • javaVersion
      • javaVendor
      • javaMaxMemory
      • samplingGranularityMillis (the data collector sampling granularity in milliseconds)
      • isError (boolean flag, normally always false)
      • measuringAgentOutdated (a boolean flag, true = measuring agent product version is outdated)
  • clusterActionStartTimestamp
  • clusterActionDurationMillis
• httpExecuteTimeMillis
• clusterControllerOutdated

Specific Error Flags:

• clusterIdError
• clusterAccessDeniedError
• controllerVersionOutdatedError
• controllerNotReachableError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"pingMeasuringAgentClusterMembers",
  "clusterId":16
}

JSON Response Example (Success Case):

{
  "controllerResponse": {
    "productVersion": "4.0.4",
    "clusterConnectResult": {
      "measuringAgentClusterMemberArray": [
        {
          "clusterMemberId": 71,
          "loadFactor": 1,
          "agentId": 59,
          "agentActive": true,
          "agentDescription": "Ubuntu 10",
          "agentHost": "192.168.0.110",
          "agentPort": 8080,
          "agentAuthToken": "agsdhagsj"
        },
        {
          "clusterMemberId": 72,
          "loadFactor": 1,
          "agentId": 60,
          "agentActive": true,
          "agentDescription": "Ubuntu 11",
          "agentHost": "192.168.0.111",
          "agentPort": 8080,
          "agentAuthToken": "nvbjnvbnn"
        }
      ],
      "connectSuccessfulClusterMemberArray": [
        71,
        72
      ],
      "connectFailedClusterMemberArray": [],
      "clusterConnectStartTimestamp": 1643410829270,
      "clusterConnectDurationMillis": 79
    },
    "clusterActionResult": {
      "actionSuccessfulClusterMemberArray": [
        71,
        72
      ],
      "actionFailedClusterMemberArray": [],
      "jsonResponseClusterMemberArray": [
        {
          "clusterMemberId": 71,
          "jsonResponseObject": {
            "productVersion": "4.0.4",
            "systemTime": 1643410829340,
            "deltaTimeMillis": -10,
            "osName": "Linux",
            "osVersion": "5.4.0-92-generic",
            "javaVersion": "11.0.1",
            "javaVendor": "Oracle Corporation",
            "javaMaxMemory": "2048 MB",
            "samplingGranularityMillis": 4000,
            "isError": false,
            "measuringAgentOutdated": false
          }
        },
        {
          "clusterMemberId": 72,
          "jsonResponseObject": {
            "productVersion": "4.0.4",
            "systemTime": 1643410829351,
            "deltaTimeMillis": -10,
            "osName": "Linux",
            "osVersion": "5.4.0-92-generic",
            "javaVersion": "11.0.1",
            "javaVendor": "Oracle Corporation",
            "javaMaxMemory": "2048 MB",
            "samplingGranularityMillis": 4000,
            "isError": false,
            "measuringAgentOutdated": false
          }
        }
      ],
      "clusterActionStartTimestamp": 1643410829349,
      "clusterActionDurationMillis": 43
    },
    "httpExecuteTimeMillis": 1778,
    "clusterControllerOutdated": false
  },
  "isError": false
}

JSON Response Example (Error Case / Partly failed):

{
  "controllerResponse": {
    "productVersion": "4.0.4",
    "clusterConnectResult": {
      "measuringAgentClusterMemberArray": [
        {
          "clusterMemberId": 71,
          "loadFactor": 1,
          "agentId": 59,
          "agentActive": true,
          "agentDescription": "Ubuntu 10",
          "agentHost": "192.168.0.110",
          "agentPort": 8080,
          "agentAuthToken": "marderzahn"
        },
        {
          "clusterMemberId": 72,
          "loadFactor": 1,
          "agentId": 60,
          "agentActive": true,
          "agentDescription": "Ubuntu 11",
          "agentHost": "192.168.0.111",
          "agentPort": 8080,
          "agentAuthToken": "marderzahn"
        }
      ],
      "connectSuccessfulClusterMemberArray": [
        72
      ],
      "connectFailedClusterMemberArray": [
        {
          "clusterMemberId": 71,
          "errorMessage": "Connection refused (Connection refused)"
        }
      ],
      "clusterConnectStartTimestamp": 1643414272214,
      "clusterConnectDurationMillis": 97
    },
    "clusterActionResult": {
      "actionSuccessfulClusterMemberArray": [
        72
      ],
      "actionFailedClusterMemberArray": [],
      "jsonResponseClusterMemberArray": [
        {
          "clusterMemberId": 72,
          "jsonResponseObject": {
            "productVersion": "4.0.4",
            "systemTime": 1643414272310,
            "deltaTimeMillis": -8,
            "osName": "Linux",
            "osVersion": "5.4.0-92-generic",
            "javaVersion": "11.0.1",
            "javaVendor": "Oracle Corporation",
            "javaMaxMemory": "2048 MB",
            "samplingGranularityMillis": 4000,
            "isError": false,
            "measuringAgentOutdated": false
          }
        }
      ],
      "clusterActionStartTimestamp": 1643414272311,
      "clusterActionDurationMillis": 21
    },
    "httpExecuteTimeMillis": 1769,
    "clusterControllerOutdated": false
  }
}

setMeasuringAgentClusterActive

Specific Request Fields:

• clusterId
• clusterActive

Response Fields:

• [none]

Specific Error Flags:

• clusterIdError
• clusterAccessDeniedError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"setMeasuringAgentClusterActive",
  "clusterId":16,
  "clusterActive":true
}

JSON Response Example (Success Case):

{"isError":false}

deleteMeasuringAgentCluster

Specific Request Fields:

• clusterId

Response Fields:

• [none]

Specific Error Flags:

• clusterIdError
• clusterAccessDeniedError
• clusterDeleteDeniedError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"deleteMeasuringAgentCluster",
  "clusterId":16
}

JSON Response Example (Success Case):

{"isError":false}

getProxyRecorders

Specific Request Fields:

• [none]

Response Fields (JSON array “proxyRecordersArray”):

• recorderId (the unique proxy recorder id)
• createdBySystem (normally false, true = the user cannot modify or delete the proxy recorder)
• ownerUserId (always the same as the user account id)
• recorderDescription
• recorderProxyHost
• recorderProxyPort (HTTP and HTTPS port of the proxy)
• recorderProxyAuthUsername (proxy authentication username, or an empty string = no proxy authentication required)
• recorderProxyAuthPassword (proxy authentication password)
• recorderControlPort (the proxy recorder control port)
• recorderControlAuthToken (the authentication token to access the proxy recorder control port, or an empty string = no access protection | don’t confuse it with the API authTokenValue)

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"getProxyRecorders"
}

JSON Response Example:

{
  "proxyRecordersArray": [
    {
      "recorderId": 3,
      "createdBySystem": false,
      "ownerUserId": 13,
      "recorderDescription": "Erster",
      "recorderProxyHost": "192.168.0.40",
      "recorderProxyPort": 8082,
      "recorderProxyAuthUsername": "",
      "recorderProxyAuthPassword": "",
      "recorderControlPort": 8081,
      "recorderControlAuthToken": ""
    },
    {
      "recorderId": 4,
      "createdBySystem": false,
      "ownerUserId": 13,
      "recorderDescription": "proxy.realload.com",
      "recorderProxyHost": "proxy.realload.com",
      "recorderProxyPort": 8082,
      "recorderProxyAuthUsername": "max.meier",
      "recorderProxyAuthPassword": "123456",
      "recorderControlPort": 8081,
      "recorderControlAuthToken": "aZujkl97zuwert"
    }
  ],
  "isError": false
}

getMinRequiredProxyRecorderVersion

Specific Request Fields:

• [none]

Response Fields:

• minRequiredProxyRecorderVersion (the minimum required HTTP/S proxy recorder version)

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"getMinRequiredProxyRecorderVersion"
}

JSON Response Example (Success Case):

{
  "minRequiredProxyRecorderVersion":"0.2.2",
  "isError":false
}

addProxyRecorder

Specific Request Fields:

• recorderDescription (must be unique across all HTTP/S proxy recorders of the user, cannot be an empty string)
• recorderProxyHost
• recorderProxyPort (HTTP and HTTPS port of the proxy)
• recorderProxyAuthUsername (proxy authentication username, or an empty string = no proxy authentication required)
• recorderProxyAuthPassword (proxy authentication password, applied if recorderProxyAuthUsername is not an empty string)
• recorderControlPort (the proxy recorder control port)
• recorderControlAuthToken (the authentication token to access the proxy recorder control port, or an empty string = no access protection)

Response Fields (JSON object “proxyRecorder”):

• recorderId (the unique HTTP/S proxy recorder id)
• createdBySystem (always false for this function)
• ownerUserId (always the same as the user account id)
• recorderDescription
• recorderProxyHost
• recorderProxyPort
• recorderProxyAuthUsername
• recorderProxyAuthPassword
• recorderControlPort
• recorderControlAuthToken

Specific Error Flags:

• recorderDescriptionError
• recorderProxyHostError
• recorderProxyPortError
• recorderControlPortError
• maxNumberProxyRecordersLimitExceededError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"addProxyRecorder",
  "recorderDescription":"My New Proxy Recorder",
  "recorderProxyHost":"192.168.0.148",
  "recorderProxyPort":8082,
  "recorderProxyAuthUsername":"max.meier",
  "recorderProxyAuthPassword":"123456",
  "recorderControlPort":8081,
  "recorderControlAuthToken":"aZujkl97zuwert"
}

JSON Response Example (Success Case):

{
  "proxyRecorder": {
    "recorderId": 10,
    "createdBySystem": false,
    "ownerUserId": 13,
    "recorderDescription": "My New Proxy Recorder",
    "recorderProxyHost": "192.168.0.148",
    "recorderProxyPort": 8082,
    "recorderProxyAuthUsername": "max.meier",
    "recorderProxyAuthPassword": "123456",
    "recorderControlPort": 8081,
    "recorderControlAuthToken": "aZujkl97zuwert"
  },
  "isError": false
}

pingProxyRecorder

Specific Request Fields:

• recorderId

Response Fields (JSON object “pongResponse”):

• pingFromRemoteIp
• pingFromRemoteUserId
• productVersion (the remote proxy recorder version | don’t confuse with portal server version)
• recorderComponentVersion (the proxy recorder component version | don’t confuse with portal server version)
• isRecording
• recordHostFilter
• numRecordedElements
• osName
• osVersion
• javaMemoryMB
• javaVersion
• javaVendor
• systemTime
• deltaTimeMillis
• httpExecuteTimeMillis

Specific Error Flags:

• recorderIdError
• recorderAccessDeniedError
• recorderNotReachableError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"pingProxyRecorder",
  "recorderId":4
}

JSON Response Example (Success Case):

{
  "pongResponse": {
    "pingFromRemoteIp": "83.150.39.44",
    "pingFromRemoteUserId": 13,
    "productVersion": "0.2.0",
    "recorderComponentVersion": "1.1.0",
    "isRecording": false,
    "recordHostFilter": "www.dkfqa.com",
    "numRecordedElements": 0,
    "osName": "Linux",
    "osVersion": "5.4.0-74-generic",
    "javaMemoryMB": 2048,
    "javaVersion": "11.0.1",
    "javaVendor": "Oracle Corporation",
    "systemTime": 1625529858405,
    "deltaTimeMillis": 790,
    "httpExecuteTimeMillis": 88
  },
  "isError": false
}

JSON Response Example (Error Case):

{
  "isError": true,
  "genericErrorText": "connect timed out",
  "recorderNotReachableError": true,
  "recorderIdError": false,
  "recorderAccessDeniedError": false
}

deleteProxyRecorder

Specific Request Fields:

• recorderId

Response Fields:

• [none]

Specific Error Flags:

• recorderIdError
• recorderAccessDeniedError
• recorderDeleteDeniedError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"deleteProxyRecorder",
  "recorderId":10
}

JSON Response Example (Success Case):

{"isError":false}

getProxyRecordersClientCertificates

Specific Request Fields:

• [none]

Response Fields:

• certificateId (unique ID)
• ownerUserId (always the own user ID)
• recorderId (always -1 = apply for all proxy recorders)
• originalCertFileName (without disk path)
• certFileType (always PKCS#12)
• certFileDataB64 (the file data in base64 format)
• certPassword
• certDescription
• certActive (if false then do not transmit the certificate to the proxy recorders)
• applyForHost
• applyForPort

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"getProxyRecordersClientCertificates"
}

JSON Response Example (Success Case):

{
  "clientCertificatesArray": [
    {
      "certificateId": 1,
      "ownerUserId": 13,
      "recorderId": -1,
      "originalCertFileName": "fischer@dkfqa.com.p12",
      "certFileType": "PKCS#12",
      "certFileDataB64": "MIIRQQ.....CAA=",
      "certPassword": "12345678",
      "certDescription": "Fischer's Cert",
      "certActive": true,
      "applyForHost": "192.168.0.100",
      "applyForPort": 499
    },
    {
      "certificateId": 3,
      "ownerUserId": 13,
      "recorderId": -1,
      "originalCertFileName": "miller@dkfqa.com.p12",
      "certFileType": "PKCS#12",
      "certFileDataB64": "MIIRXB.....CCAA=",
      "certPassword": "abcdefgh",
      "certDescription": "",
      "certActive": false,
      "applyForHost": "www.werwaswo.com",
      "applyForPort": 443
    }
  ],
  "isError": false
}

addProxyRecordersClientCertificate

Specific Request Fields:

• recorderId (always -1 = apply for all proxy recorders)
• certFileName (without disk path)
• certFileType (always PKCS#12)
• certFileDataB64 (the file data in base64 format)
• certPassword
• certDescription (optional, but not null)
• certActive (if false then do not transmit the certificate to the proxy recorders)
• applyForHost
• applyForPort

Response Fields:

• certificateId (the new unique ID)
• ownerUserId (always the own user ID)
• recorderId (always -1 = apply for all proxy recorders)
• originalCertFileName (without disk path)
• certFileType (always PKCS#12)
• certDescription
• certActive
• applyForHost
• applyForPort

Specific Error Flags:

• certDescriptionError
• applyForHostError
• applyForPortError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"addProxyRecordersClientCertificate",
  "recorderId": -1,
  "certFileName": "felix@dkfqa.com.p12",
  "certFileType": "PKCS#12",
  "certFileDataB64": "MIIRQQIBAzCCEQ.....3dUWQICCAA=",
  "certPassword": "mammamia",
  "certDescription":"",
  "certActive": true,
  "applyForHost": "www.dkfqa.com",
  "applyForPort": 443
}

JSON Response Example (Success Case):

{
  "addedClientCertificate": {
    "certificateId": 5,
    "ownerUserId": 13,
    "recorderId": -1,
    "originalCertFileName": "felix@dkfqa.com.p12",
    "certFileType": "PKCS#12",
    "certDescription": "",
    "certActive": true,
    "applyForHost": "www.dkfqa.com",
    "applyForPort": 443
  },
  "isError": false
}

setProxyRecordersClientCertificateActive

Specific Request Fields:

• certificateId
• certActive (if false then do not transmit the certificate to the proxy recorders)

Response Fields:

• certificateId
• ownerUserId (always the own user ID)
• recorderId (always -1 = apply for all proxy recorders)
• originalCertFileName (without disk path)
• certFileType (always PKCS#12)
• certDescription
• certActive
• applyForHost
• applyForPort

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"setProxyRecordersClientCertificateActive",
  "certificateId": 5,
  "certActive": false
}

JSON Response Example (Success Case):

{
  "updatedClientCertificate": {
    "certificateId": 5,
    "ownerUserId": 13,
    "recorderId": -1,
    "originalCertFileName": "felix@dkfqa.com.p12",
    "certFileType": "PKCS#12",
    "certDescription": "",
    "certActive": false,
    "applyForHost": "www.dkfqa.com",
    "applyForPort": 443
  },
  "isError": false
}

modifyProxyRecordersClientCertificate

Specific Request Fields:

• certificateId
• certDescription (optional but not null)
• applyForHost (required)
• applyForPort (required)

Response Fields:

• certificateId
• ownerUserId (always the own user ID)
• recorderId (always -1 = apply for all proxy recorders)
• originalCertFileName (without disk path)
• certFileType (always PKCS#12)
• certDescription
• certActive
• applyForHost
• applyForPort

Specific Error Flags:

• certDescriptionError
• applyForHostError
• applyForPortError

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"modifyProxyRecordersClientCertificate",
  "certificateId": 5,
  "certDescription": "My Cert",
  "applyForHost": "www.dkfqa.com",
  "applyForPort": 444
}

JSON Response Example (Success Case):

{
  "updatedClientCertificate": {
    "certificateId": 5,
    "ownerUserId": 13,
    "recorderId": -1,
    "originalCertFileName": "felix@dkfqa.com.p12",
    "certFileType": "PKCS#12",
    "certDescription": "My Cert",
    "certActive": false,
    "applyForHost": "www.dkfqa.com",
    "applyForPort": 444
  },
  "isError": false
}

deleteProxyRecordersClientCertificate

Specific Request Fields:

• certificateId

Response Fields:

• [none]

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"deleteProxyRecordersClientCertificate",
  "certificateId": 5
}

JSON Response Example (Success Case):

{"isError": false}

JSON Response Example (Error Case):

{"isError": true, "genericErrorText": "Invalid certificate Id"}

getTestjobTemplates

Specific Request Fields:

• [none]

Response Fields:

• testjobTemplatesArray

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"getTestjobTemplates"
}

JSON Response Example (Success Case):

{
  "testjobTemplatesArray": [
    {
      "testjobTemplate": {
        "templateId": 10,
        "templateName": "SimpleTest 1VU",
        "templateDescription": "",
        "testjobProperties": {
          "testjobResultFileName": "",
          "executeMeasuringAgentClusterInfo": "",
          "testjobConcurrentUsers": "1",
          "testjobDescription": "SimpleTest",
          "testjobDebugMeasuring": "false",
          "testjobMaxTestDuration": "30",
          "isClusterJob": "",
          "testjobRampUpTime": "10",
          "localTestjobId": "",
          "testjobMaxLoopsPerUser": "1",
          "productVersion": "4.8.23",
          "remoteTestjobId": "",
          "testjobAdditionalArguments": "",
          "definedFromTestId": "384",
          "testjobSignature": "",
          "testjobDelayPerLoop": "1000",
          "testjobExitCode": "",
          "createTimeStamp": "1694549684261",
          "userInputFieldsFileName": "",
          "testjobType": "load test",
          "enableAutomaticFileSync": "true",
          "testjobState": "invalid",
          "isClusterControllerJobProperties": "",
          "testjobDebugExecution": "false",
          "executeOnUserMeasuringAgentId": "",
          "definedFromTimeZoneId": "Europe/Berlin",
          "executeMeasuringAgentInfo": "",
          "executeOnMeasuringAgentClusterId": ""
        },
        "hasUserInputFields": false
      },
      "testIsHealthy": true
    },
    {
      "testjobTemplate": {
        "templateId": 11,
        "templateName": "SimpleTestWithInputFields 10VU",
        "templateDescription": "",
        "testjobProperties": {
          "testjobResultFileName": "",
          "executeMeasuringAgentClusterInfo": "",
          "testjobConcurrentUsers": "10",
          "testjobDescription": "SimpleTestWithInputFields",
          "testjobDebugMeasuring": "false",
          "testjobMaxTestDuration": "60",
          "isClusterJob": "",
          "testjobRampUpTime": "10",
          "localTestjobId": "",
          "testjobMaxLoopsPerUser": "5",
          "productVersion": "4.8.23",
          "remoteTestjobId": "",
          "testjobAdditionalArguments": "",
          "definedFromTestId": "385",
          "testjobSignature": "",
          "testjobDelayPerLoop": "1000",
          "testjobExitCode": "",
          "createTimeStamp": "1695047319785",
          "userInputFieldsFileName": "InputFields_SimpleTestWithInputFields.json",
          "testjobType": "load test",
          "enableAutomaticFileSync": "true",
          "testjobState": "invalid",
          "isClusterControllerJobProperties": "",
          "testjobDebugExecution": "true",
          "executeOnUserMeasuringAgentId": "",
          "definedFromTimeZoneId": "Europe/Berlin",
          "executeMeasuringAgentInfo": "",
          "executeOnMeasuringAgentClusterId": ""
        },
        "hasUserInputFields": true,
        "userInputFieldsFile": {
          "useShortNames": false,
          "magicPattern": "UserInputFields",
          "productVersion": "4.8.23",
          "userInputFieldsArray": [
            {
              "useShortNames": false,
              "productVersion": "4.8.23",
              "label": "Input Host",
              "variableName": "vHost",
              "inputType": "string",
              "defaultValue": "126.3.4.5",
              "currentValue": "126.3.4.5"
            },
            {
              "useShortNames": false,
              "productVersion": "4.8.23",
              "label": "Input Port",
              "variableName": "vPort",
              "inputType": "integer",
              "defaultValue": "444",
              "currentValue": "444"
            }
          ]
        }
      },
      "testIsHealthy": true
    }
  ],
  "isError": false
}

defineNewTestjobFromTemplate

Specific Request Fields:

• templateId
• measuringAgentOrClusterId
• isCluster (boolean)
• jobDescription

Response Fields:

• newTestjobId

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"defineNewTestjobFromTemplate",
  "templateId":10,
  "measuringAgentOrClusterId":65,
  "isCluster":false,
  "jobDescription": "Simple Test"
}

JSON Response Example (Success Case):

{ 
  "newTestjobId":33533,
  "isError":false
}

submitTestjob

Specific Request Fields:

• localTestjobId

Response Fields:

• agentResponse (for measuring agents), or
• controllerResponse (for cluster controllers)

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"submitTestjob",
  "localTestjobId":33534
}

JSON Response Example (Success Case):

{
  "isClusterJob": false,
  "agentResponse": {
    "remoteTestjobId": 24129,
    "httpExecuteTimeMillis": 338
  },
  "isError": false
}

makeTestjobReadyToRun

Specific Request Fields:

• localTestjobId

Response Fields:

• agentResponse (for measuring agents), or
• controllerResponse (for cluster controllers)

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"makeTestjobReadyToRun",
  "localTestjobId":33534
}

JSON Response Example (Success Case):

{
  "isClusterJob": false,
  "agentResponse": {
    "testjobProperties": {
      "testjobResultFileName": "",
      "executeMeasuringAgentClusterInfo": "",
      "testjobConcurrentUsers": "1",
      "testjobDescription": "Simple Test",
      "testjobDebugMeasuring": "false",
      "testjobMaxTestDuration": "30",
      "isClusterJob": "false",
      "testjobRampUpTime": "10",
      "localTestjobId": "33534",
      "testjobMaxLoopsPerUser": "1",
      "productVersion": "4.8.18",
      "remoteTestjobId": "24129",
      "testjobAdditionalArguments": "",
      "definedFromTestId": "384",
      "testjobSignature": "Z9B963yIj232nht1DIX5aSRt8m77QuXpvVA5736Tl9Wc7UZ7jOiU3l6UC7y3Nx6CXDDZB4qUg4FHDtTuHsD9xd0T/CSq/g==",
      "testjobDelayPerLoop": "1000",
      "testjobExitCode": "",
      "createTimeStamp": "1695050460395",
      "userInputFieldsFileName": "",
      "testjobType": "load test",
      "enableAutomaticFileSync": "true",
      "testjobState": "ready to run",
      "isClusterControllerJobProperties": "",
      "testjobDebugExecution": "false",
      "executeOnUserMeasuringAgentId": "65",
      "definedFromTimeZoneId": "Europe/Berlin",
      "executeMeasuringAgentInfo": "agent2.realload.com:8080",
      "executeOnMeasuringAgentClusterId": ""
    },
    "httpExecuteTimeMillis": 2871
  },
  "isError": false
}

startTestjob

Specific Request Fields:

• localTestjobId

Response Fields:

• agentResponse (for measuring agents), or
• controllerResponse (for cluster controllers)

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"startTestjob",
  "localTestjobId":33534
}

JSON Response Example (Success Case):

{
  "isClusterJob": false,
  "agentResponse": {
    "testjobProperties": {
      "testjobResultFileName": "",
      "executeMeasuringAgentClusterInfo": "",
      "testjobConcurrentUsers": "1",
      "testjobDescription": "Simple Test",
      "testjobDebugMeasuring": "false",
      "testjobMaxTestDuration": "30",
      "isClusterJob": "false",
      "testjobRampUpTime": "10",
      "localTestjobId": "33534",
      "testjobMaxLoopsPerUser": "1",
      "productVersion": "4.8.18",
      "remoteTestjobId": "24129",
      "testjobAdditionalArguments": "",
      "definedFromTestId": "384",
      "testjobSignature": "Z9B963yIj232nht1DIX5aSRt8m77QuXpvVA5736Tl9Wc7UZ7jOiU3l6UC7y3Nx6CXDDZB4qUg4FHDtTuHsD9xd0T/CSq/g==",
      "testjobDelayPerLoop": "1000",
      "testjobExitCode": "",
      "createTimeStamp": "1695050460395",
      "userInputFieldsFileName": "",
      "testjobType": "load test",
      "enableAutomaticFileSync": "true",
      "testjobState": "running",
      "isClusterControllerJobProperties": "",
      "testjobDebugExecution": "false",
      "executeOnUserMeasuringAgentId": "65",
      "definedFromTimeZoneId": "Europe/Berlin",
      "executeMeasuringAgentInfo": "agent2.realload.com:8080",
      "executeOnMeasuringAgentClusterId": ""
    },
    "httpExecuteTimeMillis": 249
  },
  "isError": false
}

getMeasuringAgentTestjobs

Specific Request Fields:

• measuringAgentId
• synchronizeLocalTestjobsState (boolean)

Response Fields:

• agentResponse

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"getMeasuringAgentTestjobs",
  "measuringAgentId":65,
  "synchronizeLocalTestjobsState":true
}

JSON Response Example (Success Case):

{
  "agentResponse": {
    "allTestjobsArray": [
      {
        "testjobProperties": {
          "testjobResultFileName": "TestResult_RealloadTest_2023-09-09@23-45-34.json",
          "executeMeasuringAgentClusterInfo": "",
          "testjobConcurrentUsers": "1",
          "testjobDescription": "RealloadTest",
          "testjobDebugMeasuring": "false",
          "testjobMaxTestDuration": "60",
          "isClusterJob": "false",
          "testjobRampUpTime": "10",
          "localTestjobId": "30717",
          "testjobMaxLoopsPerUser": "1",
          "productVersion": "4.8.18",
          "remoteTestjobId": "15240",
          "testjobAdditionalArguments": "",
          "definedFromTestId": "379",
          "testjobSignature": "NeYJG4vf8/joAwz4nR4Fie3W0Qr7ijps25ONuk6F5BLghuD8/clPL9mBKc/ogQiic7wI8OXOf53Mi4YDCpg4dQzuaWQ==",
          "testjobDelayPerLoop": "1000",
          "testjobExitCode": "0",
          "createTimeStamp": "1694295923799",
          "userInputFieldsFileName": "",
          "testjobType": "load test",
          "enableAutomaticFileSync": "true",
          "testjobState": "completed",
          "isClusterControllerJobProperties": "",
          "testjobDebugExecution": "true",
          "executeOnUserMeasuringAgentId": "65",
          "definedFromTimeZoneId": "Europe/Berlin",
          "executeMeasuringAgentInfo": "agent2.realload.com:8080",
          "executeOnMeasuringAgentClusterId": ""
        },
        "testProperties": {
          "referencedResourceFilesList": [
            {
              "projectId": 130,
              "testplanId": 203,
              "fileName": "com.dkfqs.selenium.jar"
            },
            {
              "projectId": 130,
              "testplanId": 203,
              "fileName": "commons-io-2.13.0.jar"
            },
            {
              "projectId": 130,
              "testplanId": 203,
              "fileName": "hamcrest-core-1.3.jar"
            },
            {
              "projectId": 130,
              "testplanId": 203,
              "fileName": "com.dkfqs.tools.jar"
            },
            {
              "projectId": 130,
              "testplanId": 203,
              "fileName": "junit-4.13.2.jar"
            },
            {
              "projectId": 130,
              "testplanId": 203,
              "fileName": "selenium_bundle-4.12.1.jar"
            }
          ],
          "jsonConfigObject": {
            "productVersion": "4.8.20",
            "jUnitConfigExecutionClassArray": [
              {
                "productVersion": "4.8.20",
                "executingClassName": "RealloadTest",
                "testMethodNamesArray": [
                  "realload"
                ]
              }
            ],
            "seleniumWebBrowserType": "Firefox"
          },
          "executingScript": "RealloadTest.jar",
          "executingScriptResourceFileList": "",
          "createTimeStamp": "1694293491984",
          "testDescription": "",
          "definedFromTestplanId": "251",
          "productVersion": "4.8.20",
          "definedFromProjectId": "137",
          "visibleTestName": "RealloadTest",
          "scriptType": "Selenium4byJUnit4",
          "testId": "379"
        }
      },
      {
        "testjobProperties": {
          "testjobResultFileName": "TestResult_SimpleTest_2023-09-18@17-01-08.json",
          "executeMeasuringAgentClusterInfo": "",
          "testjobConcurrentUsers": "1",
          "testjobDescription": "Simple Test",
          "testjobDebugMeasuring": "false",
          "testjobMaxTestDuration": "30",
          "isClusterJob": "false",
          "testjobRampUpTime": "10",
          "localTestjobId": "33533",
          "testjobMaxLoopsPerUser": "1",
          "productVersion": "4.8.18",
          "remoteTestjobId": "24112",
          "testjobAdditionalArguments": "",
          "definedFromTestId": "384",
          "testjobSignature": "JYstx+myVNqbyVMr24u4Pi8IXkLGH0iXUquRh5+NL0veKs4DRJX/w2ZT77wLXF70J9YmTPzR7g==",
          "testjobDelayPerLoop": "1000",
          "testjobExitCode": "0",
          "createTimeStamp": "1695049264730",
          "userInputFieldsFileName": "",
          "testjobType": "load test",
          "enableAutomaticFileSync": "true",
          "testjobState": "completed",
          "isClusterControllerJobProperties": "",
          "testjobDebugExecution": "false",
          "executeOnUserMeasuringAgentId": "65",
          "definedFromTimeZoneId": "Europe/Berlin",
          "executeMeasuringAgentInfo": "agent2.realload.com:8080",
          "executeOnMeasuringAgentClusterId": ""
        },
        "testProperties": {
          "referencedResourceFilesList": [
            {
              "projectId": 130,
              "testplanId": 203,
              "fileName": "com.dkfqs.tools.jar"
            }
          ],
          "jsonConfigObject": {},
          "executingScript": "SimpleTest.jar",
          "executingScriptResourceFileList": "",
          "createTimeStamp": "1694549112155",
          "testDescription": "",
          "definedFromTestplanId": "251",
          "productVersion": "4.8.21",
          "definedFromProjectId": "137",
          "visibleTestName": "SimpleTest",
          "scriptType": "OpenJDK11Jar",
          "testId": "384"
        }
      },
      {
        "testjobProperties": {
          "testjobResultFileName": "TestResult_SimpleTest_2023-09-18@17-51-53.json",
          "executeMeasuringAgentClusterInfo": "",
          "testjobConcurrentUsers": "1",
          "testjobDescription": "Simple Test",
          "testjobDebugMeasuring": "false",
          "testjobMaxTestDuration": "30",
          "isClusterJob": "false",
          "testjobRampUpTime": "10",
          "localTestjobId": "33534",
          "testjobMaxLoopsPerUser": "1",
          "productVersion": "4.8.18",
          "remoteTestjobId": "24129",
          "testjobAdditionalArguments": "",
          "definedFromTestId": "384",
          "testjobSignature": "Z9B963yIj232nht1DIX5aSRt8m77QuXYjP9rn4OBSq/g==",
          "testjobDelayPerLoop": "1000",
          "testjobExitCode": "0",
          "createTimeStamp": "1695050460395",
          "userInputFieldsFileName": "",
          "testjobType": "load test",
          "enableAutomaticFileSync": "true",
          "testjobState": "completed",
          "isClusterControllerJobProperties": "",
          "testjobDebugExecution": "false",
          "executeOnUserMeasuringAgentId": "65",
          "definedFromTimeZoneId": "Europe/Berlin",
          "executeMeasuringAgentInfo": "agent2.realload.com:8080",
          "executeOnMeasuringAgentClusterId": ""
        },
        "testProperties": {
          "referencedResourceFilesList": [
            {
              "projectId": 130,
              "testplanId": 203,
              "fileName": "com.dkfqs.tools.jar"
            }
          ],
          "jsonConfigObject": {},
          "executingScript": "SimpleTest.jar",
          "executingScriptResourceFileList": "",
          "createTimeStamp": "1694549112155",
          "testDescription": "",
          "definedFromTestplanId": "251",
          "productVersion": "4.8.21",
          "definedFromProjectId": "137",
          "visibleTestName": "SimpleTest",
          "scriptType": "OpenJDK11Jar",
          "testId": "384"
        }
      }
    ],
    "httpExecuteTimeMillis": 141
  },
  "isError": false
}