Skip to content

Commit f58c681

Browse files
authored
Merge pull request #2059 from grafana/k6/summary-deprecations
Update summary options with deprecation messages
2 parents ed34dfd + e6ba78a commit f58c681

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

docs/sources/k6/next/using-k6/k6-options/reference.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -786,6 +786,15 @@ export const options = {
786786

787787
## No summary
788788

789+
{{< admonition type="caution" >}}
790+
791+
This option has been deprecated since v1.3.0 and will be removed by v2.0.
792+
793+
Use the `disabled` [summary mode](#summary-mode) instead.
794+
795+
{{< /admonition >}}
796+
797+
789798
Disables [end-of-test summary](https://grafana.com/docs/k6/<K6_VERSION>/results-output/end-of-test) generation,
790799
including calls to [`handleSummary()`](https://grafana.com/docs/k6/<K6_VERSION>/results-output/end-of-test/custom-summary) and `--summary-export`.
791800

@@ -1199,6 +1208,12 @@ See an example file on the [Results Output](https://grafana.com/docs/k6/<K6_VERS
11991208

12001209
## Summary mode
12011210

1211+
{{< admonition type="caution" >}}
1212+
1213+
The `legacy` mode has been deprecated since v1.3.0, and its support will be removed by v2.0.
1214+
1215+
{{< /admonition >}}
1216+
12021217
Define how detailed the [end-of-test summary](https://grafana.com/docs/k6/<K6_VERSION>/results-output/end-of-test/) should be. Available in the `k6 run` command.
12031218

12041219
| Env | CLI | Code / Config file | Default |
@@ -1216,12 +1231,35 @@ The following modes are available:
12161231
- Detailed metrics for each protocol-specific category
12171232
- Group-specific results
12181233
- Scenario-specific results
1219-
- **legacy**: Uses the pre-v1.0.0 summary format for backward compatibility
1234+
- **disabled**: Completely disables the summary generation, including:
1235+
- Calls to [`handleSummary()`](https://grafana.com/docs/k6/<K6_VERSION>/results-output/end-of-test/custom-summary)
1236+
- The use of `--summary-export`
1237+
- **legacy** (*deprecated*): Uses the pre-v1.0.0 summary format for backward compatibility
12201238

12211239
{{< code >}}
12221240

12231241
```bash
12241242
k6 run --summary-mode=full script.js
1243+
1244+
# or...
1245+
1246+
K6_SUMMARY_MODE="full" k6 run script.js
1247+
```
1248+
1249+
```windows
1250+
k6 run --summary-mode=full script.js
1251+
1252+
# or...
1253+
1254+
set "K6_SUMMARY_MODE=full" && k6 run script.js
1255+
```
1256+
1257+
```powershell
1258+
k6 run --summary-mode=full script.js
1259+
1260+
# or...
1261+
1262+
$env:K6_SUMMARY_MODE="full"; k6 run script.js
12251263
```
12261264

12271265
{{< /code >}}

0 commit comments

Comments
 (0)