Menu
Open source
Params
Caution
Starting on k6
v0.49
, the experimental modulek6/experimental/grpc
has been graduated, and its functionality is now available in thek6/net/grpc
module. Thek6/experimental/grpc
is deprecated and will be removed inv0.51.0
.To migrate your scripts, replace all
k6/experimental/grpc
imports withk6/net/grpc
.
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 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" . |
Example of custom metadata headers and tags
JavaScript
import grpc from 'k6/experimental/grpc';
const client = new grpc.Client();
client.load([], 'route_guide.proto');
export default function () {
const req = {
latitude: 410248224,
longitude: -747127767,
};
const params = {
metadata: {
'x-my-header': 'k6test',
'x-my-header-bin': new Uint8Array([1, 2, 3]),
},
tags: { k6test: 'yes' },
};
const response = client.invoke('main.RouteGuide/GetFeature', req, params);
}
Was this page helpful?
Related resources from Grafana Labs
Additional helpful documentation, links, and articles:
Video
Performance testing and observability in Grafana Cloud
In this webinar, learn how Grafana Cloud k6 offers you the best developer experience for performance testing.
User-centered observability: load testing, real user monitoring, and synthetics
Learn how to use load testing, synthetic monitoring, and real user monitoring (RUM) to understand end users' experience of your apps. Watch on demand.