Opens a connection to a gRPC server; will block until a connection is made or a connection error is thrown. Cannot be called during the init phase.
See Client.close() to close the connection.
Parameter | Type | Description |
---|---|---|
address | string | The address of the gRPC server. Should be in the form: host:port with no protocol prefix e.g. grpc.k6.io:443. The host must be a literal IP address, or a host name that can be resolved to IP addresses. The port must be a literal port number or a service name e.g. :443 or :https. If the host is a literal IPv6 address it must be enclosed in square brackets, as in [2001:db8::1]:80 or [fe80::1%zone]:80. |
params (optional) | object | ConnectParams object containing additional connect parameters. |
ConnectParams
Name | Type | Description |
---|---|---|
ConnectParams.plaintext | bool | If true will connect to the gRPC server using plaintext i.e. insecure. Defaults to false i.e. secure via TLS. |
ConnectParams.reflect | boolean | Whether to use the gRPC server reflection protocol 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". 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.tls (optional) | object | TLS settings of the connection. Defaults to null. |
TLS
TLS settings of the connection. If not defined, the main TLS config from options will be used.
Name | Type | Description |
---|---|---|
tls.cert | string | PEM formatted client certificate. |
tls.key | string | PEM formatted client private key. |
tls.password | string | Password for decrypting the client's private key. |
tls.cacerts | string / array | PEM formatted strings of the certificate authorities. |