Step‑by‑Step Guide to Testing WebSocket APIs with JMeter

Prerequisites

API documentation that defines the request and response JSON formats for the WebSocket service.

Apache JMeter installed locally (download the appropriate .zip for Windows or .tgz for Linux from http://jmeter.apache.org/download_jmeter.cgi).

A JSON validation tool (e.g., https://www.sojson.com) to ensure payload correctness.

Installation

JMeter

Extract the downloaded archive to a directory, e.g., D:\jmeter\apache-jmeter-5.2, and launch jmeter.bat (Windows) or jmeter (Linux).

WebSocket Plugin

Download the JMeter Plugins Manager JAR (e.g., jmeter-plugins-manager-1.6.jar) from https://jmeter-plugins.org/install/Install/ and copy it to D:\jmeter\apache-jmeter-5.2\lib\ext. Start JMeter, open Options → Plugins Manager , locate the WebSocket Sampler under *Available Plugins*, select it, then click Apply Changes and Restart JMeter . An active internet connection is required for the plugin download.

Test Configuration

Create a Thread Group in the Test Plan. Adjust the *Number of Threads*, *Ramp‑up period*, and *Loop Count* according to the desired load.

Add a WebSocket Sampler under the Thread Group and configure the following fields:

Server : host or IP of the backend service.

Port : WebSocket listening port.

Request payload : JSON string that follows the API specification (e.g., a login request). Ensure nested JSON objects are properly escaped as strings.

Optionally add a View Results Tree listener to inspect responses.

Run the test by clicking the *Start* button.

Result Analysis

Open the *View Results Tree* after execution:

If the response code is 404, the request reached the server but the credentials were invalid; the sampler entry appears green.

When credentials are correct, the response body is displayed prominently (usually in green).

If an entry is red, the request failed—check network connectivity, port accessibility, and JSON syntax.

The same procedure can be reused for any WebSocket‑based API by adjusting the server address, port, and payload.

Additional Load‑Testing Considerations

Scale the *Number of Threads* to simulate concurrent users.

Set an appropriate *Ramp‑up period* to avoid sudden spikes.

Use the *Loop Count* or a Constant Throughput Timer** to control request frequency.

Validate network reachability (e.g., ping) and ensure the JSON payload matches the service’s expected format before running large‑scale tests.