No results for

Powered byAlgolia

Browser recorder

suggest edits

The browser recorder allows generating a k6 script based on a web session. It is available as extensions for Chrome and Firefox.

k6 Cloud integration

The browser recorder functionality is powered by the k6 Cloud. When the user finalizes the recording of the session, the extension will upload the auto-generated k6 test into the k6 Cloud account.

Note: the recorder is free to use and you do not need an active k6 Cloud subscription to utilize it.

Any user can copy the script from the script editor to edit or run the test locally using the k6 run command. In the future, we plan to make this feature operational without having a k6 Cloud account.

How it works

The browser recorder allows you to generate the bulk of your test scripts simply by browsing like a user would on your site or web app. The script created gives you a foundation which you can further edit, as required.

The recorder will capture everything – every single HTTP(s) request being loaded into the browser as you click – including ads, images, documents, etc., so you get a far more accurate read of what’s going on. Just press “record”, start browsing and when complete, the script will automatically get saved to your k6 Cloud account.

Instructions

1 - Install the Chrome or Firefox extension.

2 - Start a recording

Open the extension by clicking the k6 logo, and press "Start recording" to begin recording the current browser tab. It's good to have in consideration the following best practices to record a user session:

Do

  • Browse like a user would
  • Take natural pauses that users would take to consume page content
  • Focus on the most common use cases, rather than all the possible use cases
  • Take note of pages where forms/logins occur, you will likely need to do some additional scripting here to make it use dynamic values.

Do not

  • Visit every page in one journey
  • Click every possible option
  • Navigate as fast as you can
  • Navigate away from your actual site or application

Step 2

3 - Stop the recording

When done, press "Stop recording", you'll be taken to the app to review the recorded test script

Step 3

4 - Save your test script

Save the recorded script in any of your projects.

If any third party requests are made during the recording, those requests will be filtered out by default because:

  • These third-party requests will skew the percentiles of your performance results.
  • You may not have the ability to impact the performance of third-party services
  • The load test may violate the terms of service contract that you have with the provider.

If you want to include some of the requests in the third party list, simply deselect the ones you want to include, then hit save.

Step 4

5 - Edit your script as necessary.

Depending on the type of testing, you might need to change different aspects of the script. The most usual changes are:

6 - Run the test locally or in the k6 Cloud.

If you want to run a cloud test from the k6 Cloud UI, press Run to start the test.

If you want to use the k6 CLI to run a local or cloud test, copy the generated script to your local text editor and execute the k6 run or k6 cloud command to start the test.

For learning more about running k6, check out the Running k6 guide.

Troubleshooting

The browser extension will not record other tabs or pop up windows

If you need to capture this information, you should use the HAR converter.

The HAR converter is an alternative to the browser recorder. It generates a k6 script based on the HTTP requests included in a HAR file.

Having problems recording a request?

If you have a problem recording a request, we recommend you to try the HAR converter.

The browser recorder uses the HAR converter to generate a k6 script. If the error persists with the HAR converter, please report a new issue providing detailed information about the problem.