From 259f42993db049df31648c107333b65a56c7eae3 Mon Sep 17 00:00:00 2001 From: Oleg Bespalov Date: Wed, 28 Aug 2024 15:39:27 +0200 Subject: [PATCH] Document Params.discardResponseMessage gRPC's option --- .../sources/next/javascript-api/k6-net-grpc/params.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/sources/next/javascript-api/k6-net-grpc/params.md b/docs/sources/next/javascript-api/k6-net-grpc/params.md index f5ea88207f..819d166b86 100644 --- a/docs/sources/next/javascript-api/k6-net-grpc/params.md +++ b/docs/sources/next/javascript-api/k6-net-grpc/params.md @@ -11,11 +11,12 @@ aliases: _Params_ is an object used by the gRPC methods that generate RPC requests. _Params_ contains request-specific options like headers that should be inserted into the request. -| Name | Type | Description | -| ----------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `Params.metadata` | object | Object with key-value pairs representing custom metadata the user would like to add to the request. Values of [keys ending with `-bin`](https://grpc.io/docs/what-is-grpc/core-concepts/#metadata) will be treated as binary data. | -| `Params.tags` | object | Key-value pairs where the keys are names of tags and the values are tag values. Response time metrics generated as a result of the request will have these tags added to them, allowing the user to filter out those results specifically, when looking at results data. | -| `Params.timeout` | string / number | Request timeout to use. Default timeout is 60 seconds (`"60s"`).
The type can also be a number, in which case k6 interprets it as milliseconds, e.g., `60000` is equivalent to `"60s"`. | +| Name | Type | Description | +| ------------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `Params.metadata` | object | Object with key-value pairs representing custom metadata the user would like to add to the request. Values of [keys ending with `-bin`](https://grpc.io/docs/what-is-grpc/core-concepts/#metadata) will be treated as binary data. | +| `Params.tags` | object | Key-value pairs where the keys are names of tags and the values are tag values. Response time metrics generated as a result of the request will have these tags added to them, allowing the user to filter out those results specifically, when looking at results data. | +| `Params.timeout` | string / number | Request timeout to use. Default timeout is 60 seconds (`"60s"`).
The type can also be a number, in which case k6 interprets it as milliseconds, e.g., `60000` is equivalent to `"60s"`. | +| `Params.discardResponseMessage` | bool | Specify if response messages should be discarded, lessens the amount of memory required and the amount of garbage collection (GC) - reducing the load on the testing machine, and probably producing more reliable test results. Default is `false`. | ### Example of custom metadata headers and tags