Skip to content

What is Kraken's Gatling Application Purpose?

Usage

The Gatling application is used to ease load and performance tests made with Gatling:

  • Easily import HAR files or Gatling .scala test scripts,
  • Compare test executions with records (or compare successive test executions),
  • Visualize results during the load test execution thanks to Grafana.

Gatling App

Features List

The Gatling frontend Application offers an improved user experience to conduct load tests, with:

Note

Open the Administration App in a new browser tab to access configuration files and view available hosts if needed.

Simulations Tree

The simulations tree is located at the upper-left corner of the application. It displays all folders and files for the root directory $GATLING_HOME/user-files/simulations/.

Gatling Simulations Tree

In addition to all basic file tree features, this one allows you to:

Keyboard Mapping (Shortcuts)

The following keyboard shortcuts are available when a .scala file is selected in Simulations tree (a blue border around the tree indicates that it has the focus):

Keyboard Mapping Action
CTRL + SHIFT + X Debug the Gatling script
CTRL + SHIFT + D Execute the Gatling script

Resources Tree

The resources tree is located at the lower-left corner of the application. It displays all folders and files for the root directory $GATLING_HOME/user-files/resources/

Gatling Resources Tree

It offers no additional features than the ability to import external files used in your Gatling simulations.

Configuration Tree

The configuration files tree gives you access to all advanced configuration files.

Gatling Test Results

The test results table is located at the upper-right corner of the application.

Gatling Test Results

A new row is added to the table each time you import an HAR, debug a test or run a simulation:

Column Description Tip
Status The result status, displayed as an icon, from STARTING, RUNNING, COMPLETED, CANCELED or FAILED. Place your cursor over the icon to display the status as a text value.
Run Description The result description, entered while starting the test. The preceding icon displays the type of result: HAR, DEBUG or RUN.
Date The test start date. Place your cursor over the date to display both the start and end date of the test.

The rightmost column displays a Menu Icon icon that opens a menu.

Gatling Test Results Menu

This menu allows you to:

Click on a row to select it. Selecting a Debug result or an HAR import automatically opens the debug table, displaying the associated debug entries.

Info

Deleting a test result induces the following actions:

  • Removal of the Galting HTML report if any,
  • Removal of the Grafana dashboard and associated InfluxDB data (if any),
  • Removal of associated test results files (includes the debug entries!)

Tip

Click on a column header to sort the results table.

Results Table Shortcuts

The following keyboard shortcuts are available when the Results Table is selected (a blue border around the table indicates that it has the focus):

Keyboard Mapping Action
UP Select the previous result
DOWN Select the next result
DEL Delete the selected result ( + CTRL to skip the dialog)

Debug Entries Table

The debug table is located at the lower-right corner of the application.

Debug Table

A new row is added to the table for each debug request/response for the currently selected Debug result:

Column Description Tip
Status The debug status, displayed as an icon. OR or KO. Place your cursor over the icon to display the detailed status as a text value.
Name The request name Place your cursor over the name to display the request method and URL.
Date The request time.

The rightmost column displays a Menu Icon icon that opens a menu.

Compare Debug Menu Item

This menu allows you to compare two debug entries.

Click on a row to select it. Selecting a Debug entry opens the debug editor, displaying detailed information for the request/response couple.

Tip

Click on a column header to sort the debug table.

Debug Table Shortcuts

The following keyboard shortcuts are available when the Debug Table is selected (a blue border around the table indicates that it has the focus):

Keyboard Mapping Action
UP Select the previous debug entry
DOWN Select the next debug entry
ENTER Open the Compare Debug Entries dialog

Task and Container tables

At the bottom of the application there is a Tasks table on the left and a Containers table on the right.

Tasks Table

Tasks Table

Every time you execute a task, a row is added to the Tasks table.

Column Description Tip
Start date Since when is the task started. Place your cursor over the duration to display a start date and time.
Status The task status, computed from its containers statuses. From 'CREATING' to 'DONE' if the task is completed or 'FAILED' if an error occurred.
Type The task type. 'GATLING_RUN', 'GATLING_DEBUG' or 'GATLING_RECORD'.
Description The task description. Given when you execute a task
Containers The number of started containers / the number of expected containers.

The rightmost column displays a Stop button to cancel the execution of a task.

Note

Stopping a task may take a few seconds: the system needs to stop all containers and update the result status.

Tasks Table Shortcuts

The following keyboard shortcuts are available when the Tasks Table is selected (a blue border around the table indicates that it has the focus):

Keyboard Mapping Action
UP Select the previous task
DOWN Select the next task
DEL Cancel/Remove the selected task ( + CTRL to skip the dialog)

Containers Table

Click on a row to display the containers associated to a task:

Containers Table

Depending on the type of task, several Docker containers are started to execute it:

  • To record a HAR, two containers are used: one to convert the HAR file into a Gatling simulation, and another to generate Debug entries.
  • To debug a script, two containers are used: one to run Gatling, and one to parse the logs and generate Debug entries.
  • To run a script, two containers are used for each host: one to run Gatling and one to run Telegraf and forward the results to InfluxDB.
Column Description Tip
Start date Since when is the container started. Place your cursor over the duration to display a start date and time.
Host The container host.
Status The container status. From 'CREATING' to 'DONE' if the container is completed or 'FAILED' if an error occurred.
Label The container label. Displays what this container does.
Name The container name (uid).
Logs A button to display the container logs.

Logs

All task execution logs are visible in the Logs panel at the bottom of the application.

Each task and container is visible in a dedicated tab:

Logs Panel

Note

Container logs are only visible if you click on the Logs button in the Containers table. Task logs are automatically displayed and cannot be closed.

To stop a container log streaming, click on the Stop Icon icon at right of the tab header (this will not stop the container, only the display of tis logs).

Once the logs has terminated, click on the Close Icon icon to close the tab.

Tip

Close all finished logs by right-clicking on the panel header, then on Close Terminated Logs.