Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gatling/gatling.io-doc/llms.txt

Use this file to discover all available pages before exploring further.

The Gatling Enterprise TeamCity plugin lets you launch Gatling Enterprise Edition simulations directly from a TeamCity build plan. Each build step is linked to a single simulation and streams live metrics to the build log while the run is in progress. When the run completes, results are available on a dedicated Gatling Enterprise Edition Results tab and — optionally — as a JUnit test report for assertion results.
This integration is only available on Gatling Enterprise Edition. The plugin starts pre-configured simulations; you must create them in the Gatling Enterprise Edition dashboard before configuring the build step.

​
Installation

1

Download the Plugin

Download the plugin ZIP from the Gatling Enterprise CI plugins releases page.
2

Upload to TeamCity

Log in as a TeamCity administrator. Navigate to Administration → Plugins → Upload plugin zip, select the downloaded ZIP file, and upload it.
3

Enable the Plugin

After the upload completes, enable the plugin from the Plugins list. A TeamCity restart may be required.

​
Global Configuration

Configure the plugin’s connection to Gatling Enterprise Edition in the global administration settings:
1

Open Plugin Settings

Navigate to Administration → gatling-enterprise-teamcity-plugin.
2

Set the Addresses

  • Gatling Enterprise Edition Address: https://cloud.gatling.io
  • Gatling Enterprise Edition API Address: https://api.gatling.io (leave blank if using the default cloud address — it will be inferred automatically)
3

Set the API Token

Enter your Gatling Enterprise Edition API token. The token must have the Start permission.
If your TeamCity instance reaches the Gatling API through an internal gateway, enter that gateway’s URL as the API Address instead of the default https://api.gatling.io.

​
Plan Setup

​
Adding the Build Step

1

Add a Build Step

In your build configuration, add a new build step and select Gatling Enterprise Edition Launcher as the runner type.
2

Select a Simulation

Choose the simulation to run from the Simulation drop-down. The list is populated from your Gatling Enterprise Edition account using the configured API token.
3

Configure Run Summary Logging

By default, a status summary is logged every 5 seconds for the first 60 seconds, then every 60 seconds. You can adjust or disable this in the step configuration to control build log verbosity.

​
JUnit Assertion Reporting

Display assertion results as JUnit test cases in the TeamCity build results:
1

Add a Build Feature

In the build configuration, navigate to Build Features and add the XML report processing feature.
2

Configure the Report Path

Set Report type to Ant JUnit and enter the following path in Monitoring rules:
gatlingEnterpriseJunitResults/*.xml
If your simulation has no assertions configured, the JUnit report processing step will fail. Only enable this feature when your simulation includes at least one assertion.

​
Usage

Each time the TeamCity build plan runs, the plugin starts a new Gatling Enterprise Edition simulation. The build log displays live metrics as the run progresses. When the run finishes:
  • The Console Log shows the final status and any assertion results.
  • The Gatling Enterprise Edition Results tab in the build view shows a full summary of the simulation run.

​
Configuration Summary

SettingValue
Enterprise Addresshttps://cloud.gatling.io
API Addresshttps://api.gatling.io (default, can be left blank)
API Token PermissionStart
JUnit results pathgatlingEnterpriseJunitResults/*.xml
Default log interval (first 60s)Every 5 seconds (12 times)
Default log interval (after 60s)Every 60 seconds

Build docs developers (and LLMs) love

Get started for freeTalk to us