WSO2 API Manager is a complete solution for publishing APIs, creating and managing a developer community and for routing API traffic in a scalable manner. It leverages the integration, security and governance components from the WSO2 Enterprise Service Bus, WSO2 Identity Server, and WSO2 Governance Registry. In addition, as it is powered by the WSO2 Business Activity Monitor (BAM), the WSO2 API Manager is ready for massively scalable deployments immediately.
...
- Log in to the API Publisher as
apicreator
if you are not logged in already. - Click on the
PhoneVerification
API and then the Copy button that appears in its Overview tab. Give a new version number (e.g., 2.0.0) and click Done.
Tip Tip: The Default Version option means that you make this version the default in a group of different versions of the API. A default API can be invoked without specifying the version number in the URL. For example, if you mark http://host:port/youtube/2.0 as the default version when the API has 1.0 and 3.0 versions as well, requests made to http://host:port/youtube/ get automatically routed to version 2.0.
If you mark any version of an API as the default, you get two API URLs in its Overview page in the API Store. One URL is with the version and the other is without. You can invoke a default version using both URLs.
If you mark an unpublished API as the default, the previous default, published API will still be used as the default until the new default API is published (or prototyped).
...
Do the following changes in
<APIM_HOME>/repository/conf/api-manager.xml
file:- Enable API usage tracking by setting the
<APIUsageTracking>
element to true - Set the Thrift port to 7614
- Uncomments and set the data source used for getting BAM statistics in
<DataSourceName>
element. - Set <BAMServerURL> to tcp://<BAM host IP>:7614/ where <BAM host IP> is the machine IP address. Do not use localhost unless you're in a disconnected mode.
Code Block language xml <APIUsageTracking> <!-- Enable/Disable the API usage tracker. --> <Enabled>true</Enabled> <PublisherClass>org.wso2.carbon.apimgt.usage.publisher.APIMgtUsageDataBridgeDataPublisher</PublisherClass> <ThriftPort>7614</ThriftPort> <BAMServerURL>tcp://<BAM host IP>:7614/</BAMServerURL> <BAMUsername>admin</BAMUsername> <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> </APIUsageTracking>
- Enable API usage tracking by setting the
Specify the datasource definition in
<APIM_HOME>/repository/conf/datasources/master-datasources.xml
file as follows.Code Block language 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> <!-- JDBC URL to query the database --> <url>jdbc:h2:<BAM_HOME>/repository/database/APIMGTSTATS_DB;AUTO_SERVER=TRUE</url> <username>wso2carbon</username> <password>wso2carbon</password> <driverClassName>org.h2.Driver</driverClassName> <maxActive>50</maxActive> <maxWait>60000</maxWait> <testOnBorrow>true</testOnBorrow> <validationQuery>SELECT 1</validationQuery> <validationInterval>30000</validationInterval> </configuration> </definition> </datasource>
Save the database driver JAR inside both
<AM_HOME>/repository/components/lib
and<BAM_HOME>/repository/components/lib
folders.Next, prepare BAM to collect and analyze statistics from API manager.
- Download WSO2 BAM 2.5.0 or later from location: http://wso2.com/products/business-activity-monitor.
Change port offset of BAM to 3 by editing the file
<BAM_HOME>/repository/conf/carbon.xml
file (search for the offset node).Code Block language html/xml <Offset>3</Offset>
This increments all ports used by the server by 3, which means the BAM server will run on port 9446. Port offset is used to increment the default port by a given value. It avoids possible port conflicts when multiple WSO2 products run in same host.
In
<BAM_HOME>/repository/conf/datasources/bam_datasources.xml
file, copy/pasteWSO2_AMSTATS_DB
definition from API Manager'smaster-datasources.xml
file. You edited it in step 2.In
<BAM_HOME>/repository/conf/data-bridge/data-bridge-config.xml
file, give the host name as localhost. If you are running BAM on a different server than where the API Manager runs on, give the IP address instead.Code Block <thriftDataReceiver> <hostName>localhost</hostName> <port>7611</port> <securePort>7711</securePort> </thriftDataReceiver>
Open
<BAM_HOME>/repository/conf/etc/hector-config.xml
file and change the port to localhost:9163 . This is because you incremented the BAM port by 3 in step 1.Code Block <Nodes externalCassandra="false">localhost:9163</Nodes>
Restart the BAM server by running
<BAM_HOME>/bin/wso2server.[sh/bat]
.
Let's see the statistics now.Generate some traffic via the API Gateway (invoke the Cdyne API we use in this guide) and wait a few seconds.
- Connect to the API Publisher as a creator or publisher.
In the publisher role, you are able to see all stats and as creator, you see stats specific to the APIs you create. - Click the Statistics menu. We show the sample statistics here, but you will see graphs specific to your instance.
- Similarly, API subscribers can also see statistics though the API Store. Click the Statistics menu as follows:
...