Params

suggest edits

Params is an object used by the WebSocket constructor. The Params object contains request-specific options, such as headers that should be inserted into the connection initialization request.

Name	Type	Description
Params.compression	string	Compression algorithm to be used by the WebSocket connection. The only supported algorithm currently is deflate.
Params.jar	http.CookieJar	The cookie jar that will be used when making the initial HTTP request to establish the WebSocket connection. If empty, the default VU cookie jar will be used.
Params.headers	object	Custom HTTP headers in key-value pairs that will be added to the initial HTTP request to establish the WebSocket connection. Keys are header names and values are header values.
Params.tags	object	Custom metric tags in key-value pairs where the keys are names of tags and the values are tag values. The WebSocket connection will generate metrics samples with these tags attached, allowing users to filter the results data or set thresholds on sub-metrics.

Example of custom metadata headers and tags

A k6 script that makes a WebSocket request with a custom header and tags results data with a specific tag

import { WebSocket } from 'k6/experimental/websockets';

export default function () {
  const url = 'ws://localhost:10000';
  const params = {
    headers: { 'X-MyHeader': 'k6test' },
    tags: { k6test: 'yes' },
  };

  const ws = new WebSocket(url, null, params);

  ws.onopen = () => {
    console.log('WebSocket connection established!');
    ws.close();
  };
}

The preceding example uses a WebSocket echo server, which you can run with the following command:

$ docker run --detach --rm --name ws-echo-server -p 10000:8080 jmalloc/echo-server

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

Params

Example of custom metadata headers and tags

Product

Resources

Community

About