Gatling Environment

System Properties

When Testable runs your simulation it will pass a few extra system properties to give you the context from which you are executing. Access using standard code: System.getProperty("testable_id");.

  • execution: The unique ID of this test case execution.
  • region_name: The name of the region in which the test is executing (e.g. aws-us-east-1).
  • gatling_instances: The total number of Gatling instances running within your test.
  • global_instance_index: A unique identifier for each Gatling instance within the execution. Starts at 0.
  • regional_instance_index: A unique identifier for each Gatling instance within this region of the execution. Starts at 0.
  • chunk: Each test runner instance is assigned a unique chunk ID.
  • client: Within each chunk, a unique ID for the Gatling instance. Starts at 0.
  • testable_id: A unique ID for this iteration of your test that is guaranteed to be globally unique. It is a combination of the above properties (e.g. 639:aws-us-east-1:640:1:2)
  • files_dir: The local directory where all files uploaded to this test case can be referenced in your test. It is also the current working directory of the Gatling process.
  • output_dir: A local directory to output any files you want to collect as part of the test results. The contents of this directory will only be captured once or twice a minute, not on every iteration of the test plan if the test plan is very short. To capture all output files across all test iterations there is an advanced option within the test configuration.

Parameters

Parameters are a way to specify values when defining your Test Configuration or via API and then utilizing these within your scenario.

Parameters are passed to your Gatling simulation as system properties. For example to pass an Environment parameter to your scenario:

  1. Add an Environment parameter in the Declared Params section of the scenario.
  2. Use this value within you code via the System.getProperty("Environment") syntax.
  3. When you create your Test Configuration it will ask you to specify a value for Environment. This value will then be passed down into your simulation as defined above. Alternatively use a trigger URL or our Simple API to pass a parameter via API.

Read more about scenario parameters here.