Menu

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

DocumentationGrafana k6JavaScript APIk6/experimentalwebsocketsWebSocket
Open source RSS

WebSocket

Creates a WebSocket instance for connection to a remote host.

The following events can close the connection:

  • remote host close event.
  • WebSocket.close().
  • k6 VU interruption based on test configuration or CLI commands.
ParameterTypeDescription
urlstringThe URL to which to connect (e.g. “ws://localhost:10000”).
protocolsarrayNot yet implemented, reserved for the future use.
paramsobjectParams object containing additional request parameters.

Returns

TypeDescription
WebSocketAn instance of WebSocket object.

Example

A k6 script that initiates a WebSocket connection.

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

export default function () {
  const ws = new WebSocket('ws://localhost:10000');

  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:

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