Skip to content

Commit e3fb077

Browse files
Apply suggestions from code review
Co-authored-by: Heitor Tashiro Sergent <[email protected]>
1 parent abd5fd8 commit e3fb077

File tree

1 file changed

+14
-12
lines changed
  • docs/sources/next/results-output/web-dashboard

1 file changed

+14
-12
lines changed

docs/sources/next/results-output/web-dashboard/_index.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,34 @@
11
---
2-
title: Web Dashboard
3-
excerpt: With the web-dashboard, you can track test results in real-time, and generate HTML test reports directly from your web browser.
2+
title: Web dashboard
3+
description: Track test results in real-time with the web-dashboard and generate HTML test reports directly from your web browser.
44
weight: 200
55
---
66

77
# Web dashboard
88

9-
k6 provides a built-in web dashboard running on the user's machine and enabling them to monitor their test results in real-time.
10-
11-
## Real-time test results
9+
k6 provides a built-in web dashboard that you can enable to visualize and monitor your tests results in real-time.
1210

1311
![Web dashboard screenshot](/media/docs/k6-oss/web-dashboard-overview.png)
1412

15-
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.
1614

17-
## HTML test reports
15+
## Generate HTML test reports
1816

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.
2018

2119
![HTML test report screenshot](/media/docs/k6-oss/web-dashboard-report.png)
2220

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.
2422

2523
![HTML test report generation button](/media/docs/k6-oss/web-dashboard-report-button.png)
2624

2725
## How to use
2826

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+
```
3032

3133
```shell
3234
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
4345
output: -
4446
```
4547
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).
4749
4850
## Dashboard options
4951
@@ -56,4 +58,4 @@ The web dashboard can be configured using environment variables:
5658
| `K6_WEB_DASHBOARD_PORT` | Port to bind the web dashboard to | `5665` |
5759
| `K6_WEB_DASHBOARD_PERIOD` | Period in seconds to update the web dashboard | `10s` |
5860
| `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

Comments
 (0)