This documentation is for WSO2 API Manager 1.10.0 View documentation for the latest release.
Page Comparison - Publishing API Runtime Statistics Using RDBMS (v.23 vs v.24) - API Manager 1.10.0 - WSO2 Documentation

Versions Compared

Key

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

...

  1. Download WSO2 API Manager.
  2. Open the <APIM_HOME>/repository/conf/api-manager.xml file and set to RDBMS by uncommenting the RDBMS client code. 

    Code Block
    <!-- For APIM implemented Statistic client for DAS REST API -->
        <!--StatisticClientProvider>org.wso2.carbon.apimgt.usage.client.impl.APIUsageStatisticsRestClientImpl</StatisticClientProvider-->
        
         <!-- For APIM implemented Statistic client for RDBMS -->
        <StatisticClientProvider>org.wso2.carbon.apimgt.usage.client.impl.APIUsageStatisticsRdbmsClientImpl</StatisticClientProvider>
       
  3. Start the API Manager server and log in to the Admin Dashboard (https://<Server Host>:9443/admin-dashboard).
  4. Click Configure Analytics under the Settings section.
  5. Select the Enable check box to enable statistical data publishing.
  6. Set the event receiver configurations according to the DAS server (e.g. tcp://localhost:7614 as the URL and admin/admin as the username/password). 

    Info
    Event receivers refer to the endpoint to which events are published from the API Gateway. WSO2 DAS consists of a thrift receiver, which acts as the default event receiver. By default, this receiver listens on port 7611 when no port offsets are set and increments according to the port offset set for the DAS server in step 2 above.
    Tip

    Alternatively, the DAS Server connection details can be configured via <APIM_HOME>/repository/conf/api-manager.xml by configuring the following under APIUsageTracking.

    Code Block
    <Enabled>true</Enabled>

    
    <DASServerURL>{tcp://localhost:
    7612
    7614/}</
    DASServerURL>
    DASServerURL>
    <DASUsername>admin</DASUsername>

    
    <DASPassword>admin</DASPassword>

    Please note that the analytics configurations added via admin-dashboard UI will get overwritten by the configuration details provided via api-manager.xml, when you restart the server if you follow this step.


  7. Click Add URL Group to save the configuration. 
  8. Set the configurations under the Data Analyzer Configurations section (e.g. https://localhost:9446 as the URL and admin/admin as the username/password).

    Info
    This is the endpoint at which the data analyzer (WSO2 DAS, in this case) resides and is used to deploy the DAS C-App containing the summarization logic to WSO2 DAS. By default, WSO2 DAS listens on port 9443 when no port offsets are set and increments according to the port offset set for the DAS server in step 2 above.
  9. Clear all settings under the Statistics Summary Datasource section. Give the datasource definition that is used to store summarized statistical data. The tables are created automatically when the Hive script runs. You just need to create the schema. The same configurations will be done in the DAS server.
    • URL: The connection URL for the RDBMS datasource
    • JDBC Driver Class: The fully qualified Java class name of the JDBC driver
    • Username/Password: Credentials to be passed to the JDBC driver to establish a connection
  10. Click Save. It deploys the Analytics toolbox, which describes the information collected, how to analyze the data, and the location of the database where the analyzed data is stored.

    Tip

    Tip: To edit the datasource connection pool parameters, click the Show More Options link.

...