Page Comparison

The API Manager Analytics provides reports, statistics and graphs on the APIs deployed in WSO2 Open Banking API Manager. You can then 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.

...

Tip

title	Before you begin,

Download API-M Analytics 2.6.0 and unzip the file, or add API-M Analytics 2.6.0 through WUM using the following commands:

Add API-M Analytics 2.6.0 WUM pack.
Code Block
wum add wso2am-analytics-2.6.0

Update API-M Analytics 2.6.0 product packs using WUM.

Code Block
wum update wso2am-analytics-2.6.0

Warning

WSO2 Updates Manager (WUM) is deprecated and will be unavailable from July 2021 onwards. WSO2 Updates is the new tool to include the solution and security improvements that are released by WSO2 Open Banking, on top of a released version. For more information, see WSO2 Updates.

Expand

title	Click here to see how to update the solution via WSO2 Update tool...

The WSO2 Update tool delivers hotfixes and updates seamlessly on top of products as WSO2 Updates. They include improvements that are released by WSO2. You need to update the product using the relevant script.

Go to <WSO2_OB_APIM_HOME>/bin and run the WSO2 Update tool:
Localtabgroup
Localtab
title On Linux
Code Block
./wso2update_linux
Localtab
title On Mac
Code Block
./wso2update_darwin
Localtab
title On Windows
Code Block
./wso2update_windows.exe

Table of Contents

maxLevel	3
minLevel	3

...

Info
When using Oracle or MS SQL, download the database driver and include it within `<WSO2_APIM_ANALYTICS_HOME>/lib` directory.

Create the openbank_apimgt_statsdb database in your database server.

Configure the worker profile.

Open the <WSO2_OB_API-M_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

language	xml

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:<DB_TYPE>://<DB_HOST>:<DB_PORT>/openbank_apimgt_statsdb?autoReconnect=true&useSSL=false'
    username: <DB_USERNAME>
    password: <DB_PASSWORD>
    driverClassName: <DB_DRIVER>
    maxPoolSize: 50
    idleTimeout: 60000
    connectionTestQuery: SELECT 1
    validationTimeout: 30000
    isAutoCommit: false

Configure the dashboard profile.

Open the <WSO2_OB_API-M_ANALYTICS_HOME>/conf/dashboard/deployment.yaml file. Update the APIM_ANALYTICS_DB datasource with your database configurations.

Note

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

Code Block

language	xml

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:<DB_TYPE>://<DB_HOST>:<DB_PORT>/openbank_apimgt_statsdb?autoReconnect=true&useSSL=false'
    username: <DB_USERNAME>
    password: <DB_PASSWORD>
    driverClassName: <DB_DRIVER>
    maxPoolSize: 50
    idleTimeout: 60000
    connectionTestQuery: SELECT 1
    validationTimeout: 30000
    isAutoCommit: false

Tip

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_OB_API-M_ANALYTICS_HOME>/conf/dashboard/deployment.yaml`
`WSO2_PERMISSIONS_DB`	`<WSO2_OB_API-M_ANALYTICS_HOME>/conf/worker/deployment.yaml <WSO2_OB_API-M_ANALYTICS_HOME>/conf/dashboard/deployment.yaml`

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

Integrate third-party products when configuring databases.

Note

WSO2 Stream Processor 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_OB_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

...

Versions Compared

Old Version 24

New Version Current

Key