Socket is a WebSocket client to interact with a WebSocket connection. You can use it to listen various events happening on the WebSocket connection and send messages to the server. Additionally, you can use socket.setTimeout() and socket.setInterval() to execute code in the background, or repeatedly, while the WebSocket connection is open.
|Socket.close()||Close the WebSocket connection.|
|Socket.on(event, callback)||Set up an event listener on the connection for any of the following events:|
|Socket.ping()||Send a ping.|
|Socket.send(data)||Send string data.|
|Socket.sendBinary(data)||Send binary data.|
|Socket.setInterval(callback, interval)||Call a function repeatedly at certain intervals, while the connection is open.|
|Socket.setTimeout(callback, period)||Call a function with a delay, if the connection is open.|
WebSocket built-in metrics
k6 will automatically collect some metrics when interacting with a WebSocket service through the k6/ws API.
|ws_connecting||Trend||Total duration for the WebSocket connection request.|
|ws_session_duration||Trend||Duration of the WebSocket session. Time between the start of the connection and the end of the VU execution.|
|ws_sessions||Counter||Total number of started WebSocket sessions.|
|ws_ping||Trend||Duration between a ping request and its pong reception|
|ws_msgs_sent||Counter||Total number of messages sent through Socket.send(data)|
|ws_msgs_received||Counter||Total number of received messages Socket.on('message', callback).|
Check out the Results output article for more information about how to process the metric information.