k6/net/grpc

The k6/net/grpc module, added in k6 v0.29.0, provides a gRPC client for Remote Procedure Calls (RPC) over HTTP/2.

warning
The k6 gRPC API is currently considered in beta and is subject to change. Future k6 versions might have slight differences in the method and type signatures described in this documentation.

Class/Method	Description
Client	gRPC client used for making RPC calls to a gRPC Server.
Client.load(importPaths, ...protoFiles)	Loads and parses the given protocol buffer definitions to be made available for RPC requests.
Client.connect(address [,params])	Connects to a given gRPC service.
Client.invoke(url, request [,params])	Makes an unary RPC for the given service/method and returns a Response.
Client.close()	Close the connection to the gRPC service.
Params	RPC Request specific options.
Response	Returned by RPC requests.
Constants	Define constants to distinguish between gRPC Response statuses.

Example

import grpc from 'k6/net/grpc';
import { check, sleep } from 'k6';

const client = new grpc.Client();
client.load(['definitions'], 'hello.proto');

export default () => {
  client.connect('grpcb.in:9001', {
    // plaintext: false
  });

  const data = { greeting: 'Bert' };
  const response = client.invoke('hello.HelloService/SayHello', data);

  check(response, {
    'status is OK': (r) => r && r.status === grpc.StatusOK,
  });

  console.log(JSON.stringify(response.message));

  client.close();
  sleep(1);
};

Init context

k6

k6/crypto

k6/data

k6/encoding

k6/execution

k6/experimental

k6/html

k6/http

k6/metrics

k6/net/grpc

k6/ws

Error Codes

k6/net/grpc

Example

Product

Resources

Community

About