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.

Gatling Enterprise Edition gives you a unified platform for running scalable load tests—whether you write every scenario in code or build requests through the UI without touching a single file. Tests are assembled from sources (packaged simulations or Git repositories), configured with load generator locations and optional parameters, and then launched as individual runs whose results feed back into reports and long-term trends. This section covers everything you need to know to run tests on Gatling Enterprise Edition, from your first simulation to advanced campaign scheduling and credit management.

What you can do

Sources

Upload packaged simulations from Maven, Gradle, sbt, or npm, or connect a Git repository so Gatling Enterprise builds your test on demand.

Test as Code

Configure and launch tests that are defined entirely in your simulation code, with optional UI overrides for locations and injection profiles.

No-Code Runs

Build HTTP scenarios, choose an injection profile, and fire off a run—all from the Enterprise web UI, with zero code required.

Campaigns

Group related tests into campaigns that compute a live performance score and surface actionable regressions over time.

Core concepts

Sources

A source is the artifact Gatling Enterprise uses to actually run your simulation. It can be:
  • A package — a ZIP built by the Gatling Maven, Gradle, sbt, or JavaScript/TypeScript plugin and uploaded to the platform (manually, via the API, or via a build plugin command).
  • A Git repository — a repository URL that Gatling Enterprise clones and builds on every run, keeping your simulation always in sync with your codebase.
Navigate to Sources in the left-hand menu to view, create, and manage your packages and repositories.

Tests

A test is a saved configuration that combines a source (and a specific simulation class within it) with load generator settings. Every time you click Start Test, a new run is created from that configuration. From the Tests view you can:
  • Create a test (no-code, test-as-code, or from a Git repository)
  • Start, edit, duplicate, or delete any existing test
  • Set default load generator parameters that apply to all tests in your organization

Runs

A run is a single execution of a test. Each run captures a full performance record—virtual user injection, response times, error rates, throughput, DNS, TCP, and load-generator CPU metrics—that you can explore in the Reports and Trends views.
Gatling Enterprise Edition enforces a hard upper limit of 7 days per run. Any run still active after 7 days is stopped automatically to prevent runaway resource consumption.

Managed vs. private locations

Gatling Enterprise provides two families of load generator locations:
TypeDescription
ManagedHosted by Gatling, available in 11 global regions, 4 vCPU / 8 GB RAM / 10 Gbit/s each. No setup required.
PrivateDeployed on your own infrastructure (AWS, Azure, GCP, Kubernetes, or dedicated machines) via a Control Plane agent. Required for testing private networks.
Managed and private locations cannot be mixed within a single test. Choose one family per test configuration.

Key topics in this section

1

Set up your sources

Before you can run a test, Gatling Enterprise needs a simulation to execute. See Test as Code for package generation and Git repository options.
2

Create your first test

Use the Create a test button in the Tests view to choose between a no-code test, a test-as-code package test, or a Git-backed build. Each path has its own configuration wizard.
3

Configure load generators

Select the regions and number of load generators for your test. Add optional parameters such as Java system properties, environment variables, SLOs, time windows, and stop criteria.
4

Launch and observe

Click Start Test to create a run. Monitor progress in real time, then open the Report to analyse response times, error rates, and throughput.
5

Track performance over time

Link your tests to a Campaign to get an automated performance score after every run, or browse the Trends view to compare the last 10 runs side by side.

Available locations

Managed load generators are currently available in the following regions:

AP Pacific (Hong Kong)

AP Pacific (Tokyo)

AP Pacific (Mumbai)

AP SouthEast (Sydney)

Europe (Dublin)

Europe (London)

Europe (Paris)

SA East (São Paulo)

US East (N. Virginia)

US West (N. California)

US West (Oregon)

For full location setup reference, see Test as Code — Locations Configuration.

Build docs developers (and LLMs) love