You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The dashboard provides a real-time overview of the performance observed by k6 while a test is running, and helps to identify potential reliability issues as they occur.
13
+
The dashboard provides a real-time overview of the performance observed by k6 while a test is running, and can help you identify potential reliability issues as they occur.
16
14
17
-
## HTML test reports
15
+
## Generate HTML test reports
18
16
19
-
The dashboard enables to generate detailed, downloadable HTML reports directly from the dashboard. These reports are self-contained, making them ideal for sharing with your team.
17
+
You can generate detailed, downloadable HTML reports directly from the dashboard. These reports are self-contained, making them ideal for sharing with your team.
20
18
21
19

22
20
23
-
The HTML test report can be accessed from the dashboard's menu, by clicking on the "Report" button.
21
+
You can access the HTML test report by clicking the "Report" button on the dashboard's menu.
24
22
25
23

26
24
27
25
## How to use
28
26
29
-
The web dashboard is a built-in feature of k6, and can be enabled by setting the `K6_WEB_DASHBOARD` environement variable to `true`. When used, the k6 run command will provide a link to the web dashboard in the terminal output:
27
+
The web dashboard is a built-in feature of k6. You can enable it by setting the `K6_WEB_DASHBOARD` environment variable to `true` when running your test script, for example:
28
+
29
+
```shell
30
+
K6_WEB_DASHBOARD=true k6 run script.js
31
+
```
30
32
31
33
```shell
32
34
K6_WEB_DASHBOARD=true ./k6 run ../extensions/xk6-dashboard/script.js
@@ -43,7 +45,7 @@ K6_WEB_DASHBOARD=true ./k6 run ../extensions/xk6-dashboard/script.js
43
45
output: -
44
46
```
45
47
46
-
By default, when active, the web dashboard is exposed on localhost port `5665`. You can however configure.
48
+
By default, the web dashboard is available on localhost port `5665`. You can change the host and port by using the [dashboard options](#dashboard-options).
47
49
48
50
## Dashboard options
49
51
@@ -56,4 +58,4 @@ The web dashboard can be configured using environment variables:
56
58
|`K6_WEB_DASHBOARD_PORT`| Port to bind the web dashboard to |`5665`|
57
59
|`K6_WEB_DASHBOARD_PERIOD`| Period in seconds to update the web dashboard |`10s`|
58
60
|`K6_WEB_DASHBOARD_OPEN`| Open the web dashboard in the default browser |`false`|
59
-
|`K6_WEB_DASHBOARD_REPORT_FILENAME`| Filename to export the HTML test report to |`report.html`|
61
+
|`K6_WEB_DASHBOARD_EXPORT `| Filename to automatically export the HTML test report to at the end of the test run. By default, the value is empty and the report isn't exported. | `` |
0 commit comments