No results for

Powered byAlgolia
⚠️ This is the archived documentation for k6 v0.46. Go to the latest version.

Client.connect(address [,params])

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.

ParameterTypeDescription
addressstringThe 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)objectConnectParams object containing additional connect parameters.

ConnectParams

NameTypeDescription
ConnectParams.plaintextboolIf true will connect to the gRPC server using plaintext i.e. insecure. Defaults to false i.e. secure via TLS.
ConnectParams.reflectbooleanWhether to use the gRPC server reflection protocol when connecting.
ConnectParams.timeoutstring / numberConnection 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.maxReceiveSizenumberSets the maximum message size in bytes the client can receive. Defaults to 0.
ConnectParams.maxSendSizenumberSets the maximum message size in bytes the client can send. Defaults to 0.
ConnectParams.tls (optional)objectTLS 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.

NameTypeDescription
tls.certstringPEM formatted client certificate.
tls.keystringPEM formatted client private key.
tls.passwordstringPassword for decrypting the client's private key.
tls.cacertsstring / arrayPEM formatted strings of the certificate authorities.

Examples

import grpc from 'k6/experimental/grpc';
const client = new grpc.Client();
export default () => {
client.connect('localhost:8080');
};
import grpc from 'k6/experimental/grpc';
const client = new grpc.Client();
export default () => {
client.connect('localhost:8080', { plaintext: true });
};
import grpc from "k6/experimental/grpc";
import { check } from "k6";
import { SharedArray } from "k6/data";
import exec from "k6/execution";
// note: the services in this example don't exist. If you would like
// to run this example, make sure to replace the URLs, and
// the cacerts, cert, key, and password variables.
const grpcArgs = new SharedArray("grpc", () => {
// Using SharedArray here so that not every VU gets a copy of every certificate a key
return [
{
host: "foo1.grpcbin.test.k6.io:9001",
plaintext: false,
params: {
tls: {
cacerts: [open("cacerts0.pem")],
cert: open("cert0.pem"),
key: open("key0.pem"),
},
},
},
{
host: "foo2.grpcbin.test.k6.io:9002",
params: {
plaintext: false,
tls: {
cacerts: open("cacerts1.pem"),
cert: open("cert1.pem"),
key: open("key1.pem"),
password: "cert1-passphrase",
},
},
},
];
});
const client = new grpc.Client();
export default () => {
if (__ITER === 0) {
// Take one config and use it for this one VU
const grpcArg = grpcArgs[exec.vu.idInTest % grpcArgs.length];
client.connect(grpcArg.host, grpcArg.params);
}
const response = client.invoke("hello.HelloService/SayHello", {
greeting: "Bert",
});
check(response, {
"status is OK": (r) => r && r.status === grpc.StatusOK,
});
console.log(JSON.stringify(response.message));
};