Skip to content

Commit f0ebd73

Browse files
ppcanoppcano
authored
Update browser recorder articles to reference Grafana Cloud Browser extensions (#1237)
1 parent 58cfeea commit f0ebd73

File tree

2 files changed

+78
-31
lines changed

2 files changed

+78
-31
lines changed

‎src/data/markdown/docs/03 cloud/01 Creating and running a test/04 Using the browser recorder.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: 'Using the browser recorder'
3+
excerpt: 'The browser recorder generates a k6 script based on a web session. It is available as extensions for Chrome and Firefox.'
4+
robots: NOINDEX, FOLLOW
5+
---
6+
7+
The browser recorder lets you generate a k6 script based on a browser session.
8+
9+
10+
<Blockquote mod="attention" title="New Browser Recorder">
11+
12+
These [Chrome](https://chrome.google.com/webstore/detail/k6-browser-recorder/phjdhndljphphehjpgbmpocddnnmdbda?hl=en) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/k6-browser-recorder/) extensions only work for existing k6 Cloud users.
13+
14+
For new users, check out the [latest browser recorder](https://grafana.com/docs/grafana-cloud/k6/author-run/browser-recorder/), which is also free and lets you auto-generate the k6 script.
15+
16+
</Blockquote>
17+
18+
19+
20+
## Before you start
21+
22+
Before you start, consider the following:
23+
24+
- [Be sure to record realistically](/test-authoring/create-tests-from-recordings/#be-sure-to-record-realistically)
25+
- [A hybrid approach for load testing websites](/test-authoring/create-tests-from-recordings/#consider-hybrid-approach-for-load-testing-websites)
26+
27+
28+
## How to record
29+
30+
31+
1. Install the [Chrome](https://chrome.google.com/webstore/detail/k6-browser-recorder/phjdhndljphphehjpgbmpocddnnmdbda?hl=en) or [Firefox](https://addons.mozilla.org/en-US/firefox/addon/k6-browser-recorder/) extension.
32+
1. Open the extension by clicking the k6 logo.
33+
1. Select **Start recording** to begin recording the current browser tab.
34+
![start recording](./images/Recording-a-test-script/step-2.png)
35+
1. When done, select **Stop recording**. You'll be taken to the app to review the recorded test script.
36+
![Step 3](./images/Recording-a-test-script/step-3.png)
37+
1. Save the recorded script in any of your projects.
38+
To include some of the requests in the _third party list_, deselect the ones you want to include.
39+
![Step 4](./images/Recording-a-test-script/step-4.png)
40+
1. Edit your script as necessary. Depending on the [type of load test](/test-types/load-test-types/), you might need to change different aspects of the script.
41+
Typical changes are for [load options](/using-k6/options) and to handle [correlation and dynamic data](/examples/correlation-and-dynamic-data).
42+
1. Run the test locally or in k6 Cloud.
43+
44+
- To run a test from the k6 Cloud UI, select **Run** to start the test.
45+
- 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.
46+
47+
For more about running k6, refer to the [Running k6 guide](/get-started/running-k6).
48+
49+
## Trouble? Try the HAR converter
50+
51+
Some users have reported `413` errors when they try to upload long recordings.
52+
In these cases, the easiest fix is to use the [HAR converter](/test-authoring/create-tests-from-recordings/using-the-har-converter/), which creates a k6 script from the HTTP requests included in a HAR file (it also powers the browser recorder).
53+
54+
Besides avoiding the `413` error,
55+
the HAR converter catches some edge-case behavior that the browser recorder won't.
56+
For example, the browser extension doesn't record other tabs or pop-up windows.
57+
58+
If you need to capture this information or are having a problem recording a request, try the HAR converter.
59+
If the error persists with the HAR converter, please provide detailed information about the problem [in a new issue](https://github.com/k6io/har-to-k6/issues).

‎src/data/markdown/translated-guides/en/05 Test authoring/02 Create tests from recordings/01 Using the browser recorder.md‎

Lines changed: 19 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,53 +4,41 @@ excerpt: 'The browser recorder allows generating a k6 script based on a web sess
44
---
55

66
The browser recorder lets you generate a k6 script based on a browser session.
7-
It's available as an extension for [Chrome](https://chrome.google.com/webstore/detail/k6-browser-recorder/phjdhndljphphehjpgbmpocddnnmdbda?hl=en) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/k6-browser-recorder/).
7+
It's available as an extension for [Chrome](https://chrome.google.com/webstore/detail/grafana-k6-browser-record/fbanjfonbcedhifbgikmjelkkckhhidl) and [Firefox](https://addons.mozilla.org/en-US/firefox/addon/grafana-k6-browser-recorder/).
88

99

1010
## Before you start
1111

12+
1213
Before you start, consider the following:
1314

1415
- [Be sure to record realistically](/test-authoring/create-tests-from-recordings/#be-sure-to-record-realistically)
1516
- [A hybrid approach for load testing websites](/test-authoring/create-tests-from-recordings/#consider-hybrid-approach-for-load-testing-websites)
1617

18+
> Note that the browser recorders **do not require a cloud account**. For cloud users, check out the [Grafana Cloud](https://grafana.com/docs/grafana-cloud/k6/author-run/browser-recorder/) and [k6 Cloud](/cloud/creating-and-running-a-test/using-the-browser-recorder/) instructions.
1719
1820
## How to record
1921

20-
<Blockquote mod="note" title="The recorder is free to use">
21-
22-
The browser recorder requires a [k6 Cloud account](https://app.k6.io), but you do not need an active k6 Cloud subscription.
23-
24-
When you finish recording the session, the browser extension uploads the auto-generated k6 test into your k6 Cloud account. You can then copy the script to edit it in your local IDE and run the test locally using the `k6 run` command.
25-
26-
</Blockquote>
27-
28-
1. Install the [Chrome](https://chrome.google.com/webstore/detail/k6-browser-recorder/phjdhndljphphehjpgbmpocddnnmdbda?hl=en) or [Firefox](https://addons.mozilla.org/en-US/firefox/addon/k6-browser-recorder/) extension.
22+
1. Install the [Chrome](https://chrome.google.com/webstore/detail/grafana-k6-browser-record/fbanjfonbcedhifbgikmjelkkckhhidl) or [Firefox](https://addons.mozilla.org/en-US/firefox/addon/grafana-k6-browser-recorder/) extension.
2923
1. Open the extension by clicking the k6 logo.
30-
1. Select **Start recording** to begin recording the current browser tab.
31-
![start recording](./images/Recording-a-test-script/step-2.png)
32-
1. When done, select **Stop recording**. You'll be taken to the app to review the recorded test script.
33-
![Step 3](./images/Recording-a-test-script/step-3.png)
34-
1. Save the recorded script in any of your projects.
35-
To include some of the requests in the _third party list_, deselect the ones you want to include.
36-
![Step 4](./images/Recording-a-test-script/step-4.png)
37-
1. Edit your script as necessary. Depending on the [type of load test](/test-types/load-test-types/), you might need to change different aspects of the script.
24+
2. Choose where to save the auto-generated script.
25+
- To save it on your local machine, select **I don't want to save tests in the cloud**.
26+
- To save it on any of your Grafana Cloud k6 projects, select **Sign In**.
27+
3. Select **Start recording** to begin recording the current browser tab.
28+
4. When done, select **Stop recording**.
29+
5. Save the recorded script locally or in any of your cloud projects.
30+
6. Edit your script as necessary. Depending on the [type of load test](/test-types/load-test-types/), you might need to change different aspects of the script.
3831
Typical changes are for [load options](/using-k6/options) and to handle [correlation and dynamic data](/examples/correlation-and-dynamic-data).
39-
1. Run the test locally or in k6 Cloud.
40-
41-
- To run a test from the k6 Cloud UI, select **Run** to start the test.
42-
- 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.
32+
7. Run the test from the CLI or Grafana Cloud k6. For more about running k6, refer to the [Running k6 guide](/get-started/running-k6).
4333

44-
For more about running k6, refer to the [Running k6 guide](/get-started/running-k6).
34+
## Troubleshooting. Try the HAR converter
4535

46-
## Trouble? Try the HAR converter
4736

48-
Some users have reported `413` errors when they try to upload long recordings.
49-
In these cases, the easiest fix is to use the [HAR converter](/test-authoring/create-tests-from-recordings/using-the-har-converter/), which creates a k6 script from the HTTP requests included in a HAR file (it also powers the browser recorder).
37+
If you experience problems recording a request, try the [HAR converter](/test-authoring/create-tests-from-recordings/using-the-har-converter/).
5038

51-
Besides avoiding the `413` error,
52-
the HAR converter catches some edge-case behavior that the browser recorder won't.
53-
For example, the browser extension doesn't record other tabs or pop-up windows.
39+
The Browser recorder uses the HAR converter under the hood.
40+
Like the Browser Recorder, the HAR converter creates a k6 script from the HTTP requests included in a HAR file.
41+
42+
The HAR converter can also record other tabs or pop-up windows, which the Browser Recorder cannot.
5443

55-
If you need to capture this information or are having a problem recording a request, try the HAR converter.
56-
If the error persists with the HAR converter, please provide detailed information about the problem [in a new issue](https://github.com/k6io/har-to-k6/issues).
44+
If the error persists with the HAR converter, please provide detailed information about the problem [in a new issue](https://github.com/k6io/har-to-k6/issues).

0 commit comments

Comments
 (0)