Integrate Gatling plugin in NeoLoad

With the NeoLoad plugin for Gatling, you can send live performance data from your Gatling test runs directly to Tricentis NeoLoad. This integration helps you analyze real-time Gatling test results using NeoLoad Web’s features.

For the integration's requirements, check out this table:

Requirements Description
Maturity NeoLoad doesn't support it
License To be determined
NeoLoad Web Compatible from version 3.2
Gatling versions Tested with version 3.9
Download Binaries You can find them in our support hub (opens in new tab)

Before you start

To integrate Gatling with NeoLoad, follow these steps:

  1. Download and install Gatling (opens in a new tab).

  2. Download the NeoLoad .jar file with the Gatling plugin (opens in new tab) and set the script to gatling.bat if you're in Windows or to gatling.sh if you're in Linux.

  3. Set the script. If you're using Windows, set it to gatling.bat. For Linux, set it to gatling.sh.

  4. Create a directory named plugins in your GATLING_DIR and paste the downloaded jar file there.

  5. Replace the existing Gatling scripts in GATLING_DIR/bin with the newly downloaded gatling.bat (Windows) or gatling.sh (Linux) file.

Configure the plugin

To configure the Gatling plugin for NeoLoad, follow these steps:

  1. In the GATLING_DIR/conf folder, open the gatling.conf file.

  2. Scroll to the data section at the end of the file.

  3. Remove the comment symbol (#) from the line: writers = [console, file, ...]

  4. Remove console from the writers list.

  5. Add neoload to the writers list.

  6. At the end of the data section, add a neoload section with the following parameters:

    • url: The URL of the NeoLoad Web API endpoint.

    • token: Your NeoLoad Web user API token for authentication.

    • workspace: The workspace ID to send the results to.

    • testId (Optional): The specific test ID to associate the results with. Omit for orphan test results.

  1. Run your Gatling test as usual. Once the test starts, you'll see a new entry in the Running Tests section of the NeoLoad Web home page. You can view performance data in real-time within NeoLoad Web.

List of error codes

Error code Description
GATLING-ILLEGAL-ARGUMENT An invalid or unsupported argument was provided.
GATLING-UNKNOWN-HOST The host specified in the configuration is unknown.
GATLING-SSL-HANDSHAKE An error occurred during the SSL handshake process.
GATLING-CONNECT-TIMEOUT The connection attempt to the specified host timed out.
GATLING-CLOSED-CHANNEL An I/O operation was attempted on a channel that is already closed.
GATLING-BIND An error occurred while trying to bind a socket to a local address or port.

Change log

First version

  • Includes all Gatling metrics.

  • Supports group hierarchical structures.

  • Captures throughput and time-to-first-byte for requests.

  • Reports check violations on event errors.

  • Provides monitoring metrics such as memory, CPU usage, and user load.