Menu
Open source
WebSocket.ping()
Send a ping. You can use ping messages to verify that the remote endpoint is responsive.
Example
A k6 script that initiates a WebSocket connection, sends a ping, and closes it using the onopen
handler. The console should log connection is alive
, since the recipient should automatically emit the pong
event.
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.ping();
ws.close();
};
ws.onpong = () => {
// As required by the spec, when the ping is received, the recipient must send back a pong.
console.log('connection is alive');
};
}
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 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.