Documentation

• 1: Getting started
• 1.1: Deployment types
• 1.2: Portal Sign Up and Login
• 1.3: Create a simple REST GET test
• 2: Overview
• 3: Release Notes
• 4: All Purpose Interface
• 5: API
• 5.1: Remote Admin API
• 5.2: Remote User API
• 5.3: Remote User Monitoring API
• 6: Installation
• 6.1: Ubuntu 16/18/20 Measuring Agent manual install
• 6.2: Ubuntu 16/18/20 Cluster Controller manual install
• 6.3: Ubuntu 16/18/20 Portal Server manual install
• 6.4: Ubuntu 16/18/20 Remote Proxy Recorder manual install
• 6.5: Centos 8 Portal Server manual install
• 7: User Guide
• 7.1: AWS Measuring Agents
• 7.2: HTTP Test Wizard
• 7.3: HTTP/S Remote Proxy Recorder
• 8: Browser Recorder extensions for both Chrome and Firefox
• 9: Desktop Companion User Guide
• 9.1: Release Notes
• 9.2: Desktop Companion - Pre-requisites
• 9.3: Desktop Companion - Download and run
• 9.4: Desktop Companion - Settings Menu
• 9.5: Desktop Companion - File Menu
• 9.6: Desktop Companion - Editor
• 9.7: Desktop Companion - Measuring Agents
• 9.8: Desktop Companion - Proxy Recorder
• 10: Synthetic Monitoring
• 11: Table Server

1 - Getting started

This section of the documentation will walk you through the first steps in order to getting started with the Real Load product.

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

Please to 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.

1.1 - Deployment types

First of all you’ll have to decide which Real Load deployment type better suits your needs. These guidlines might assist you in making an informed decision.

If your intent is to first evaluate the product we strongly suggest to chose the “quick evaluation” option.

Architecture

There are two key components that make up the Real Load application:

The Portal Server

• Exposes the main GUI to end users.
• All tasks to prepare test scripts are performed from here.
• Used to trigger test executions and visualize results.

Measuring Agents

• Load test scripts are triggered from agents.
• More than one agent can be deployed.
• The agent needs to be reachable from the portal server and needs to be able to reach the servers to be load tested.

Depending on your network topology, the location of the Measuring Agent (externally exposed or not) will be the main factor dictating whether you can use our SaaS solution (cloud hosted) or you’ll have to proceed with an on-premises deployment.

The following diagram summarizes the architecture:

Quick evaluation

If you’d just like to perform an initial evaluation the Real Load product your best option would be to use our SaaS offering. Simply create yourself an account in our cloud based portal and once you’re setup you’ll be able to prepare a load testing script and perform a low-volume test against an intenet exposed server.

Requirements / Constraints

• Perform a functional evaluation without having to deploy any software on-premises.
• Do not want to incure any cloud related (AWS / Azure) costs.

Infrastructure Requirements

• The website you want to run the load test against need to be publicly reachable.

SaaS offering (all cloud based)

If all the servers you’re planning to run your load test against are cloud hosted (AWS, Azure, etc…) you might be able to use our existing AWZ or Azure agent image as load test generators, controlled by our cloud based portal.

Requirements / Constraints

• The website you want to run the load test is hosted in the cloud but doesn’t need to be publicly reachable. It needs to be reachable from a cloud deployed Real Load agent.
• You’ll have to start a Real Load agent instance (Virtual Machine) under your own cloud account.

Infrastructure Requirements

• You’ll have to run some instances of our agent AWS or Azure images under your own cloud account. A suitable AWS or Azure subscription will be required. This machine needs to be assigned a public IP address so that it is reachable from our Portal Server.

Hybrid offering (controller on-premises, agents cloud or on-premises based)

If at least some of the servers you’re planning to run your load test against are hosted within an internal network that is not externally reachable and exposing the real-load agents to the internet is not an option, you’ll have to deploy the Real Load portal on-premises, so that both internal and external (if any agent) Real Load agents are reachable.

Requirements / Constraints

• At least some of the servers you want to load test are not exposed externally.
• Exposing the Real Load agent externally is not an option.

Infrastructure Requirements

• You’ll have to deploy the Real Load portal internally on a supported operating system.
• You’ll have to deploy the Real Load agent(s) internally on a supported operating system.
• If required, you might have to run some instances of our agent AWS or Azure images under your own cloud account. A suitable AWS or Azure subscription will be required.

On-premises offering

Obviously you can run all of your Real Load infrastructure internally. The Real Load software doesn’t require any connecivity to external systeems in this deployment scneario. This scenario is very similar to the last scenario…

Requirements / Constraints

• At least some of the servers you want to load test are not exposed externally.
• Exposing the Real Loaf agent externally is not an option.

Infrastructure Requirements

• You’ll have to deploy the Real Load portal internally on a supported operating system.
• You’ll have to deploy the Real Load agent(s) internally on a supported operating system.

1.2 - Portal Sign Up and Login

If you already have an account, you can login at this link:

https://portal.realload.com

Signing Up

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.

Sign Up Process

When sign up, you will get 20 free Cloud Credits, which can be used to start Measuring Agents (= load generators) directly from the portal server.

This is a brief description of the information required to sing up to the Real Load portal.

Step 1

Provide your details, including email and mobile number.

Step 2

Validate your email address.

Step 3

Validate your mobile number

Step 4

Configure your nickname and password

Step 5

Once you signed up, you will be automatically loggedIn, and you can take a tour on our user guide. Two shared Measuring Agents are now assigned to your user account. Also 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.

Step 6

Once you had quick tour on our user guide, you can set up your test scripts here, either by recording the browser or mobile traffic by the HTTP/S Remote Proxy Recorder or set up API test scripts directly from the HTTP Test Wizard.

Setting Up Measuring Agents

In order to debug and execute a load test, you’ll need at least a Measuring Agent (= load generator).

There are 3 ways to set up Measuring Agents:

1. If you have Cloud Credits (20 free CC already credited at sign up), you can easily launch cloud-based Measuring Agents directly from the portal server. Additional Cloud Credits can be purchased at the Real Load Store.
2. You can launch cloud-based Measuring Agents with the Desktop Companion (locally installable Windows program) under your own AWS account, whereby you can use pre-built AWS EC2 AMIs.
3. You can also download the Measuring Agent software and install it on your own servers. After that you can register your Measuring Agent(s) at the portal server.

Option 2 and 3 do not require any Cloud Credits.

Video: Define and run a simple test with a Measurement Agent instance launched by Cloud Credits.

1.3 - Create a simple REST GET test

Pre-requisites

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

• Access to the Real Load portal. If you haven’t signed up, do so first: Sign Up)
• A REST API URL you can test with a GET request. You can otherwise use the REST API mentioned in the description
• Approx. 20 minutes of your time
• A cup of tea or coffee

Prepare the project

• Create a new project called “Simple REST test” (… or something that makes sense to you)
• Click on the create project icon (pointed at by the green arrow) and then enter a suitable name for the project.

Then define a new resource set in the freshly created project. I’ll call this “GET tests”, but again feel free to chose any name that makes sense to you.

Create the test script using the HTTP test wizard

Now we’ll create the test script with the help of the HTTP test wizard.

Enter a name for the test script and click on OK.

Then click on “Add” and select “URL” from the menu. This is to add a new URL request to the test script.

Enter the URL of the REST API endpoint, for example https://www.realload.com/RealLoadListImagesWS/rest/AWSImages

• In the “Verify HTTP Response” section add some validation assertions. In this case I configure response code HTTP 200 and in the response body the string “ap-southeast-2” should appear.
• Then click on “Add URL”.

Debug your test

You can now test with the debugger that your test does what it is supposed to do.

Click on “Debug Session”:

Then click on Next Step to execute the REST request. Note the update in the area highlighted in red.

You can inspect the response header and body by clicking on the icons pointed at by the arrows:

The response content (body) will appear in the debugger. If all looks good, close the window.

Save and compile the test

The last step is to save the test and the execute it. First exit from the debugger window:

.. then save the session using a suitable name. Also select the resource group the test should be saved to.

Now generate the Java code that will contain your test logic which will be executed on the Measuring Agent. Click on “Generate Code”:

Then click on “Generate Source Code” and “Compile & Generate Jar”.

Now that the test code is compiled, you can define a new test that by clicking on “Define New Test”.

You’ll have to give a name to this test job, enter something meaningful to you:

Execute the test job

You’re now ready to execute the test. Click on the test you’ve just defined to create a new test job:

… select “continue”…

… select the agent to run the test job from.

You’re now ready to start the test. Click on “Test jobs” then click on “Start Test Job”:

.. select the number of Virtual Users to simulate, duration of the test and think time between test loops:

Monitor the test job

Once the test job is running click on the “Monitor Jobs” menu item:

… and you’ll be able to see measurement related to your test job:

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

To learn more we suggest heading to the User Guide section where you’ll find detailed documentation in relation to the steps outlined in this document.

2 - Overview

What is Real Load?

Real Load is an Enterprise tool to perform next generation Load Testing and Synthetic Monitoring.

At the core of the Real Load product is a universal measurement interface that supports to capture data of performance tests which can run against anything that has a response time. The product is highly scalable and can be used to run tests from a few hundred simulated users up to an almost unlimited load with millions of concurrent users.

In addition, It can be used for periodically tests your critical use cases for proactive monitoring .

The executed tests can be either generated automatically by using the wizards, or alternatively programmed by hand, with all libraries and interfaces being fully documented in detail.

Regardless of what type of test you are running, all data reported to the universal interface during a test are displayed directly in real time in form of statistics and charts. Results from load releasing clusters are even displayed in real time by combining the cluster members data on the fly.

Real Load itself is written in Java - but can execute tests written in any programming language, since the universal measurement interface is file-based and supports any programming language that is capable to write data into a file.

3 - Release Notes

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 - All Purpose Interface

Abstract

This document explains:

1. How to develop a test program from scratch.
2. How to add self-programmed measurements to the HTTP Test Wizard (as plug-ins).

The product’s open architecture enables you to develop plug-ins, scripts and programs that measure anything that has numeric value - no matter which protocol is used!

The measured data are evaluated in real time and displayed as diagrams and lists. In addition to successfully measured values, also errors like timeouts or invalid response data can be collected and displayed in real time.

At least in theory, programs and scripts of any programming language can be executed, as long as such a program or script supports the All Purpose Interface.

In practice there are currently two options for integrating your own measurements into the Real Load Platform:

1. Write an HTTP Test Wizard Plug-In in Java that performs the measurement. This has the advantage that you only have to implement a subset of the “All Purpose Interface” yourself:

   • Declare Statistic
   • Register Sample Start
   • Add Sample Long
   • Add Sample Error
   • [Optional: Add Counter Long, Add Average Delta And Current Value, Add Efficiency Ratio Delta, Add Throughput Delta, Add Test Result Annotation Exec Event]

   Such plug-ins can be developed quite quickly, as all other functions of the “All Purpose Interface” are already implemented by the HTTP Test Wizard.

   Tip: An HTTP Test Wizard session can also only consist of plug-ins, i.e. you can “misuse” the HTTP Test Wizard to only carry out measurements that you have programmed yourself: Plug-In Example

2. Write a test program or from scratch. This can currently be programmed in Java or PowerShell (support for additional programming languages will be added in the future). This is more time-consuming, but has the advantage that you have more freedom in program development. In this case you have to implement all functions of the “All Purpose Interface”.

Interface Specification

Basic Requirements for all Programs and Scripts

The All Purpose Interface must be implemented by all programs and scripts which are executed on the Real Load Platform. The interface is independent of any programming language and has only three requirements:

1. The executed program or script must be able to be started from a command line, and passing program or script arguments must be supported.
2. The executed program or script must be able to read and write files.
3. The executed program or script must be able to measure one or more numerical values.

All of this seems a bit trivial, but has been chosen deliberately. So that the interface can support almost all programming languages.

Generic Program and Script Arguments

Each executed program or script must support at least the following arguments:

• Number of Users: The total number of simulated users (integer value > 0).
• Test Duration: The maximum test duration in seconds (integer value > 0).
• Ramp Up Time: The ramp up time in seconds until all simulated users are started (integer value >= 0). Example: If 10 users are started within 5 seconds then the first user is started immediately and then the remaining 9 users are started in (5 seconds / 9 users) = 0.55 seconds intervals.
• Max Session Loops: The maximum number of session loops per simulated user (integer value > 0, or -1 means infinite number of session loops).
• Delay Per Session Loop: The delay in milliseconds before a simulated user starts a next session loop iteration (integer value >= 0) – but not applied for the first session loop iteration.
• Data Output Directory: The directory to which the measured data have to be written. In addition, other data can also written to this directory like for example debug information.

Implementation Note: The test ends if either the Test Duration is elapsed or if Max Session Loops are reached for all simulated users. Currently executed sessions are not aborted.

In addition, the following arguments are optional, but also standardized:

• Description: A brief description of the test
• Debug Execution: Write debug information about the test execution to stdout
• Debug Measuring: Write debug information about the declared statistics and the measured values to stdout

Single-Threaded Scripts vs. Multiple-Threaded Programs

For scripts which don’t support multiple threads the Real Load Platform starts for each simulated user a own operating system process per simulated user. On the other hand, for programs which support multiple threads, only one operating system process is started for all simulated users.

Scripts which are not able to run multiple threads must support the following additional generic command line argument:

• Executed User Number: The currently executed user (integer value > 0). Example: If 10 scripts are started then 1 is passed to the first started script, 2 is passed to the second started script, .. et cetera.

Specific Program and Script Arguments

Additional program and script specific arguments are supported by the Real Load Platform. Hoverer, their values are not validated by the platform.

Job Control Files

During the execution of a test the Real Load Platform can create and delete at runtime additional control files in the Data Output Directory of a test job. The existence, and respectively the absence of such control files must be frequently checked by the running script or program, but not too often to avoid CPU and I/O overload. Rule of thumb: Multi-threaded programs should check the existence of such files every 5..10 seconds. Single-threaded scripts should check such files before executing a new session loop iteration.

The following control files are created or removed in the Data Output Directory by the Real Load Platform:

• DKFQS_Action_AbortTest.txt If the existence of this file is detected then the test executions must be aborted gracefully as soon as possible. Currently executed session loops are not aborted.
• DKFQS_Action_SuspendTest.txt If the existence of this file is detected then the further execution of session loops is suspended until the file is removed by the Real Load Platform. Currently executed session loops are not interrupted on suspend. When resuming the test then the Ramp Up Time as passed as generic argument to the script or program must be re-applied. If a suspended test runs out of Test Duration then the test must end.

Testjob Data Files

When a test job is started by the Real Load Platform on a Measuring Agent, then the Real Load Platform creates at first for each simulated user an empty data file in the Data Output Directory of the test job:

Data File: user_<Executed User Number>_statistics.out

Example: user_1_statistics.out, user_2_statistics.out, user_3_statistics.out, .. et cetera.

After that, the test script(s) or test program is started as operating system process. The test script or the test program has to write the current state of the simulated user and measured data to the corresponding Data File of the simulated user in JSON object format (append data to the file only – don’t create new files).

The Real Load Platform component Measuring Agent and the corresponding Data Collector are listening to these data files and interpret the measured data at real-time, line by line as JSON objects.

Writing JSON Objects to the Data Files

The following JSON Objects can be written to the Data Files:

Note that the data of each JSON object must be written as a single line which end with a \r\n line terminator.

Program Sequence

JSON Object Specification

Declare Statistic Object

Before the measurement of data begins, the corresponding statistics must be declared at runtime. Each declared statistic must have a unique ID. Multiple declarations with the same ID are crossed out by the platform.

Currently 5 types of statistics are supported:

• sample-event-time-chart : This is the most common statistic type and contains continuously measured response times or any other continuously measured values of any unit. Information about failed measurements can also be added to the statistic. Statistics of this type are added to the ‘Overview Statistic’ area and can also displayed as a chart (see picture below).
• cumulative-counter-long : This is a single counter whose value is continuously increased during the test. Statistics of this type are added to the ‘Test-Specific Values’ area.
• average-and-current-value : This is a separately measured mean value and the last measured current value. Statistics of this type are added to the ‘Test-Specific Values’ area.
• efficiency-ratio-percent : This is a measured efficiency in percent (0..100%). Statistics of this type are added to the ‘Test-Specific Values’ area.
• throughput-time-chart : This is a measured throughput per second. Statistics of this type are added to the ‘Test-Specific Values’ area.

It’s also supported to declare new statistics at any time during test execution, but the statistics must be declared first, before the measured data are added.

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "DeclareStatistic",
  "type": "object",
  "required": ["subject", "statistic-id", "statistic-type", "statistic-title"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'declare-statistic'"
    },
    "statistic-id": {
      "type": "integer",
      "description": "Unique statistic id"
    },
    "statistic-type": {
      "type": "string",
      "description": "'sample-event-time-chart' or 'cumulative-counter-long' or 'average-and-current-value' or 'efficiency-ratio-percent' or 'throughput-time-chart'"
    },
    "statistic-title": {
      "type": "string",
      "description": "Statistic title"
    },
    "statistic-subtitle": {
      "type": "string",
      "description": "Statistic subtitle | only supported by 'sample-event-time-chart'"
    },
    "y-axis-title": {
      "type": "string",
      "description": "Y-Axis title | only supported by 'sample-event-time-chart'. Example: 'Response Time'"
    },
    "unit-text": {
      "type": "string",
      "description": "Text of measured unit. Example: 'ms'"
    },
    "sort-position": {
      "type": "integer",
      "description": "The UI sort position"
    },
    "add-to-summary-statistic": {
      "type": "boolean",
      "description": "If true = add the number of measured and failed samples to the summary statistic | only supported by 'sample-event-time-chart'. Note: Synthetic measured data like Measurement Groups or Delay Times should not be added to the summary statistic"
    },
    "background-color": {
      "type": "string",
      "description": "The background color either as #hex-triplet or as bootstrap css class name, or an empty string = no special background color. Examples: '#cad9fa', 'table-info'"
    }
  }
}

Example: 
{
  "subject":"declare-statistic",
  "statistic-id":1,
  "statistictype":"sample-event-time-chart",
  "statistic-title":"GET http://192.168.0.111/",
  "statistic-subtitle":"",
  "y-axis-title":"Response Time",
  "unit-text":"ms",
  "sort-position":1,
  "add-to-summarystatistic":true,
  "background-color":""
}

After the statistics are declared then the activities of the simulated users can be started. Each simulated user must report the following changes of the current user-state:

• register-execute-start : Register that the simulated user has started the test.
• register-execute-suspend : Register that the simulated user suspend the execution of the test.
• register-execute-resume : Register that the simulated user resume the execution of the test.
• register-execute-end : Register that the simulated user has ended the test.

Register Execute Start Object

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "RegisterExecuteStart",
  "type": "object",
  "required": ["subject", "timestamp"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'register-execute-start'"
    },
    "timestamp": {
      "type": "integer",
      "description": "Unix-like time stamp"
    }
  }
}

Example: 
{"subject":"register-execute-start","timestamp":1596219816129}

Register Execute Suspend Object

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "RegisterExecuteSuspend",
  "type": "object",
  "required": ["subject", "timestamp"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'register-execute-suspend'"
    },
    "timestamp": {
      "type": "integer",
      "description": "Unix-like time stamp"
    }
  }
}

Example: 
{"subject":"register-execute-suspend","timestamp":1596219816129}

Register Execute Resume Object

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "RegisterExecuteResume",
  "type": "object",
  "required": ["subject", "timestamp"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'register-execute-resume'"
    },
    "timestamp": {
      "type": "integer",
      "description": "Unix-like time stamp"
    }
  }
}

Example: 
{"subject":"register-execute-resume","timestamp":1596219816129}

Register Execute End Object

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "RegisterExecuteEnd",
  "type": "object",
  "required": ["subject", "timestamp"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'register-execute-end'"
    },
    "timestamp": {
      "type": "integer",
      "description": "Unix-like time stamp"
    }
  }
}

Example: 
{"subject":"register-execute-end","timestamp":1596219816129}

Once a simulated user has started its activity it measures the data in so called ‘session loops’. Each simulated must report when a session loop iteration starts and ends:

• register-loop-start : Register the start of a session loop iteration.
• register-loop-passed : Register that a session loop iteration has passed / at end of the session loop iteration.
• register-loop-failed : Register that a session loop iteration has failed / if the session loop iteration is aborted.

Register Loop Start Object

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "RegisterLoopStart",
  "type": "object",
  "required": ["subject", "timestamp"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'register-loop-start'"
    },
    "timestamp": {
      "type": "integer",
      "description": "Unix-like time stamp"
    }
  }
}

Example: 
{"subject":"register-loop-start","timestamp":1596219816129}

Register Loop Passed Object

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "RegisterLoopPassed",
  "type": "object",
  "required": ["subject", "loop-time", "timestamp"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'register-loop-passed'"
    },
    "loop-time": {
      "type": "integer",
      "description": "The time it takes to execute the loop in milliseconds"
    },
    "timestamp": {
      "type": "integer",
      "description": "Unix-like time stamp"
    }
  }
}

Example: 
{"subject":"register-loop-passed","loop-time":1451, "timestamp":1596219816129}

Register Loop Failed Object

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "RegisterLoopFailed",
  "type": "object",
  "required": ["subject", "timestamp"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'register-loop-failed'"
    },
    "timestamp": {
      "type": "integer",
      "description": "Unix-like time stamp"
    }
  }
}

Example: 
{"subject":"register-loop-failed","timestamp":1596219816129}

Within a session loop iteration the samples of the declared statistics are measured. For sample-event-time-chart statistics the simulated user must report when the measuring of a sample starts and ends:

• register-sample-start : Register that the measuring of a sample has started.
• add-sample-long : Add a measured value to a declared statistic.
• add-sample-error : Add an error to a declared statistic.

Register Sample Start Object (sample-event-time-chart only)

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "RegisterSampleStart",
  "type": "object",
  "required": ["subject", "statistic-id", "timestamp"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'register-sample-start'"
    },
    "statistic-id": {
      "type": "integer",
      "description": "The unique statistic id"
    },
    "timestamp": {
      "type": "integer",
      "description": "Unix-like time stamp"
    }
  }
}

Example: 
{"subject":"register-sample-start","statisticid":2,"timestamp":1596219816165}

Add Sample Long Object (sample-event-time-chart only)

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "AddSampleLong",
  "type": "object",
  "required": ["subject", "statistic-id", "value", "timestamp"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'add-sample-long'"
    },
    "statistic-id": {
      "type": "integer",
      "description": "The unique statistic id"
    },
    "value": {
      "type": "integer",
      "description": "The measured value"
    },
    "timestamp": {
      "type": "integer",
      "description": "Unix-like time stamp"
    }
  }
}

Example: 
{"subject":"add-sample-long","statisticid":2,"value":105,"timestamp":1596219842468}

Add Sample Error Object (sample-event-time-chart only)

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "AddSampleError",
  "type": "object",
  "required": ["subject", "statistic-id", "error-subject", "error-severity",
  "timestamp"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'add-sample-error'"
    },
    "statistic-id": {
      "type": "integer",
      "description": "The unique statistic id"
    },
    "error-subject": {
      "type": "string",
      "description": "The subject or title of the error"
    },
    "error-severity": {
      "type": "string",
      "description": "'warning' or 'error' or 'fatal'"
    },
    "error-type": {
      "type": "string",
      "description": "The type of the error. Errors which contains the same error
    type can be grouped."
    },
    "error-log": {
      "type": "string",
      "description": "The error log. Multiple lines are supported by adding \r\n line terminators."
    },
    "error-context": {
      "type": "string",
      "description": " Context information about the condition under which the error occurred. Multiple lines are supported by adding \r\n line terminators."
    },
    "timestamp": {
      "type": "integer",
      "description": "Unix-like time stamp"
    }
  }
}

Example: 
{
  "subject":"add-sample-error",
  "statistic-id":2,
  "error-subject":"Connection refused (Connection refused)",
  "error-severity":"error",
  "error-type":"java.net.ConnectException",
  "error-log":"2020-08-01 21:24:51.662 | main-HTTPClientProcessing[3] | INFO | GET http://192.168.0.111/\r\n2020-08-01 21:24:51.670 | main-HTTPClientProcessing[3] | ERROR | Failed to open or reuse connection to 192.168.0.111:80 |
 java.net.ConnectException: Connection refused (Connection refused)\r\n",
  "error-context":"HTTP Request Header\r\nhttp://192.168.0.111/\r\nGET / HTTP/1.1\r\nHost: 192.168.0.111\r\nConnection: keep-alive\r\nAccept: */*\r\nAccept-Encoding: gzip, deflate\r\n",
  "timestamp":1596309891672
}

Note about the error-severity :

• warning : After the error has occurred then the simulated user continues with the execution of the current session loop. Error color = yellow.
• error : After the error has occurred then the simulated aborts the execution of the current session loop iteration, and starts the execution of the next session loop iteration. Error color = red.
• fatal : After the error has occurred then the simulated user aborts any further execution of the test, which means that the test has ended for this simulated user. Error color = black.

Implementation note: After an error has occurred, the simulated user should wait at least 100 milliseconds before continuing his activities. This is to prevent that within a few seconds several thousand errors are measured and reported to the UI

Add Counter Long Object (cumulative-counter-long only)

For cumulative-counter-long statistics there is no such 2-step mechanism as for ‘sample-event-time-chart’ statistics. The value can simple increased by reporting a Add Counter Long object.

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "AddCounterLong",
  "type": "object",
  "required": ["subject", "statistic-id", "value"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'add-counter-long'"
    },
    "statistic-id": {
      "type": "integer",
      "description": "The unique statistic id"
    },
    "value": {
      "type": "integer",
      "description": "The value to increment"
    }
  }
}

Example: 
{"subject":"add-counter-long","statistic-id":10,"value":2111}

Add Average Delta And Current Value Object (average-and-current-value only)

To update a average-and-current-value statistic the delta (difference) values of the cumulated sum and the delta (difference) of the cumulated number of values has to be reported. The platform calculates then the average value by dividing the cumulated sum by the cumulated number of values. In addition, the last measured value must also be reported.

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "AddAverageDeltaAndCurrentValue",
  "type": "object",
  "required": ["subject", "statistic-id", "sumValuesDelta", "numValuesDelta", "currentValue", "currentValueTimestamp"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'add-average-delta-and-current-value'"
    },
    "statistic-id": {
      "type": "integer",
      "description": "The unique statistic id"
    },
    "sumValuesDelta": {
      "type": "integer",
      "description": "The sum of delta values to add to the average"
    },
    "numValuesDelta": {
      "type": "integer",
      "description": "The number of delta values to add to the average"
    },
    "currentValue": {
      "type": "integer",
      "description": "The current value, or -1 if no such data is available"
    },
    "currentValueTimestamp": {
      "type": "integer",
      "description": "The Unix-like timestamp of the current value, or -1 if no such data is available"
    }
  }
}

Example: 
{
  "subject":"add-average-delta-and-current-value",
  "statistic-id":100005,
  "sumValuesDelta":6302,
  "numValuesDelta":22,
  "currentValue":272,
  "currentValueTimestamp":1634401774374
}

Add Efficiency Ratio Delta Object (efficiency-ratio-percent only)

To update a efficiency-ratio-percent statistic, the delta (difference) of the number of efficient performed procedures and the delta (difference) of the number of inefficient performed procedures has to be reported.

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "AddEfficiencyRatioDelta",
  "type": "object",
  "required": ["subject", "statistic-id", "efficiencyDeltaValue", "inefficiencyDeltaValue"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'add-efficiency-ratio-delta'"
    },
    "statistic-id": {
      "type": "integer",
      "description": "The unique statistic id"
    },
    "efficiencyDeltaValue": {
      "type": "integer",
      "description": "The number of efficient performed procedures to add"
    },
    "inefficiencyDeltaValue": {
      "type": "integer",
      "description": "The number of inefficient performed procedures to add"
    }
  }
}

Example: 
{
  "subject":"add-efficiency-ratio-delta",
  "statistic-id":100006,
  "efficiencyDeltaValue":6,
  "inefficiencyDeltaValue":22
}

Add Throughput Delta Object (throughput-time-chart only)

To update a throughput-time-chart statistic, the delta (difference) value from a last absolute, cumulated value to the current cumulated value has to be reported, whereby the current time stamp is included in the calculation.

Although this type of statistic always has the unit throughput per second, a measured delta (difference) value can be reported at any time.

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "AddThroughputDelta",
  "type": "object",
  "required": ["subject", "statistic-id", "delta-value", "timestamp"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'add-throughput-delta'"
    },
    "statistic-id": {
      "type": "integer",
      "description": "The unique statistic id"
    },
    "delta-value": {
      "type": "number",
      "description": "the delta (difference) value"
    },
    "timestamp": {
      "type": "integer",
      "description": "The Unix-like timestamp of the delta (difference) value"
    }
  }
}

Example: 
{
  "subject":"add-throughput-delta",
  "statistic-id":100003,
  "delta-value":0.53612,
  "timestamp":1634401774410
}

Add Test Result Annotation Exec Event Object

Add an annotation event to the test result.

{
  "$schema": "http://json-schema.org/draft/2019-09/schema",
  "title": "AddTestResultAnnotationExecEvent",
  "type": "object",
  "required": ["subject", "event-id", "event-text", "timestamp"],
  "properties": {
    "subject": {
      "type": "string",
      "description": "Always 'add-test-result-annotation-exec-event'"
    },
    "event-id": {
      "type": "integer",
      "description": "The event id, valid range: -1 .. -999999"
    },
    "event-text": {
      "type": "string",
      "description": "the event text"
    },
    "timestamp": {
      "type": "integer",
      "description": "The Unix-like timestamp of the event"
    }
  }
}

Example: 
{
  "subject":"add-test-result-annotation-exec-event",
  "event-id":-1,
  "event-text":"Too many errors: Test job stopped by plug-in",
  "timestamp":1634401774410
}

Notes:

• The event id must be in the range from -1 (minus one) to -999999.
• Events with the same event id are merged to one event.

[End of Interface Specification]

Example

HTTP Test Wizard Plug-In

This plug-in “measures” a random value, and is executed in this example as the only part of an HTTP Test Wizard session.

The All Purpose Interface JSON objects are written using the corresponding methods of the com.dkfqs.tools.javatest.AbstractJavaTest class. This class is located in the JAR file com.dkfqs.tools.jar which is already predefined for all plug-ins.

import com.dkfqs.tools.javatest.AbstractJavaTest;
import com.dkfqs.tools.javatest.AbstractJavaTestPluginContext;
import com.dkfqs.tools.javatest.AbstractJavaTestPluginInterface;
import com.dkfqs.tools.javatest.AbstractJavaTestPluginSessionFailedException;
import com.dkfqs.tools.javatest.AbstractJavaTestPluginTestFailedException;
import com.dkfqs.tools.javatest.AbstractJavaTestPluginUserFailedException;
import com.dkfqs.tools.logging.LogAdapterInterface;
import java.util.ArrayList;
import java.util.List;
// add your imports here

/**
 * HTTP Test Wizard Plug-In 'All Purpose Interface Example'.
 * Plug-in Type: Normal Session Element Plug-In.
 * Created by 'DKF' at 24 Sep 2021 22:50:04
 * DKFQS 4.3.22
 */
@AbstractJavaTestPluginInterface.PluginResourceFiles(fileNames={"com.dkfqs.tools.jar"})
public class AllPurposeInterfaceExample implements AbstractJavaTestPluginInterface {
	private LogAdapterInterface log = null;
	
	private static final int STATISTIC_ID = 1000;
	private AbstractJavaTest javaTest = null;       // refrence to the generated test program
	
	/**
	 * Called by environment when the instance is created.
	 * @param log the log adapter
	 */
	@Override
	public void setLog(LogAdapterInterface log) {
		this.log = log;
	}
	
	/**
	 * On plug-in initialize. Called when the plug-in is initialized. <br>
	 * Depending on the initialization scope of the plug-in the following specific exceptions can be thrown:<ul>
	 * 	<li>Initialization scope <b>global:</b> AbstractJavaTestPluginTestFailedException</li>
	 * 	<li>Initialization scope <b>user:</b> AbstractJavaTestPluginTestFailedException, AbstractJavaTestPluginUserFailedException</li>
	 * 	<li>Initialization scope <b>session:</b> AbstractJavaTestPluginTestFailedException, AbstractJavaTestPluginUserFailedException, AbstractJavaTestPluginSessionFailedException</li>
	 * </ul>
	 * @param javaTest the reference to the executed test program, or null if no such information is available (in debugger environment)
	 * @param pluginContext the plug-in context
	 * @param inputValues the list of input values
	 * @return the list of output values
	 * @throws AbstractJavaTestPluginSessionFailedException if the plug-in signals that the 'user session' has to be aborted (abort current session - continue next session)
	 * @throws AbstractJavaTestPluginUserFailedException if the plug-in signals that the user has to be terminated
	 * @throws AbstractJavaTestPluginTestFailedException if the plug-in signals that the test has to be terminated
	 * @throws Exception if an error occurs in the implementation of this method
	 */
	@Override
	public List<String> onInitialize(AbstractJavaTest javaTest, AbstractJavaTestPluginContext pluginContext, List<String> inputValues) throws AbstractJavaTestPluginSessionFailedException, AbstractJavaTestPluginUserFailedException, AbstractJavaTestPluginTestFailedException, Exception {
		// log.message(log.LOG_INFO, "onInitialize(...)");
		
		// --- vvv --- start of specific onInitialize code --- vvv ---
		if (javaTest != null) {
		    this.javaTest = javaTest;
		    
		    // declare the statistic
		    javaTest.declareStatistic(STATISTIC_ID, 
            		                  AbstractJavaTest.STATISTIC_TYPE_SAMPLE_EVENT_TIME_CHART,
            		                  "My Measurement",
            		                  "",
            		                  "My Response Time",
            		                  "ms",
            		                  STATISTIC_ID,
            		                  true,
            		                  "");
		}
		// --- ^^^ --- end of specific onInitialize code --- ^^^ ---
		
		return new ArrayList<String>();		// no output values
	}

	/**
	 * On plug-in execute. Called when the plug-in is executed. <br>
	 * Depending on the execution scope of the plug-in the following specific exceptions can be thrown:<ul>
	 * 	<li>Initialization scope <b>global:</b> AbstractJavaTestPluginTestFailedException</li>
	 * 	<li>Initialization scope <b>user:</b> AbstractJavaTestPluginTestFailedException, AbstractJavaTestPluginUserFailedException</li>
	 * 	<li>Initialization scope <b>session:</b> AbstractJavaTestPluginTestFailedException, AbstractJavaTestPluginUserFailedException, AbstractJavaTestPluginSessionFailedException</li>
	 * </ul>
	 * @param pluginContext the plug-in context
	 * @param inputValues the list of input values
	 * @return the list of output values
	 * @throws AbstractJavaTestPluginSessionFailedException if the plug-in signals that the 'user session' has to be aborted (abort current session - continue next session)
	 * @throws AbstractJavaTestPluginUserFailedException if the plug-in signals that the user has to be terminated
	 * @throws AbstractJavaTestPluginTestFailedException if the plug-in signals that the test has to be terminated
	 * @throws Exception if an error occurs in the implementation of this method
	 */
	@Override
	public List<String> onExecute(AbstractJavaTestPluginContext pluginContext, List<String> inputValues) throws AbstractJavaTestPluginSessionFailedException, AbstractJavaTestPluginUserFailedException, AbstractJavaTestPluginTestFailedException, Exception {
		// log.message(log.LOG_INFO, "onExecute(...)");
		
		// --- vvv --- start of specific onExecute code --- vvv ---
		if (javaTest != null) {
		    
		    // register the start of the sample 
		    javaTest.registerSampleStart(STATISTIC_ID);
		    
		    // measure the sample
		    final long min = 1L;
		    final long max = 20L;
		    long responseTime = Math.round(((Math.random() * (max - min)) + min));
		    
		    // add the measured sample to the statistic
		    javaTest.addSampleLong(STATISTIC_ID, responseTime);
		    
		    /*
		    // error case
		    javaTest.addSampleError(STATISTIC_ID,
                                    "My error subject",
                                    AbstractJavaTest.ERROR_SEVERITY_WARNING,
                                    "My error type",
                                    "My error response text or log",
                                    "");
            */
		}
		// --- ^^^ --- end of specific onExecute code --- ^^^ ---
		
		return new ArrayList<String>();		// no output values
	}

	/**
	 * On plug-in deconstruct. Called when the plug-in is deconstructed.
	 * @param pluginContext the plug-in context
	 * @param inputValues the list of input values
	 * @return the list of output values
	 * @throws Exception if an error occurs in the implementation of this method
	 */
	@Override
	public List<String> onDeconstruct(AbstractJavaTestPluginContext pluginContext, List<String> inputValues) throws Exception {
		// log.message(log.LOG_INFO, "onDeconstruct(...)");
		
		// --- vvv --- start of specific onDeconstruct code --- vvv ---
		// no code here
		// --- ^^^ --- end of specific onDeconstruct code --- ^^^ ---
		
		return new ArrayList<String>();		// no output values
	}

}

Debugging the Interface

1. In order to debug the processing of the reported data of the interface, activate the “Debug Measuring” checkbox when starting the test job.
2. After the test job has completed, select in the Test Jobs menu at the corresponding test job the option “Job Log Files” and then select the file “DataCollector.out”.
3. Review the “DataCollector.out” file for any errors. Lines which contains “| Tailer data” reflect the raw reported data.

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 testjobs, inclusive their states)
• getTestjobOutDirectoryFilesInfo (Get from testjob 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 testjob locally and also on the measuring agent or cluster controller)

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
}

getTestjobOutDirectoryFilesInfo

Specific Request Fields:

• localTestjobId

Response Fields:

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

Specific Error Flags:

• [none]

JSON Request Example:

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

JSON Response Example (Success Case):

{
  "isClusterJob": false,
  "measuringAgentData": {
    "agentId": 65,
    "createdBySystem": false,
    "ownerUserId": 13,
    "agentActive": true,
    "agentDescription": "Demo Agent 2",
    "agentHost": "agent2.realload.com",
    "agentPort": 8080,
    "authToken": "************",
    "sharedMeasuringAgentTemplateId": -1,
    "isLaunchedByCloudCredits": false
  },
  "filesInfoArray": [
    {
      "fileName": "DataCollector.err",
      "fileSize": 0,
      "lastModified": 1695051456261,
      "mimeType": "application/octet-stream"
    },
    {
      "fileName": "DataCollector.out",
      "fileSize": 5647,
      "lastModified": 1695052318516,
      "mimeType": "application/octet-stream"
    },
    {
      "fileName": "DataCollector.pid",
      "fileSize": 8,
      "lastModified": 1695051456273,
      "mimeType": "application/octet-stream"
    },
    {
      "fileName": "DataCollector.port",
      "fileSize": 6,
      "lastModified": 1695051457729,
      "mimeType": "application/octet-stream"
    },
    {
      "fileName": "DataCollector.state",
      "fileSize": 2,
      "lastModified": 1695052318512,
      "mimeType": "application/octet-stream"
    },
    {
      "fileName": "TestResult_SimpleTest_2023-09-18@17-51-53.json",
      "fileSize": 7421,
      "lastModified": 1695052315488,
      "mimeType": "application/json"
    },
    {
      "fileName": "user_1_statistics.out",
      "fileSize": 5037,
      "lastModified": 1695052313788,
      "mimeType": "application/octet-stream"
    },
    {
      "fileName": "users.out",
      "fileSize": 1923,
      "lastModified": 1695052314000,
      "mimeType": "application/octet-stream"
    }
  ],
  "isError": false
}

getTestjobOutDirectoryFile

Specific Request Fields:

• localTestjobId
• clusterMemberId (optional, -1 = no cluster member file)
• fileName

Response Fields:

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

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"getTestjobOutDirectoryFile",
  "localTestjobId":33534,
  "fileName":"users.out"
}

JSON Response Example (Success Case):

{
  "isClusterJob": false,
  "measuringAgentData": {
    "agentId": 65,
    "createdBySystem": false,
    "ownerUserId": 13,
    "agentActive": true,
    "agentDescription": "Demo Agent 2",
    "agentHost": "agent2.realload.com",
    "agentPort": 8080,
    "authToken": "************",
    "sharedMeasuringAgentTemplateId": -1,
    "isLaunchedByCloudCredits": false
  },
  "fileContentB64": "MjAyMy0wOS0xOCAxNTo1MTo1Mi42MjYgfCBtYWluIHwgSU5GTyB8IE1heC4gSmF2YSBNZW1vcnkgPSAzMzAwIE1CCjIwMjMtMDktMTggMTU6NTE6NTIuNjU1IHwgbWFpbiB8IElORk8gfCBUaW1lIFpvbmUgPSBDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSArMDA6MDAKMjAyMy0wOS0xOCAxNTo1MTo1Mi42NjggfCBtYWluIHwgSU5GTyB8IC0tLSB2dnYgLS0tIHJlc291cmNlIGZpbGVzIC0tLSB2dnYgLS0tCjIwMjMtMDktMTggMTU6NTE6NTIuNjY5IHwgbWFpbiB8IElORk8gfCAtLS0gXl5eIC0tLSByZXNvdXJjZSBmaWxlcyAtLS0gXl5eIC0tLQoyMDIzLTA5LTE4IDE1OjUxOjUyLjY2OSB8IG1haW4gfCBJTkZPIHwgLS0tIHZ2diAtLS0gZ2VuZXJpYyBhcmd1bWVudHMgLS0tIHZ2diAtLS0KMjAyMy0wOS0xOCAxNTo1MTo1Mi42NjkgfCBtYWluIHwgSU5GTyB8IHVzZXJzID0gMQoyMDIzLTA5LTE4IDE1OjUxOjUyLjY2OSB8IG1haW4gfCBJTkZPIHwgZHVyYXRpb24gPSAzMAoyMDIzLTA5LTE4IDE1OjUxOjUyLjY3MCB8IG1haW4gfCBJTkZPIHwgbWF4TG9vcHMgPSAxCjIwMjMtMDktMTggMTU6NTE6NTIuNjcwIHwgbWFpbiB8IElORk8gfCBkZWxheVBlckxvb3AgPSAxMDAwCjIwMjMtMDktMTggMTU6NTE6NTIuNjcwIHwgbWFpbiB8IElORk8gfCByYW1wdXBUaW1lID0gMTAKMjAyMy0wOS0xOCAxNTo1MTo1Mi42NzAgfCBtYWluIHwgSU5GTyB8IGRhdGFPdXRwdXREaXIgPSAvaG9tZS9ka2Zxcy9hZ2VudC91c2Vyc0RhdGEvVXNlcl8xMy9UZXN0Sm9icy9UZXN0am9iXzI0MTI5L291dAoyMDIzLTA5LTE4IDE1OjUxOjUyLjY3MCB8IG1haW4gfCBJTkZPIHwgZGVidWdFeGVjID0gZmFsc2UKMjAyMy0wOS0xOCAxNTo1MTo1Mi42NzEgfCBtYWluIHwgSU5GTyB8IGRlYnVnRGF0YSA9IGZhbHNlCjIwMjMtMDktMTggMTU6NTE6NTIuNjcxIHwgbWFpbiB8IElORk8gfCBkZXNjcmlwdGlvbiA9IFNpbXBsZSBUZXN0CjIwMjMtMDktMTggMTU6NTE6NTIuNjcxIHwgbWFpbiB8IElORk8gfCAtLS0gXl5eIC0tLSBnZW5lcmljIGFyZ3VtZW50cyAtLS0gXl5eIC0tLQoyMDIzLTA5LTE4IDE1OjUxOjUyLjkyMSB8IG1haW4gfCBJTkZPIHwgSlZNIFdhcm11cCBwZXJmb3JtZWQgaW4gMjM2IG1zCjIwMjMtMDktMTggMTU6NTE6NTIuOTc3IHwgbWFpbiB8IElORk8gfCAtLS0gdnZ2IC0tLSBzcGVjaWZpYyBhcmd1bWVudHMgLS0tIHZ2diAtLS0KMjAyMy0wOS0xOCAxNTo1MTo1Mi45OTQgfCBtYWluIHwgSU5GTyB8IHRjcFRpbWVvdXQgPSAxMDAwMAoyMDIzLTA5LTE4IDE1OjUxOjUyLjk5NSB8IG1haW4gfCBJTkZPIHwgc3NsVGltZW91dCA9IDUwMDAKMjAyMy0wOS0xOCAxNTo1MTo1Mi45OTcgfCBtYWluIHwgSU5GTyB8IGh0dHBUaW1lb3V0ID0gMzAwMDAKMjAyMy0wOS0xOCAxNTo1MTo1Mi45OTcgfCBtYWluIHwgSU5GTyB8IC0tLSBeXl4gLS0tIHNwZWNpZmljIGFyZ3VtZW50cyAtLS0gXl5eIC0tLQoyMDIzLTA5LTE4IDE1OjUxOjUzLjAwMiB8IG1haW4gfCBJTkZPIHwgW1N0YXJ0IG9mIFRlc3RdCjIwMjMtMDktMTggMTU6NTE6NTMuMDAzIHwgVXNlci0xIHwgSU5GTyB8IFVzZXIgc3RhcnRlZAoyMDIzLTA5LTE4IDE1OjUxOjUzLjAyNiB8IHBlcmlvZGljLXRocmVhZCB8IElORk8gfCBUaHJlYWQgc3RhcnRlZAoyMDIzLTA5LTE4IDE1OjUxOjUzLjAyNiB8IFVzZXItMSB8IElORk8gfCBTdGFydCBleGVjdXRlIHNlc3Npb24gbm8uIDEgLi4uCjIwMjMtMDktMTggMTU6NTE6NTMuNTk3IHwgVXNlci0xIHwgSU5GTyB8IC4uLiBFbmQgZXhlY3V0ZSBzZXNzaW9uIG5vLiAxIHN1Y2Nlc3NmdWwgcGFzc2VkCjIwMjMtMDktMTggMTU6NTE6NTMuNjQ5IHwgVXNlci0xIHwgSU5GTyB8IFVzZXIgbm9ybWFsIHRlcm1pbmF0ZWQKMjAyMy0wOS0xOCAxNTo1MTo1NC4wMDMgfCBtYWluIHwgSU5GTyB8IFtFbmQgb2YgVGVzdF0K",
  "isError": false
}

saveTestjobOutDirectoryFileToProjectTree

Specific Request Fields:

• localTestjobId
• clusterMemberId (optional, -1 = no cluster member file)
• fileName
• saveAsFileName
• projectId
• resourceSetId

Response Fields:

• fileHashCode

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"saveTestjobOutDirectoryFileToProjectTree",
  "localTestjobId":33534,
  "fileName":"users.out",
  "saveAsFileName":"users.out",
  "projectId":137,
  "resourceSetId":251
}

JSON Response Example (Success Case):

{
  "isClusterJob": false,
  "fileHashCode": 4557110,
  "isError": false
}

deleteTestjob

Specific Request Fields:

• localTestjobId
• deleteAlsoRemoteTestjob (boolean)

Response Fields:

• localTestjobState (before the testjob was delete)
• agentResponse (for measuring agents), or
• controllerResponse (for cluster controllers)

Specific Error Flags:

• [none]

JSON Request Example:

{
  "authTokenValue":"jPmFClqeDUXaEk8Q274q",
  "action":"deleteTestjob",
  "localTestjobId":33534,
  "deleteAlsoRemoteTestjob":true
}

JSON Response Example (Success Case):

{
  "isClusterJob": false,
  "localTestjobState": "completed",
  "agentResponse": {
    "httpExecuteTimeMillis": 143
  },
  "isError": false
}

5.3 - Remote User Monitoring API

Abstract

The “Remote User Monitoring API” is a WebSocket API that supports developers to implement their own version of a Synthetic Monitoring “Real Time Dashboard”.

Similar to the Remote User API there is also an “API Authentication Token” required to access the API.

API Functions

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

• subscribeToHeartbeat : Subscribe to a periodic timestamp which is received every second.
• subscribeToRealtimeMonitor : Subscribe to events when a Monitoring Group or a Monitoring Job is created, modified or deleted, and subscribe to be notified each time when a Monitoring Group or a Monitoring Job is executed.

The subscribed data are received in JSON format. The received JSON values are never null.

subscribeToHeartbeat

• Received action: “heartbeat”

{
    "action":"heartbeat",
    "timestamp":1677521478771,
    "isError":false
}

subscribeToRealtimeMonitor

As first you will receive instantly the data of all already defined Monitoring Groups and Monitoring Jobs, and also the data of the last Execution Result of the Monitoring Groups and Monitoring Jobs (if they have been executed in the past).

After that you will receive update information of all Monitoring Groups and Monitoring Jobs when they are new-defined/modified/deleted, and you will receive also update information about the result of executed Monitoring Groups and Monitoring Jobs.

Notifications for Monitoring Groups

• Received action: “onMonitoringGroupEvent”
• monitoringGroupAction: “groupExists”, “groupAdded”, “groupModified” or “groupDeleted”

{
    "action":"onMonitoringGroupEvent",
    "monitoringGroupId":17,
    "monitoringEvent":
    {
        "eventTimestamp":1677522195873,
        "monitoringGroup":
        {
            "monitoringGroupId":17,
            "ownerUserId":13,
            "title":"Group 1",
            "description":"My First Group",
            "maxDataStorageDays":14,
            "agentType":"agent",
            "executionEnabled":false,
            "executionInterval":180,
            "executionTimeout":300,
            "currentExecutionState":"dormant",
            "lastExecutionStartTime":1677506934041
        },
        "monitoringGroupAction":"groupExists"
    },
    "isError":false
}

The executionInterval and the executionTimeout are in seconds. The lastExecutionStartTime has a value of -1 (minus one) if the Monitoring Group was never executed. The agentType has currently no meaning.