Simulations

Navigate through simulations.

Managing Simulations

To access the Simulations section, click on Simulations in the navigation bar.

The Simulations view contains all the simulations configured by your organization and the results of their last run.

Simulation table

If you don’t have any simulations configured yet and don’t know where to start, you can download some Gatling Enterprise pre-configured projects by clicking on the “Sample simulations” button.

Samples

Those samples are ready to use Maven, sbt and Gradle projects that are properly configured for Gatling Enterprise. You can also download those samples with the download link in the Documentation section.

Back to the Simulations section, at the top-right, there is an action bar which allows several actions:

  • Create a simulation
  • Search by simulation or team name
  • Edit global properties
  • Delete selected simulations
Action bar

Global Properties

Global properties contains every JVM option and the system properties used by all of your simulations by default. Editing those properties will be propagated to all the simulations. You can access it by clicking on the top right corner of the page.

If you don’t want to use the default properties, check Use custom global properties and enter your own.

Properties

If you want specific properties for a simulation, you will be allowed to ignore those properties by checking the Override Global Properties box when creating or editing the simulation:

Override

Creating a simulation

In order to create a simulation click on the “Create” button in the simulations table. There are 6 steps to create a simulation, 3 of which are optional.

Step 1: General

Create simulation - Step 1
  • Name: the name that will appear on the simulations table.
  • Team: the team which owns the simulation.
  • Class name: the package and class name of the simulation scala class you want to start within your project.

Step 2: Build configuration

In this step, you’ll configure the package of the Simulation to execute.

Create simulation - Step 2

Step 3: Pools configuration

In this step, you’ll configure the pools used for the Gatling Enterprise injectors.

Gatling Enterprise pools are available in the following regions:

  • Europe (Paris)
  • US East (N. Virginia)
  • US West (N. California)

In order for the best results from your simulation you should select the injectors that best represent your user base.

Create simulation - Step 3
  • Weight distribution: if set to even, every injector will produce the same load. If set to custom, you must set the weight in % for each pool (eg the first pool does 20% of the requests, and the second does 80%). The sum of the weight must be 100%.
  • Pools: defines the pools to be used when initiating the Gatling Enterprise injectors.

You can add several pools with different numbers of injectors to run your simulation.

After this step, you can save the simulation, or click on More options to access optional configurations.

Step 4 & 5: JVM options & Java System Properties

These steps allow you to define the JVM arguments and system properties used when running this particular simulation. You can choose to override the global properties.

Create simulation - Step 4
Create simulation - Step 5

Step 6: Time window

Configuring a ramp up or ramp down means that the beginning and end of your simulation won’t be used for calculating metrics and assertions.

Create simulation - Step 6
  • Ramp Up: the number of seconds you want to exclude at the beginning of the run.
  • Ramp Down: the number of seconds you want to exclude at the end of the run.

Simulations table

Once you have created a simulation, you can start it by clicking on the icon in the Start column of the table.

Start

A run has the following life cycle:

  • Building: in which it will download the simulation package and prepare the hosts
  • Deploying: in which it will deploy the simulation to run on all the injectors
  • Injecting: in which the simulation is running and can be viewed from the Reports.
Injecting

By clicking on the icon in the Build Start column, Gatling Enterprise will display the build logs of the simulation. There is a limit of 1000 logs for a run.

Viewing the Log can also be helpful in determining why a run failed and what errors you will need to correct to successfully run your simulation.

Logs

You can click on the icon next to the status (if there is one) to display the assertions of the run. Assertions are the assumptions made at the beginning of the simulation to be verified at the end:

Assertions

Useful tips

  • You can edit the simulation by clicking on the icon next to its name
  • You can search a simulation by its name, or its team name
  • You can sort the simulations by any column except the Start one
  • A Delete button will appear on the action bar when you select a simulation, you will be able to delete all the selected simulations
  • When a simulation is running, you can stop the ongoing run by clicking on the Stop button
  • You can copy a simulation ID by clicking on the icon next to its name

Be aware that deleting a simulation will delete all the associated runs.

Edit this page on GitHub