Improve gRPC connection params docs

grafana · Jan 29, 2024 · 2be18b4 · 2be18b4
1 parent 0a89fc7
commit 2be18b4
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 16 deletions.
diff --git a/...script-api/k6-experimental/grpc/client/client-connect-connect-address-params.md b/...script-api/k6-experimental/grpc/client/client-connect-connect-address-params.md
@@ -26,8 +26,8 @@ See [Client.close()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-
 | `ConnectParams.reflect`         | boolean         | Whether to use the [gRPC server reflection protocol](https://github.com/grpc/grpc/blob/master/doc/server-reflection.md) when connecting.                                            |
 | `ConnectParams.reflectMetadata` | object          | Object with key-value pairs representing custom metadata the user would like to add to the reflection request.                                                                      |
 | `ConnectParams.timeout`         | string / number | Connection timeout to use. Default timeout is `"60s"`. <br/> The type can also be a number, in which case k6 interprets it as milliseconds, e.g., `60000` is equivalent to `"60s"`. |
-| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to 0.                                                                                                       |
-| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to 0.                                                                                                          |
+| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to `grpc-go` default, which is 4MB.                                                                         |
+| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to `grpc-go` default, which is approximately 2GB.                                                              |
 | `ConnectParams.tls` (optional)  | object          | [TLS](#tls) settings of the connection. Defaults to `null`.                                                                                                                         |
 
 ## TLS

diff --git a/...next/javascript-api/k6-net-grpc/client/client-connect-connect-address-params.md b/...next/javascript-api/k6-net-grpc/client/client-connect-connect-address-params.md
@@ -24,8 +24,8 @@ See [Client.close()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-
 | `ConnectParams.reflect`         | boolean         | Whether to use the [gRPC server reflection protocol](https://github.com/grpc/grpc/blob/master/doc/server-reflection.md) when connecting.                                            |
 | `ConnectParams.reflectMetadata` | object          | Object with key-value pairs representing custom metadata the user would like to add to the reflection request.                                                                      |
 | `ConnectParams.timeout`         | string / number | Connection timeout to use. Default timeout is `"60s"`. <br/> The type can also be a number, in which case k6 interprets it as milliseconds, e.g., `60000` is equivalent to `"60s"`. |
-| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to 0.                                                                                                       |
-| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to 0.                                                                                                          |
+| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to `grpc-go` default, which is 4MB.                                                                         |
+| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to `grpc-go` default, which is approximately 2GB.                                                              |
 | `ConnectParams.tls` (optional)  | object          | [TLS](#tls) settings of the connection. Defaults to `null`.                                                                                                                         |
 
 ## TLS

diff --git a/...script-api/k6-experimental/grpc/client/client-connect-connect-address-params.md b/...script-api/k6-experimental/grpc/client/client-connect-connect-address-params.md
@@ -24,8 +24,8 @@ See [Client.close()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-
 | `ConnectParams.reflect`         | boolean         | Whether to use the [gRPC server reflection protocol](https://github.com/grpc/grpc/blob/master/doc/server-reflection.md) when connecting.                                            |
 | `ConnectParams.reflectMetadata` | object          | Object with key-value pairs representing custom metadata the user would like to add to the reflection request.                                                                      |
 | `ConnectParams.timeout`         | string / number | Connection timeout to use. Default timeout is `"60s"`. <br/> The type can also be a number, in which case k6 interprets it as milliseconds, e.g., `60000` is equivalent to `"60s"`. |
-| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to 0.                                                                                                       |
-| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to 0.                                                                                                          |
+| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to `grpc-go` default, which is 4MB.                                                                         |
+| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to `grpc-go` default, which is approximately 2GB.                                                              |
 | `ConnectParams.tls` (optional)  | object          | [TLS](#tls) settings of the connection. Defaults to `null`.                                                                                                                         |
 
 ## TLS

diff --git a/...47.x/javascript-api/k6-net-grpc/client/client-connect-connect-address-params.md b/...47.x/javascript-api/k6-net-grpc/client/client-connect-connect-address-params.md
@@ -24,8 +24,8 @@ See [Client.close()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-
 | `ConnectParams.reflect`         | boolean         | Whether to use the [gRPC server reflection protocol](https://github.com/grpc/grpc/blob/master/doc/server-reflection.md) when connecting.                                            |
 | `ConnectParams.reflectMetadata` | object          | Object with key-value pairs representing custom metadata the user would like to add to the reflection request.                                                                      |
 | `ConnectParams.timeout`         | string / number | Connection timeout to use. Default timeout is `"60s"`. <br/> The type can also be a number, in which case k6 interprets it as milliseconds, e.g., `60000` is equivalent to `"60s"`. |
-| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to 0.                                                                                                       |
-| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to 0.                                                                                                          |
+| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to `grpc-go` default, which is 4MB.                                                                         |
+| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to `grpc-go` default, which is approximately 2GB.                                                              |
 | `ConnectParams.tls` (optional)  | object          | [TLS](#tls) settings of the connection. Defaults to `null`.                                                                                                                         |
 
 ## TLS

diff --git a/...script-api/k6-experimental/grpc/client/client-connect-connect-address-params.md b/...script-api/k6-experimental/grpc/client/client-connect-connect-address-params.md
@@ -24,8 +24,8 @@ See [Client.close()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-
 | `ConnectParams.reflect`         | boolean         | Whether to use the [gRPC server reflection protocol](https://github.com/grpc/grpc/blob/master/doc/server-reflection.md) when connecting.                                            |
 | `ConnectParams.reflectMetadata` | object          | Object with key-value pairs representing custom metadata the user would like to add to the reflection request.                                                                      |
 | `ConnectParams.timeout`         | string / number | Connection timeout to use. Default timeout is `"60s"`. <br/> The type can also be a number, in which case k6 interprets it as milliseconds, e.g., `60000` is equivalent to `"60s"`. |
-| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to 0.                                                                                                       |
-| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to 0.                                                                                                          |
+| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to `grpc-go` default, which is 4MB.                                                                         |
+| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to `grpc-go` default, which is approximately 2GB.                                                              |
 | `ConnectParams.tls` (optional)  | object          | [TLS](#tls) settings of the connection. Defaults to `null`.                                                                                                                         |
 
 ## TLS

diff --git a/...48.x/javascript-api/k6-net-grpc/client/client-connect-connect-address-params.md b/...48.x/javascript-api/k6-net-grpc/client/client-connect-connect-address-params.md
@@ -24,8 +24,8 @@ See [Client.close()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-
 | `ConnectParams.reflect`         | boolean         | Whether to use the [gRPC server reflection protocol](https://github.com/grpc/grpc/blob/master/doc/server-reflection.md) when connecting.                                            |
 | `ConnectParams.reflectMetadata` | object          | Object with key-value pairs representing custom metadata the user would like to add to the reflection request.                                                                      |
 | `ConnectParams.timeout`         | string / number | Connection timeout to use. Default timeout is `"60s"`. <br/> The type can also be a number, in which case k6 interprets it as milliseconds, e.g., `60000` is equivalent to `"60s"`. |
-| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to 0.                                                                                                       |
-| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to 0.                                                                                                          |
+| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to `grpc-go` default, which is 4MB.                                                                         |
+| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to `grpc-go` default, which is approximately 2GB.                                                              |
 | `ConnectParams.tls` (optional)  | object          | [TLS](#tls) settings of the connection. Defaults to `null`.                                                                                                                         |
 
 ## TLS

diff --git a/...script-api/k6-experimental/grpc/client/client-connect-connect-address-params.md b/...script-api/k6-experimental/grpc/client/client-connect-connect-address-params.md
@@ -26,8 +26,8 @@ See [Client.close()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-
 | `ConnectParams.reflect`         | boolean         | Whether to use the [gRPC server reflection protocol](https://github.com/grpc/grpc/blob/master/doc/server-reflection.md) when connecting.                                            |
 | `ConnectParams.reflectMetadata` | object          | Object with key-value pairs representing custom metadata the user would like to add to the reflection request.                                                                      |
 | `ConnectParams.timeout`         | string / number | Connection timeout to use. Default timeout is `"60s"`. <br/> The type can also be a number, in which case k6 interprets it as milliseconds, e.g., `60000` is equivalent to `"60s"`. |
-| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to 0.                                                                                                       |
-| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to 0.                                                                                                          |
+| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to `grpc-go` default, which is 4MB.                                                                         |
+| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to `grpc-go` default, which is approximately 2GB.                                                              |
 | `ConnectParams.tls` (optional)  | object          | [TLS](#tls) settings of the connection. Defaults to `null`.                                                                                                                         |
 
 ## TLS

diff --git a/...49.x/javascript-api/k6-net-grpc/client/client-connect-connect-address-params.md b/...49.x/javascript-api/k6-net-grpc/client/client-connect-connect-address-params.md
@@ -24,8 +24,8 @@ See [Client.close()](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-
 | `ConnectParams.reflect`         | boolean         | Whether to use the [gRPC server reflection protocol](https://github.com/grpc/grpc/blob/master/doc/server-reflection.md) when connecting.                                            |
 | `ConnectParams.reflectMetadata` | object          | Object with key-value pairs representing custom metadata the user would like to add to the reflection request.                                                                      |
 | `ConnectParams.timeout`         | string / number | Connection timeout to use. Default timeout is `"60s"`. <br/> The type can also be a number, in which case k6 interprets it as milliseconds, e.g., `60000` is equivalent to `"60s"`. |
-| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to 0.                                                                                                       |
-| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to 0.                                                                                                          |
+| `ConnectParams.maxReceiveSize`  | number          | Sets the maximum message size in bytes the client can receive. Defaults to `grpc-go` default, which is 4MB.                                                                         |
+| `ConnectParams.maxSendSize`     | number          | Sets the maximum message size in bytes the client can send. Defaults to `grpc-go` default, which is approximately 2GB.                                                              |
 | `ConnectParams.tls` (optional)  | object          | [TLS](#tls) settings of the connection. Defaults to `null`.                                                                                                                         |
 
 ## TLS