Setting up monitoring outgoing message from WSO2 API Manager with TCPMon

There will be some requirements that need to monitor the outgoing message from WSO2 API Manager to real back-end endpoint.For example monitor JWT token value as explained in here.

This blog-post describes how to add TCPMon monitoring in between WSO2 AM and real endpoint.In a diagram,below is how we going to setup TCPMon with WSO2 AM and endpoint.

In other words,it means that the messages from WSO2 APIM should go to real endpoint via TCPMon tool.

Say,real back-end endpoint is a web-service running in WSO2 Application Server[WSO2 AS] called 'echo'.

The web-service endpoint will be as http://10.200.1.30:9763/echo

When you create an API from WSO2 API Manager,you have to give the 'Production URL' of Add API page in APIPublisher app pointing to above 'echo' web service endpoint as below.

But,if you need to place TCPMon in-between WSO2 APIM and WSO2 AS ,that means you need to direct messages from WSO2 APIM to WSO2 AS via TCPMon tool.

Thus first start TCPMon.You can do this by executing tcpmon.sh script which can be found from WSO2 Products bin directories or by running TCPMon externally.\

Define a listen port for TCPMon [here 8085] and then define the listener target hostname and port values as the back-end endpoint hostname[10.200.1.30] and port values[9763].

Then edit the 'Production URL' of the created API from WSO2 API Manager by changing its hostname and port values to map with TCPMon running hostname[localhost] and its defined listen port [8085] value.Hence as per above set TCPMon,the production URL of the API would be;

http://localhost:8085/echo

Once done above changes,try invoking the created API.You will able to monitor the request and response flow in between APIManager and real endpoint [App Server].