Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow websocketsbreadcrumb arrow WebSocket
Open source

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
JavaScript 
import { WebSocket } from 'k6/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
Bash 
docker run --detach --rm --name ws-echo-server -p 10000:8080 jmalloc/echo-server