Menu
Open source
Socket.ping()
Note
A module with a better and standard API exists.
The new k6/experimental/websockets API partially implements the WebSockets API living standard.
When possible, we recommend using the new API. It uses a global event loop for consistency with other k6 APIs and better performance.
Send a ping. Ping messages can be used to verify that the remote endpoint is responsive.
Example
JavaScript
import ws from 'k6/ws';
export default function () {
const url = 'ws://echo.websocket.org';
const response = ws.connect(url, null, function (socket) {
socket.on('open', function () {
socket.on('pong', function () {
// As required by the spec, when the ping is received, the recipient must send back a pong.
console.log('connection is alive');
});
socket.ping();
});
});
}
Was this page helpful?
Related documentation
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.