Configuring APIM Analytics

This section explains how to configure analytics for WSO2 API Manager (WSO2 API-M). The API Manager integrates with the WSO2 Analytics platform to provide reports, statistics and graphs on the APIs deployed in WSO2 API Manager. You can then configure alerts to monitor these APIs and detect unusual activity, manage locations via geo location statistics and carry out detailed analysis of the logs. WSO2 API Manager has an enhanced distribution of Analytics to cater to API Manager specific scenarios which is used here to configure APIM Analytics.

By default, WSO2 API Manager has a port offset of 0 (no port offset) and WSO2 API Manager Analytics has an offset of 1. Therefore, this guide assumes that you do not have any other carbon servers running on the same machine with port offsets of 0 or 1.

Click on the Quick Setup tab to set up analytics for quick demos and try-out scenarios, or click on the Standard Setup tab to set up analytics for a production environment.

WSO2 recommends using the API-M Analytics (powered by WSO2 Data Analytics Server) distribution to set up the minimum high availability deployment with API Manager. For configuration details, see Minimum High Availability Deployment for WSO2 APIM Analytics.
It is not recommended to configure the Gateway node as an analytics server.
Instead of installing APIM Analytics, you can take a Data Analytics Server or a Stream Processor and install the relevant APIM features in it to view analytics in the API Store and Publisher.

Purging Analytics Data

You can remove historical data in API Manager Analytics by data purging. By purging data, you can achieve high performance in data analysis without removing analyzed summary data. When purging data, only the stream data generated by API Manager is purged. Refer Purging Analytics Data for more information.