chore: add minimum test duration for report to display graphs #1501
Conversation
|
@szkiba this is from our Slack thread, please let me know if this is accurate. 🙏 |
|
@heitortsergent it would be a bit more precise if write something like this instead of 30 sec: "3 times the aggregation period (default 10sec). " |
| @@ -65,6 +65,8 @@ To automatically generate a report from the command line once the test finishes | |||
| K6_WEB_DASHBOARD=true K6_WEB_DASHBOARD_EXPORT=html-report.html k6 run script.js | |||
| ``` | |||
|
|
|||
| The report only includes graphs if the test duration is over thirty seconds. | |||
There was a problem hiding this comment.
@heitortsergent it would be a bit more precise if write something like this instead of 30 sec: "3 times the aggregation period (default 10sec). "
This is how 30 sec come into the picture
| @@ -65,6 +65,12 @@ To automatically generate a report from the command line once the test finishes | |||
| K6_WEB_DASHBOARD=true K6_WEB_DASHBOARD_EXPORT=html-report.html k6 run script.js | |||
| ``` | |||
|
|
|||
| {{< admonition type="note" >}} | |||
|
|
|||
| The report only includes graphs if the test duration is greater than three times the aggregation period value, set by the `K6_WEB_DASHBOARD_PERIOD` variable. | |||
There was a problem hiding this comment.
@szkiba I updated the explanation based on your comment, and also switched it to an admonition so it's easier for readers to see this.
What do you think? 🤓
There was a problem hiding this comment.
Perfect :)
maybe I would mention 30sec as the default value in parentheses, just so the user doesn't have to search)
| @@ -65,6 +65,12 @@ To automatically generate a report from the command line once the test finishes | |||
| K6_WEB_DASHBOARD=true K6_WEB_DASHBOARD_EXPORT=html-report.html k6 run script.js | |||
| ``` | |||
|
|
|||
| {{< admonition type="note" >}} | |||
|
|
|||
| The report only includes graphs if the test duration is greater than three times the aggregation period value, set by the `K6_WEB_DASHBOARD_PERIOD` variable. | |||
There was a problem hiding this comment.
Perfect :)
maybe I would mention 30sec as the default value in parentheses, just so the user doesn't have to search)
|
@szkiba I wrote another version mentioning the 30s because of the default value, and I was just having a hard time making it clear and concise... So I decided to just leave it as is for now, that way if we decide to change the default iteration value, we don't have to remember to update this admonition too. :D |
What?
Add the minimum test duration required for graphs to be displayed in the report generated by the web dashboard feature.
Checklist
Please fill in this template:
make docscommand locally and verified that the changes look good.If updating the documentation for the most recent release of k6:
docs/sources/nextfolder of the documentation.docs/sources/v{most_recent_release}folder of the documentation.If updating the documentation for the next release of k6:
docs/sources/nextfolder of the documentation.Related PR(s)/Issue(s)
Closes #1499.