Menu
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.
Parameter | Type | Description |
---|---|---|
url | string | The URL to which to connect (e.g. “ws://localhost:10000”). |
protocols | array | Not yet implemented, reserved for the future use. |
params | object | Params object containing additional request parameters. |
Returns
Type | Description |
---|---|
WebSocket | An 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
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.