Skip to main content

WSO2 APIManager integration with WSO2 BAM


From this blog-post,I'm going to dig into the implementation of monitoring support provide by WSO2 API Manager with WSO2 BAM integration.First you need to know how to configure WSO2 AM with BAM to start with.You can find about the related configuration details from our product documentation. 
However,before continue with this post,I think its better if I explain one step of above configuration.It's the AM Stats toolbox[API_Manager_Analytics.tbox] deployment in BAM server.This toolbox can be found from {AM_Home}/Statistics folder.A toolbox can be defined as an installable archive in BAM[1].This AM Stats toolbox contains below artifacts.
  • Stream Definitions -These are the descriptions of streams of data to be sent to WSO2 BAM in order to perform analytics.
  • Analytics-Analytics include the hive scripts to be deployed in WSO2 BAM.
Below diagram shows the main flow of the integration between WSO2 API Manager and WSO2 BAM.I will go through each step by step.


[1] Once a user trying to invoke a published API,the request will go through the engaged API handlers for that specific API as explained in here.

[2] The request will hit APIUsageHandler implementation class and once you configured AM server with enabling BAM monitoring support.

[3] From this handler implementation,it'll direct to Usage Publisher implementation in order to create an event from the request and  push that event to BAM side.Note that from AM side,three types of events will be  push in to BAM server as listed below.
  • An event with successful API invocation request
  • An event with fault API invocation request
  • An event with API response
[4] Once such event received from BAM side,first it check the sent event matched with defined stream definition in AM stats toolbox deployed in BAM server.There are three pre-defined stream definitions can be found from AM Stats toolbox as mentioned below.
  • requestStreamDefn
  • faultStreamDefn
  • responseStreamDefn
If the event matches,that event will stored in local Cassandra data store and else an error will thrown.

[5] Then with BAM inbuilt analyzer engine support,by using the relevant analyzer script [hive script],which can be found from AM Stats toolbox,the data in local Cassandra space will be analyzed and populate to relational database tables.

[6] Next with Usage Client implementation of WSO2 APIManager,that created BAM side relational database will be directly accessed and retrieve data from the db tables,by querying them.

[7] Then from API Publisher UI,those queried data will be pulled out and shown them in pre-defined graphs.

[8] Once an API Creator logged into publisher UI,he can view the statitics related to his created API.

[9] Additionally since the graphs defined in publisher UI is limited,a user can directly use the BAM node to show stats from gadgets in BAM dashboard as explained in here or either generate pre-defined/custom reports from the stored data as explained here.

 References

 [1] http://docs.wso2.org/wiki/display/BAM200/Introduction+to+BAM+Toolbox

Comments

Post a Comment

Popular posts from this blog

Passing end-user details from client to real backend endpoint via JWT token

In real-world business system,WSO2 API Manager useful on exposing company APIs, in a secured and controlled manner with the features provided by APIManager as; OAuth support [To secure API invocations] Throttling support [To control API invocations] Monitoring support [To track API usage] More technically what happening is when a user sends a particular API request,it will goes to WSO2 APIManager node and from there,the request will route to the real implemented back-end endpoint of the particular API and get back the response and returned it to the API invoked user. There can be a use-case,that this back-end endpoint may expect the details of API invoked user as to pass those details to some internal company usage  as; Additional authentication/authorization Track usage data from an internal system. So how to support above requirement from WSO2 AM. There comes the use of JSON Web Token[JWT] implementation done inside WSO2 AM. JWT is a means of representing claims to...
7 comments
Read more

How to rollback/commit processing messages from WSO2 ESB when enabled JMS transaction

This blog post describes the below use-case where WSO2 ESB 4.6.0 act as the intermediate channel in-between two JMS queues. The Use-case First messages will be de-queue to a proxy service deployed in WSO2 ESB from an queue in ActiveMQ message broker. Then inside ESB,the incoming messages will undergo with some message mediation flow and then the message will be send to another JMS queue deployed in JBoss server. Inside the ESB,following failures could be happen;            a) Failures during message mediation process failure inside ESB [for example if you                use   dbreportmediator/lookup mediator inside mediation flow,some times failures can                happen due  to database connection failures]          b) Message sending failure,due to endpoint is unavailability.[For example,the JBoss  ...
4 comments
Read more

TPP Journey through WSO2 Open Banking

Introduction 2018 is all set to be a game-changing year for European banking. The Revised Payment Services Directive (PSD2) has opened the door to new third party providers [TPPs] to connect with banks and manage finances of bank customers on behalf of them. The PSD2 regulation has mandated banks to expose their core-banking account data and payment services to authorized TPPs to consume. Thus as a bank it’s essential to have a solution which will securely expose their internal banking services to third party providers in a trusted manner. WSO2 Open Banking solution provides all required components to expose bank APIs in a well secured manner in order to become PSD2 compliant. This article explains about the importance of the TPP role in PSD2 domain, the requirements set that banks need to provide for TPPs by PSD2 regulations and how WSO2 Open Banking solution supports these requirements.  From my last blog ,I have given an introduction for PSD2 and WSO2 Open Banking soluti...
4 comments
Read more