Monitoring APIs With TcpMon

Applies to ReadyAPI 3.10, last modified on October 07, 2021

You can use Apache TCPmon to monitor, record, analyze, and even modify SOAP traffic as it is transferred between an existing client and server application. It also supports WS-Security and SSL decryption if you have all the necessary keystores available for analyzing encrypted messages.

How Monitoring Works

To capture messages, Apache TcpMon acts as an explicit intermediary between the service and the client. To record requests, you send them to Apache TcpMon instead of sending the requests directly to the target service.

Apache TcpMon logic

Click the image to enlarge it.

The monitor displays logged messages in the table at the top and shows selected message details at the bottom, including all the advanced views and inspectors available in the standard message editors. You can filter entries by using different combo boxes on the toolbar.

Using TcpMon in ReadyAPI

ReadyAPI provides TcpMon as a built-in utility. You do not need to download it.

To start TcpMon:

  1. Right-click the SOAP interface in the Navigator and select Launch TcpMon.

    Launching TcpMon
  2. In the follow-up dialog, select the endpoint your service runs on in the Endpoint drop-down list. Then, specify an empty local port for TcpMon to be used. We also recommend selecting the Add local endpoint option to create an endpoint pointing towards the TcpMon listener. Click Launch.

    The Launch TcpMon dialog

    Click the image to enlarge it.

ReadyAPI will start TcpMon with a configured listener. ReadyAPI will record the requests you send to TcpMon and send them to the target service.

Recording requests with TcpMon

Click the image to enlarge it.

For details about configuring TcpMon, see the Apache documentation.

See Also


Highlight search results