Performance Testing:Perform performance testing on WebSocket

This section describes how to add and configure samplers in a test scenario. This section is only for reference. You can add and configure samplers based on your business requirements.

1. Right-click Test Plan and choose Add > Thread (Users) > Thread Group to add a thread group to the test plan.

2. In the Thread Group pane, add and configure samplers in sequence. The following table describes the samplers.

   Sampler	Description
   WebSocket Open Connection	Initiates a WebSocket connection.
   WebSocket Ping/Pong	Sends ping frames and receives pong frames.
   WebSocket request-response Sampler	Sends and receives WebSocket frames of the text and binary types.
   WebSocket Single Write Sampler	Sends WebSocket frames of the text and binary types.
   WebSocket Single Read Sampler	Receives WebSocket frames of the text and binary types.
   WebSocket Close	Closes the WebSocket connection.

   1. Right-click Thread Group and choose Add > Sampler > WebSocket Open Connection.

      

      Note

      In the Server URL section, configure the service that you want to test. In this example, a simple WebSocket service that is built by using an SDK for Python is used. The WebSocket service is an Echo service, and all messages sent to this service are echoed to the client.

      server.py sample code

      import asyncio
      import websockets
      
      async def echo(websocket, path):
          async for message in websocket:
              message = "Your message: {}".format(message)
              await websocket.send(message)
      
      asyncio.get_event_loop().run_until_complete(websockets.serve(echo, '0.0.0.0', 8080))
      asyncio.get_event_loop().run_forever()

   2. Right-click Thread Group and choose Add > Sampler > WebSocket Ping/Pong.

      

      Note

      Set the Pong (read) timeout (ms) parameter to 6000.

      This configuration indicates that if Apache JMeter does not receive a pong message within 6,000 milliseconds, the sampler fails. In this case, the sampler reuses the existing connection.

   3. Right-click Thread Group and choose Add > Sampler > WebSocket request-response Sampler.

      Parameter	Example value	Description
      Connection	use existing connection	Specifies whether to establish a new connection or reuse an existing connection.
      Data type	Text	The type of the data.
      Request data	PTS	The request data. In this example, the text data is used.
      Response (read) timeout (ms)	6000	The timeout period for a response.

   4. Right-click Thread Group and choose Add > Sampler > WebSocket Single Write Sampler. WebSocket Single Write Sampler is a non-blocking sampler. The sampler is used only to send data to the server and does not wait for a response.

      Parameter	Example value	Description
      Connection	use existing connection	Specifies whether to establish a new connection or reuse an existing connection.
      Data type	Text	The type of the data.
      Request data	PTS bang bang bang	The request data. In this example, the text data is used.

   5. Right-click Thread Group and choose Add > Sampler > WebSocket Single Read Sampler. WebSocket Single Read Sampler is used only to receive responses.

      Parameter	Example value	Description
      Connection	use existing connection	Specifies whether to establish a new connection or reuse an existing connection.
      Data type	Text	The type of the data.
      Response (read) timeout (ms)	6000	The timeout period for a response.

   6. Right-click Thread Group and choose Add > Sampler > WebSocket Close. WebSocket Close is used to close the existing WebSocket connection based on negotiation. The response message is 1000:sampler requested close.

      Parameter	Example value	Description
      Close status	1000	The status code, which is the first two bytes of the data frame that is sent when the connection is closed.
      Response (read) timeout (ms)	6000	The timeout period for a response.

3. Optional. If you want to add headers, such as tokens, during the communication, click Thread Group and choose Add > ConfigElement > HttpHeaderManager. Add the HttpHeaderManager element to the thread group and then add the headers. For more information, see the Apache JMeter documentation.

4. Right-click Thread Group and choose Add > Listener > View Results Tree to add the View Results Tree listener to the thread group.

After you write the script, click the Start button on the top of the page to run the script.

Check whether the script runs as expected by using the View Results Tree listener. On the View Results Tree page, if a green check mark is displayed before a sampler, the sampler runs as expected. If the running of a sampler fails, debug the script based on Create a script.

The following figures show the script configurations of different samplers.

1. WebSocket request-response Sampler

   The following figure shows the request information in the script.

   The following figure shows the response data in the script when Text is selected as the data type.

2. WebSocket Single Read Sampler

   The following figure shows the response data in the script when Text is selected as the data type.

After the script is debugged, choose File > Save Test Plan as in the top navigation bar to save the script file to the on-premises machine. In this example, name the file wsTest.jmx.

1. Log on to the PTS console, choose Performance Test > Create Scenario, and then click JMeter.

2. Configure the scenario.

   1. Specify the scenario name and upload the wsTest.jmx file that you exported.

   2. After you upload the script file, PTS automatically supplements the plug-in. If the supplementation fails, click Upload File to add the downloaded JAR package (JMeterWebSocketSamplers-1.2.10.jar) and other data files, such as parameter files in the CSV format.

3. Configure stress settings.

   Set the Max VUs parameter to 10 and the Test Duration and Increment Duration parameters to 2 minutes. Retain the default values for other parameters. You are charged for performance testing. We recommend that you configure the load level based on your business requirements. For more information, see Billing overview and Configure the stress testing model and level.

4. Debug and start performance testing.

   1. Recommended. Debug the scenario to verify the configurations. This helps prevent performance testing failures. For more information, see Debug a stress testing scenario.

   2. Click Save and Test. On the Tips page, select Trigger Now and Make sure that the test is approved and complies with local laws, and then click Start Stress Testing.