This documentation is for WSO2 API Manager 1.8.0 View documentation for the latest release.
Page Comparison - Publishing API Runtime Statistics (v.31 vs v.36) - API Manager 1.8.0 - WSO2 Documentation

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. Do the following changes in <APIM_HOME>/repository/conf/api-manager.xml file:

    • Enable API usage tracking by setting the <APIUsageTracking> element to true.
    • Because you will apply an offset to the default BAM port later in this guide, you need to apply the same offset to the default Thrift port. To do that, change the port value to 7614 in the <ThriftPort> element of this file. The API Manager will then push the data to BAM through port 7614, using the Thrift protocol.
    • Uncomments Uncomment 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.


      <BAMServerURL> refers to the endpoint to which events will be published from the API Gateway. This endpoint is also known as the event receiver. You can define multiple event receiver groups, each with one or more receivers. A receiver group is defined within curly braces and receiver URLs are delimited by commas.

      For example, <BAMServerURL>{tcp://localhost:7612/,tcp://localhost:7613/},{tcp://localhost:7712/,tcp://localhost:7713/}</BAMServerURL>. This example has two receiver groups defined with two receivers in each group. When a request passes through the API Gateway, an event will be published to one selected receiver in each group.

    Code Block
        <!-- Enable/Disable the API usage tracker. -->
        <BAMServerURL>tcp://<BAM host IP>:7614/</BAMServerURL>
        <!-- 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. -->

    Tip: You can give a comma-separated list of URLs as the <BAMServerURL> to manage failover. If the BAM server in the first URL fails, the request will be routed to the second one.


    Tip: Are you working with an API Manager cluster? If so, 

    • Configure the <APIUsageTracking> element as given above in all API Gateway nodes
    • Configure the following sub elements under the <APIUsageTracking> element in the API Publisher and Store nodes:

      Code Block
    • If you use destination-based usage tracking, enable the <APIUsageTracking> element in the Publisher node and connect to a running BAM instance. This is because the API Manager uses a separate BAM mediator to do destination based usage tracking. 

  2. Specify the datasource definition under the <datasource> element in the <APIM_HOME>/repository/conf/datasources/master-datasources.xml file. The tables are created automatically when the Hive script runs. You just need to create the schemadatabase. The example below connects to a MySQL instance:

    Code Block
        <description>The datasource used for getting statistics to API Manager</description>
        <definition type="RDBMS">
                <validationQuery>SELECT 1</validationQuery>
  3. Save the database driver JAR inside both <AM_HOME>/repository/components/lib and <BAM_HOME>/repository/components/lib folders.


  1. Download WSO2 BAM 2.5.0 from location:
  2. Copy the <APIM_HOME>/statistics/API_Manager_Analytics.tbox to <BAM_HOME>/repository/deployment/server/bam-toolbox folder. This enables the BAM server to create the required tables in the statistical database that you set up earlier. 

  3. Apply an offset of 3 to the default BAM port by editing the <BAM_HOME>/repository/conf/carbon.xml file.

    Code Block

    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.

  4. Anchor
    In <BAM_HOME>/repository/conf/datasources/bam_datasources.xml file, copy/paste WSO2AM_STATS_DB definition from the API Manager's master-datasources.xml file. You edited it in step 2. WSO2AM_STATS_DB is used to fetch analytical data from the database. 


    Tip: If you are running BAM on a different server than the server that the API Manager runs on, add the IP address of the server instead of localhost under the using BAM 2.4.1, be sure to uncomment the <thriftDataReceiver><hostName> element in the <BAM_HOME>/repository/conf/data-bridge/data-bridge-config.xml file . If you are using BAM 2.4.1 or older, be sure to uncomment this elementand give the BAM host IP there.

  5. Restart BAM server by running <BAM_HOME>/bin/wso2server.[sh/bat].

Troubleshoot common issues