Page Comparison

...

Download the WSO2 API-M Analytics distribution. Click DOWNLOAD ANALYTICS in the WSO2 API Manager page.
Take the following steps to install WSO2 APIM Analytics. Because this procedure is identical to installing WSO2 Data Analytics Server (DAS), these steps take you to the DAS documentation for details.
1. Ensure that you have met the Installation Prerequisites.
2. Go to the installation instructions relevant to your operating system:

Follow the steps below to set up MySQL.

Download and install MySQL Server.
Download the MySQL JDBC driver.
Unzip the downloaded MySQL driver zipped archive, and copy the MySQL JDBC driver JAR (mysql-connector-java-x.x.xx-bin.jar) into the <APIM Analytics_HOME>/repository/components/lib directory of all the nodes in the cluster.
Enter the following command in a terminal/command window, where username is the username you want to use to access the databases.
mysql -u username -p
When prompted, specify the password that will be used to access the databases with the username you specified.

Create two databases named userdb and regdb.

Info

title	About using MySQL in different operating systems

For users of Microsoft Windows, when creating the database in MySQL, it is important to specify the character set as latin1. Failure to do this may result in an error (error code: 1709) when starting your cluster. This error occurs in certain versions of MySQL (5.6.x) and is related to the UTF-8 encoding. MySQL originally used the latin1 character set by default, which stored characters in a 2-byte sequence. However, in recent versions, MySQL defaults to UTF-8 to be friendlier to international users. Hence, you must use latin1 as the character set as indicated below in the database creation commands to avoid this problem. Note that this may result in issues with non-latin characters (like Hebrew, Japanese, etc.). The following is how your database creation command should look.

mysql> create database <DATABASE_NAME> character set latin1;

For users of other operating systems, the standard database creation commands will suffice. For these operating systems, the following is how your database creation command should look.

mysql> create database <DATABASE_NAME>;

Execute the following script for the two databases you created in the previous step.
mysql> source <APIM Analytics_HOME>/dbscripts/mysql.sql;

Note

title	For MySQL 5.7:

From Carbon kernel 4.4.6 onwards your product will be shipped with two scripts for MySQL as follows (click here to see if your product is based on this kernel version or newer):

mysql.sql : Use this script for MySQL versions prior to version 5.7.
mysql5.7.sql : Use this script for MySQL 5.7 and later versions.

Note that if you are automatically creating databases during server startup using the -DSetup option, the mysql.sql script will be used by default to set up the database. Therefore, if you have MySQL version 5.7 set up for your server, be sure to do the following before starting the server:

First, change the existing mysql.sql file to a different filename.
Change the <PRODUCT_HOME>/dbscripts/mysql5.7.sql script to mysql.sql.
Change the <PRODUCT_HOME>/dbscripts/identity/mysql5.7.sql script to mysql.sql.

MySQL 5.7 is only recommended for products that are based on Carbon 4.4.6 or a later version.

Expand

title	Click here to view the commands for performing steps f and g

Code Block

mysql> create database userdb;
mysql> use userdb;
mysql> source <APIM Analytics_HOME>/dbscripts/mysql.sql;
mysql> grant all on userdb.* TO username@localhost identified by "password";
 
 
mysql> create database regdb;
mysql> use regdb;
mysql> source <APIM Analytics_HOME>/dbscripts/mysql.sql;
mysql> grant all on regdb.* TO username@localhost identified by "password";

Create the following databases in MySQL.

WSO2_ANALYTICS_EVENT_STORE_DB
WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB

Info

It is recommended to create the databases with the same names given above because they are the default JNDI names that are included in the <APIM Analytics_HOME>/repository/conf/analytics/analytics-conf.xml file as shown in the extract below. If you change the name, the analytics-conf.xml file should be updated with the changed name.

Code Block

language	xml

<analytics-record-store name="EVENT_STORE">
   <implementation>org.wso2.carbon.analytics.datasource.rdbms.RDBMSAnalyticsRecordStore</implementation>
   <properties>
      <property name="datasource">WSO2_ANALYTICS_EVENT_STORE_DB</property>
      <property name="category">read_write_optimized</property>
   </properties>
</analytics-record-store>
<analytics-record-store name="EVENT_STORE_WO">
   <implementation>org.wso2.carbon.analytics.datasource.rdbms.RDBMSAnalyticsRecordStore</implementation>
   <properties>
      <property name="datasource">WSO2_ANALYTICS_EVENT_STORE_DB</property>
      <property name="category">write_optimized</property>
   </properties>
</analytics-record-store>
<analytics-record-store name="PROCESSED_DATA_STORE">
   <implementation>org.wso2.carbon.analytics.datasource.rdbms.RDBMSAnalyticsRecordStore</implementation>
   <properties>
      <property name="datasource">WSO2_ANALYTICS_PROCESSED_DATA_STORE_DB</property>
      <property name="category">read_write_optimized</property>
   </properties>
</analytics-record-store>

...

Versions Compared

Old Version 4

New Version 5

Key