First let me introduce to the servers
WSO2 API Manager is a complete solution for designing and publishing APIs, creating and managing a developer community, and for scalably routing API traffic. It leverages proven, production-ready integration, security, and governance components from the WSO2 Enterprise Service Bus, WSO2 Identity Server, and WSO2 Governance Registry. In addition, it leverages the WSO2 Business Activity Monitor for Big Data analytics, giving you instant insight into APIs behavior.
WSO2 Complex Event Processor identifies the most meaningful events within the event cloud of an organization, analyzes their impacts, and acts on them in real time. Built to be extremely high performing and massively scalable, it offers significant time saving and affordable acquisition.
WSO2 Business Activity Monitor (BAM) is designed to address a wide range of monitoring requirements in business activities and processes. It is a flexible framework allowing to model your own key performance indicators to suit different stakeholders, may it be business users, dev ops, CxOs etc. WSO2 BAM achieves this level of flexibility, while facilitating technologies such as Big Data storage, Big Data analytics and high performance data transfer.
Now with the three identified components let me explain what I am going to do...
I am going to publish the API Manager API invocation statistics to WSO2 Business Activity Monitor through WSO2 Complex Event Processor where Complex Event Processor will send a mail to a given e-mail address if there is a matching pattern of the events. In this post I am taking the matching pattern as, "user invokes an API 5 times within a minute".
In order to do this first we need to do some configuration to each server.
API Manager
Configure the analysed statistics database (BAM API statistic database) for API Manager.
File : $AM_HOME/repository/conf/datasources/master-datasources.xml
<datasource>
<name>WSO2AM_STATS_DB</name>
<description>The datasource used for getting statistics to API Manager</description>
<jndiConfig>
<name>jdbc/WSO2AM_STATS_DB</name>
</jndiConfig>
<definition type="RDBMS">
<configuration>
<url>jdbc:mysql://localhost:3306/apimstat?autoReconnect=true&relaxAutoCommit=true</url>
<username>root</username>
<password>root</password>
<driverClassName>com.mysql.jdbc.Driver</driverClassName>
<maxActive>50</maxActive>
<maxWait>60000</maxWait>
<testOnBorrow>true</testOnBorrow>
<validationQuery>SELECT 1</validationQuery>
<validationInterval>30000</validationInterval>
</configuration>
</definition>
</datasource>
Configure statistic publishing host/port (CEP) and analysed statistic datasource.
File : $AM_HOME/repository/conf/api-manager.xml
<APIUsageTracking>
<!--
Enable/Disable the API usage tracker.
-->
<Enabled>true</Enabled>
<!--
API Usage Data Publisher.
-->
<PublisherClass>org.wso2.carbon.apimgt.usage.publisher.APIMgtUsageDataBridgeDataPublisher</PublisherClass>
<!--
Thrift port of the remote BAM server.
-->
<ThriftPort>7613</ThriftPort>
<!--
Server URL of the remote BAM/CEP server used to collect statistics. Must
be specified in protocol://hostname:port/ format.
An event can also be published to multiple Receiver Groups each having 1 or more receivers. Receiver
Groups are delimited by curly braces whereas receivers are delimited by commas.
Ex - Multiple Receivers within a single group
tcp://localhost:7612/,tcp://localhost:7613/,tcp://localhost:7614/
Ex - Multiple Receiver Groups with two receivers each
{tcp://localhost:7612/,tcp://localhost:7613},{tcp://localhost:7712/,tcp://localhost:7713/}
-->
<BAMServerURL>{tcp://localhost:7612/},{tcp://localhost:7613/}</BAMServerURL>
<!--
Administrator username to login to the remote BAM server.
-->
<BAMUsername>admin</BAMUsername>
<!--
Administrator password to login to the remote BAM server.
-->
<BAMPassword>admin</BAMPassword>
<!--
JNDI name of the data source to be used for getting BAM statistics.This data source should
be defined in the master-datasources.xml file in conf/datasources directory.
-->
<DataSourceName>jdbc/WSO2AM_STATS_DB</DataSourceName>
<!--
Google Analytics publisher configuration. Create Google Analytics account and obtain a
Tracking ID.
Reffer http://support.google.com/analytics/bin/answer.py?hl=en&answer=1009694
-->
<GoogleAnalyticsTracking>
<!--
Enable/Disable Google Analytics Tracking
-->
<Enabled>false</Enabled>
<!--
Google Analytics Tracking ID
-->
<TrackingID>UA-XXXXXXXX-X</TrackingID>
</GoogleAnalyticsTracking>
</APIUsageTracking>
[NOTE] When we specifying the BAMServerURL we have specified two URLs, first one is the BAM server URL and the second one is the CEP server URL where we need to send the statistics to both CEP and BAM.
CEP
Setting offset to 2
This is if you are running all the servers in the same machine to avoid the port conflict.
File :$CEP_HOME/repository/conf/carbon.xml
<!-- Ports offset. This entry will set the value of the ports defined below to
the define value + Offset.
e.g. Offset=2 and HTTPS port=9443 will set the effective HTTPS port to 9445
-->
<Offset>2</Offset>
Configuring mail transport
File :$CEP_HOME/repository/conf/axis2/axis2_client.xml
<!--please change the mail configuration, wso2cep.demo@gmail.com is provided for demo purposes only-->
<transportSender name="mailto"
class="org.apache.axis2.transport.mail.MailTransportSender">
<parameter name="mail.smtp.from">eranda@gmail.com</parameter>
<parameter name="mail.smtp.user">eranda</parameter>
<parameter name="mail.smtp.password">eranda@123</parameter>
<parameter name="mail.smtp.host">smtp.gmail.com</parameter>
<parameter name="mail.smtp.port">587</parameter>
<parameter name="mail.smtp.starttls.enable">true</parameter>
<parameter name="mail.smtp.auth">true</parameter>
</transportSender>
BAM
This is if you are running all the servers in the same machine to avoid the port conflict.
File :$BAM_HOME/repository/conf/carbon.xml
<!-- Ports offset. This entry will set the value of the ports defined below to
the define value + Offset.
e.g. Offset=2 and HTTPS port=9443 will set the effective HTTPS port to 9445
-->
<Offset>1</Offset>
Configuring port offsets
Following two configurations are not changed with the offset and you need to manually change them with the offset (Eg. port + offset)
File : $BAM_HOME/repository/conf/datasources/bam-datasources.xml
<datasource>
<name>WSO2BAM_CASSANDRA_DATASOURCE</name>
<description>The datasource used for Cassandra data</description>
<definition type="RDBMS">
<configuration>
<url>jdbc:cassandra://localhost:9161/EVENT_KS</url>
<username>admin</username>
<password>admin</password>
</configuration>
</definition>
</datasource>
File : $BAM_HOME/repository/conf/etc/hector-config.xml
<hectorconfiguration>
<cluster>
<name>ClusterOne</name>
<!-- Node list of Cassandra cluster should be specified as a comma separated list
eg. <nodes>192.168.0.2:9160,192.168.0.3:9160,192.168.0.4:9160</Nodes> -->
<nodes>localhost:9161</nodes>
<!-- Set 'false' to enable autodiscovery of nodes on the ring at startup
and at intervals (i.e. delay property) thereafter -->
<autodiscovery delay="1000" disable="false">
</autodiscovery></cluster>
</hectorconfiguration>
Configure the analysed statistics database.
This datasource configuration should be as same as the datasource you defined in the API Manager.
File : $BAM_HOME/repository/conf/datasources/master-datasources.xml
<datasource>
<name>WSO2AM_STATS_DB</name>
<description>The datasource used for getting statistics to API Manager</description>
<jndiConfig>
<name>jdbc/WSO2AM_STATS_DB</name>
</jndiConfig>
<definition type="RDBMS">
<configuration>
<url>jdbc:mysql://localhost:3306/apimstat?autoReconnect=true&relaxAutoCommit=true</url>
<username>root</username>
<password>root</password>
<driverClassName>com.mysql.jdbc.Driver</driverClassName>
<maxActive>50</maxActive>
<maxWait>60000</maxWait>
<testOnBorrow>true</testOnBorrow>
<validationQuery>SELECT 1</validationQuery>
<validationInterval>30000</validationInterval>
</configuration>
</definition>
</datasource>
Copying BAM tool box for API statistics analys.
Copy this $AM_HOME/statistics/API_Manager_Analytics.tbox toolbox into the "$BAM_HOME/repository/deployment/server/bam-toolbox/" directory.
Now you can follow the following steps to test the setup.
1. Login to the API Manager. Create and publish an API. Subscribe to it and invoke.
2. Stats should have shown in APIM stats page.
References :
