API Manager Analytics

Question

We are working on a solution built on top of WSO2 APIM.

Problem Statement:

We want to add custom capability in existing APIM. Right now if we consume a single api endpoint it gives us meaningful statics some of them are:

• API Usage API
• API Usage per Application
• Top Users per Application
• Resource Usage per Application

But what we need is to store some/all incoming request data into database and extract meaningful information over time.

Example:

Suppose we have a api endpoint like below:

HTTP-Verb: POST

URL: http://localhost:9444/subscriptions/1/create_subscription

Params: name:sample_name, type:sample_type, user_id:12345

What we want?

• It could be WSO2, OpenAM or any other opensource API manager.
• We need to store parameter values e.g. sample_name, sample_type and user_id in database.

Observations?

• Looks like WSO Stream Processor can provide this functionality. As it has a solution for HTTP Analytics. But we are not certain to proceed with this option.
• Another possible candidate is to Extend API Manager. But docs doesn't have anything to target what we wanted to do.
• I am not sure but we can use RequestInterceptor?

Anyone has a experience with this kind of problem please let me know.

Answer 1

There are two problems you have to solve here, 1. Capture the required data from the APIM side 2. Publish to Analytics Server 3. Perform Analytics on received events

As you have observed WSO2 SP can be used for 3.

For 1 & 2, please see blog (https://medium.com/@naduni_pamudika/how-to-publish-custom-attributes-from-wso2-api-manager-to-wso2-analytics-38dd83e8aea2) for extending the publishers to capture and publish additional data.

Answer 2

You can also take a look at OpenIG, it is easy to extend and you can implement your own filter to store request data in database. Another approach is develop your own gateway based on Netflix Zuul or Spring Cloud Gateway