Page Comparison

The API Manager Analytics provides reports, statistics and graphs on the APIs that are deployed in WSO2 Open Banking API Manager. You can configure alerts to monitor these APIs and detect unusual activity, manage locations via geo-location statistics, and carry out a detailed analysis of the logs.

...

Info

The following is a list of database versions that are compatible with the WSO2 API Manager Analytics.

MySQL 5.7 and above7
MS SQL Server 2016 and above
Oracle 12c

You can configure databases to persist, process and analyze API-related data. Follow the steps below to configure the databases.

Create the openbank_apimgt_statsdb database in your database server.

Configure the worker profile.

Open the <WSO2_APIM_ANALYTICS_HOME>/conf/worker/deployment.yaml file. Update the APIM_ANALYTICS_DB datasource pointing it to the openbank_apimgt_statsdb database using your database configurations.

Note

If you are using Oracle, update the connectionTestQuery in each datasource with the following value.

Code Block
connectionTestQuery: SELECT 1 FROM DUAL

Code Block

language	xml

- name: APIM_ANALYTICS_DB
description: The Datasource used for APIM Analytics
jndiConfig:
  name: jdbc/APIM_ANALYTICS_DB
definition:
  type: RDBMS
  configuration:
    jdbcUrl: 'jdbc:mysql://localhost:3306/openbank_apimgt_statsdb?autoReconnect=true&useSSL=false'
    username: root
    password: root
    driverClassName: com.mysql.jdbc.Driver
    maxPoolSize: 50
    idleTimeout: 60000
    connectionTestQuery: SELECT 1
    validationTimeout: 30000
    isAutoCommit: false

By default, the following datasource entries are configured to H2 databases. If required, you can create external databases and point these entries to them.

Datasource Name	File
`BUSINESS_RULES_DB`	`<WSO2_APIM_ANALYTICS_HOME>/conf/dashboard/deployment.yaml`
`WSO2_PERMISSIONS_DB`	`<WSO2_APIM_ANALYTICS_HOME>/conf/worker/deployment.yaml` `<WSO2_APIM_ANALYTICS_HOME>/conf/dashboard/deployment.yaml`

Tip
The `GEO_LOCATION_DATA` datasource should be configured only when you are using Geo-location based statistics

Place the database driver in the <WSO2_APIM_ANALYTICS_HOME>/lib directory.

Note

You need to follow the steps below when you are using Oracle or MS SQL database servers.

You need to include the database driver corresponding to the database for the API Manager Analytics server to communicate with the database. The WSO2 API Manager Analytics is an OSGi-based product. Therefore, when you integrate third party products such as Oracle and MS SQL 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 <WSO2_APIM_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 <WSO2_APIM_ANALYTICS_HOMEE>/bin directory. Run the command given below, to generate the converted file in the <WSO2_APIM_ANALYTICS_HOME >/lib directory.

Code Block
./jartobundle.sh <PATH_TO_NON-OSGi_JAR> ../lib

...

Versions Compared

Old Version 1

New Version 2

Key