This is documentation for the next version of Grafana k6 documentation. For the latest stable release, go to the latest version.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow k6/x/mqttbreadcrumb arrow Clientbreadcrumb arrow Client.subscribeAsync( topic, [options] )
Open source

Client.subscribeAsync()

Subscribe to topics asynchronously. Returns a promise that resolves when the subscription is complete.

Signature

JavaScript 
await client.subscribeAsync(topic, options)

Parameters

ParameterTypeDescription
topicstring | string[]Topic or array of topics to subscribe to
optionsobjectOptional subscription configuration
options.qosnumberQuality of Service level (0, 1, or 2). Default: 0
options.tagsobjectCustom tags for metrics (key-value pairs)

Returns

A promise that resolves when the subscription is successfully completed.