Page Comparison

To download the WSO2 API Manager distribution, click DOWNLOAD and then click DOWNLOAD Server in the WSO2 API Manager page.

If you are working on a distributed (clustered) setup of API Manager, carry out the instructed configurations in the Publisher, Store and Gateway nodes of the API Manager.

1. Stop the WSO2 API-M Analytics server if it is running already.

2. Configure the dashboard profile.

   1. Open the <API-M_ANALYTICS_HOME>/conf/dashboard/deployment.yaml file.

   2. Edit the APIM_ANALYTICS_DB section.
      A sample for MySQL is shown below.

      Code Block

      - name: APIM_ANALYTICS_DB description: "The datasource used for APIM statistics aggregated data." jndiConfig: name: jdbc/APIM_ANALYTICS_DB definition: type: RDBMS configuration: jdbcUrl: 'jdbc:mysql://localhost:3306/ANALYTICS_DB' username: 'root' password: '123' driverClassName: com.mysql.jdbc.Driver maxPoolSize: 50 idleTimeout: 60000 connectionTestQuery: SELECT 1 validationTimeout: 30000 isAutoCommit: false

3. Configure the worker profile.

   Note
   If your deployment does not consist of any Mirogateways, you do not need to configure the WSO2AM_MGW_ANALYTICS_DB to an external database as you can use the default embedded H2 database.

   1. Open the <API-M_ANALYTICS_HOME>/conf/worker/deployment.yaml file.

   2. Edit the APIM_ANALYTICS_DB section.
      A sample for MySQL is shown below.

      Code Block

      - name: APIM_ANALYTICS_DB description: "The datasource used for APIM statistics aggregated data." jndiConfig: name: jdbc/APIM_ANALYTICS_DB definition: type: RDBMS configuration: jdbcUrl: 'jdbc:mysql://localhost:3306/ANALYTICS_DB' username: 'root' password: '123' driverClassName: com.mysql.jdbc.Driver maxPoolSize: 50 idleTimeout: 60000 connectionTestQuery: SELECT 1 validationTimeout: 30000 isAutoCommit: false

   3. Configure WSO2AM_MGW_ANALYTICS_DB to the same database as APIM_ANALYTICS_DB in the <API-M_ANALYTICS_HOME>/conf/worker/deployment.yaml file.

      Code Block

      - name: WSO2AM_MGW_ANALYTICS_DB description: "The datasource used for APIM MGW analytics data." jndiConfig: name: jdbc/WSO2AM_MGW_ANALYTICS_DB definition: type: RDBMS configuration: jdbcUrl: 'jdbc:mysql://localhost:3306/ANALYTICS_DB' username: 'root' password: '123' driverClassName: com.mysql.jdbc.Driver maxPoolSize: 50 idleTimeout: 60000 connectionTestQuery: SELECT 1 validationTimeout: 30000 isAutoCommit: false

   4. Create the AM_USAGE_UPLOADED_FILES table in the APIM_ANALYTICS_DB database.

      Localtabgroup

      Localtab active true id mysql-AM_USAGE_UPLOADED_FILES title MySQL Code Block CREATE TABLE IF NOT EXISTS AM_USAGE_UPLOADED_FILES ( FILE_NAME varchar(255) NOT NULL, FILE_TIMESTAMP TIMESTAMP DEFAULT CURRENT_TIMESTAMP, FILE_PROCESSED tinyint(1) DEFAULT 0, FILE_CONTENT MEDIUMBLOB DEFAULT NULL, PRIMARY KEY (FILE_NAME, FILE_TIMESTAMP) ); Localtab id MSSQL-AM_USAGE_UPLOADED_FILES title MSSQL Code Block CREATE TABLE AM_USAGE_UPLOADED_FILES ( FILE_NAME varchar(255) NOT NULL, FILE_TIMESTAMP DATETIME2(0) DEFAULT GETDATE(), FILE_PROCESSED smallint DEFAULT 0, FILE_CONTENT VARBINARY(max) DEFAULT NULL, PRIMARY KEY (FILE_NAME, FILE_TIMESTAMP) ); Localtab id Oracle-AM_USAGE_UPLOADED_FILES title Oracle Code Block CREATE TABLE AM_USAGE_UPLOADED_FILES ( FILE_NAME varchar2(255) NOT NULL, FILE_TIMESTAMP TIMESTAMP(0) DEFAULT SYSTIMESTAMP, FILE_PROCESSED number(3) DEFAULT 0, FILE_CONTENT BLOB DEFAULT NULL, PRIMARY KEY (FILE_NAME, FILE_TIMESTAMP) ); Localtab id Postgres-AM_USAGE_UPLOADED_FILES title Postgres Code Block CREATE TABLE IF NOT EXISTS AM_USAGE_UPLOADED_FILES ( FILE_NAME varchar(255) NOT NULL, FILE_TIMESTAMP TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP, FILE_PROCESSED smallint DEFAULT 0, FILE_CONTENT BYTEA DEFAULT NULL, PRIMARY KEY (FILE_NAME, FILE_TIMESTAMP) ); Localtab id DB2-AM_USAGE_UPLOADED_FILES title DB2 Code Block CREATE TABLE IF NOT EXISTS AM_USAGE_UPLOADED_FILES ( FILE_NAME varchar(255) NOT NULL, FILE_TIMESTAMP TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP, FILE_PROCESSED tinyint DEFAULT 0, FILE_CONTENT MEDIUMBLOB DEFAULT NULL, PRIMARY KEY (FILE_NAME, FILE_TIMESTAMP) ); Localtab id INFORMIX-AM_USAGE_UPLOADED_FILES title Informix Code Block CREATE TABLE IF NOT EXISTS AM_USAGE_UPLOADED_FILES ( FILE_NAME varchar(255) NOT NULL, FILE_TIMESTAMP TIMESTAMP(0) DEFAULT CURRENT_TIMESTAMP, FILE_PROCESSED tinyint DEFAULT 0, FILE_CONTENT MEDIUMBLOB DEFAULT NULL, PRIMARY KEY (FILE_NAME, FILE_TIMESTAMP) );

4. Point the following data sources to external databases.
   None of the following databases need DB scripts. The tables will be automatically created.  

   • BUSINESS_RULES_DB (dashboard)
   • WSO2_PERMISSIONS_DB (worker + dashboard)
   • GEO_LOCATION_DATA (Only if you need geo-location based statistics.)

5. Integrate third-party products when configuring the databases.

   Note

   WSO2 SP is a OSGi-based product. Therefore, when you integrate third party products such as Oracle with WSO2 API-M Analytics, you need to check whether the libraries you need to add are OSGi based. If they are not, you need to convert them to OSGi bundles before adding them to the <API-M_ANALYTICS_HOME>/lib directory.  To convert the jar files to OSGi bundles, follow the steps below. 1. Download the non-OSGi jar for the required third party product, and save it in a preferred directory in your machine. 2. Go to the <API-M_ANALYTICS_HOME>/bin directory. Run the command given below, to generate the converted file in the <API-M_ANALYTICS_HOME>/lib directory. Code Block ./jartobundle.sh <PATH_TO_NON-OSGi_JAR> ../lib

6. Start the WSO2 API-M Analytics server.