Configuring Analytics Database

All analytics data being tracked at the proxy are stored and fetched from the analytics database for processing. To enable data storage and processing, a third Party installation of PostgreSQL DB Server is required. The sections below illustrate the PostgreSQL configuration.

Installing and configuring PostgreSQL

1. Download PostgreSQL from https://www.postgresql.org/download/.
2. Install PostgreSQL (9.6 or a higher version) on the machine where the Analytics Database is to be created.
3. Create a preferred username, set a password and create the database.
4. Download the PostgreSQL JDBC driver for JVM from https://jdbc.postgresql.org/download/postgresql-42.2.2.jar.
5. Provide the jar path in the server.conf file at FIORANO_HOME/esb/server/bin.
   
   

   

   
   Figure 1: Providing the jar path in the server.conf file

Configuring the Analytics Database

Certain changes need to be made to the Fiorano setup for the Analytics database to connect to the PostgreSQL. This can be done using any one of the following ways:

• From the configuration file
• From eStudio
• From the API Dashboard

From the configuration file

Postgre DB details are stored in the apidb.cfg file present in the $FIORANO_HOME/esb/server/profiles/server1/AMS/conf directory. To configure database details, make the following changes in the document:

1. Under point 2, change the <ip-address>, <port> and <database> variables to the desired settings of the above-installed PostgreSQL setup.

   

   Ensure usage of a different database for separate installations of API platform.

2. Under point 3 and point 4 of this document, provide username and password credentials needed to connect to the installed database.
3. Under point 6 and 7, provide the preferred reconnect settings.
4. Go to $FIORANO_HOME/esb/server/bin/server.conf.
5. Under <java.classpath>segment, add the path to the JDBC driver that was downloaded previously, so that the driver gets added to the classpath of the JVM.
   
   

   

   
   Figure 2: Analytics DB properties in the apidb.cfg configuration file
   
   

From eStudio

When the servers are not running, the configuration can be done from the Profile Management perspective in eStudio. Perform the following actions for the same:

1. Launch the Profile Management perspective from Window > Open perspective > Profile Management and open the APIMANAGER profile.
2. Right-click the APIMANAGER node and click the DB Configuration for API Management option.

3. Change values in this dialog box as required (refer to the properties in the From the configuration file section above).

   

   The changes get updated in the apidb.cfg file.

   

   
   Figure 3: Analytics DB properties in the DB Configuration for API Management dialog box in eStudio

From the API Dashboard

The analytics database can be configured from the API Dashboard itself.

1. Go to the Server Groups section in the API management dashboard Admin module.
2. Select the environment (Server Group) for which the Analytics database needs to be configured.
3. Provide the values for the Analytics Database Configuration properties; other than the credentials for the JDBC driver, provide values for the below:
   • Try Reconnect Interval: Interval (in secs) after which the Stored Procedure tries to reconnect with the DB in the event of a connection loss.

   • Auto Reconnect: Select true or false to specify whether the Stored Procedure should try for an automatic reconnection with the DB or not.

     

     The changes get updated in the apidb.cfg file.

     

     
     Figure 4: Analytics DB properties in the Server Groups section in the Administration section of API Dashboard

Configuring the Mail Server to receive Analytics notifications

For receiving Analytics notifications, the Mail Server section can be configured in the Admin module of the API Management dashboard.

Refer the Mail Server section to see the properties that need to be updated.