Enabling or disabling access to analytics event data in API Connect

The Gateway logs and reports all API interactions to the API Connect analytics engine, for real-time and historical analytics and reporting. Performance-related data about the Management and Gateway servers, and other data relating to system and user status and activities are also captured for display and analysis. By default, this analytics data is accessible from the API Connect user interfaces. You can, if preferred, switch off access to analytics within the API Connect user interfaces.

Before you begin

To enable or disable access to analytics data within API Connect, you must be assigned one of the following roles: Cloud Owner, Cloud Administrator, Topology Administrator, or System User. These roles provide access to the Settings tab in the Cloud Manager user interface from where you can configure security, analytics, and other capabilities. For more information about roles and permissions, see Adding users and assigning roles and API Connect user roles.

About this task

You can enable or disable access to analytics data for one or more of the following event types: API events, monitoring events, log events, and audit events. For more information about these event types and the effect of enabling or disabling access to analytics data in API Connect, see Supported event types for analytics offload.

Important: When you enable or disable access to API Connect Analytics, that change is applied across all provider and developer organizations in the cloud infrastructure.

Procedure

In the Cloud Manager, click Settings.
From the navigation pane, click Analytics to open the Analytics page.
For each event type, enable or disable access to analytics data from within API Connect:
API Events

To enable access to API event data for analysis within the API Connect user interfaces, ensure that the associated Use IBM API Connect® Analytics check box is selected. This is the default option.
To disable access to API event data for analysis within API Connect, clear the Use IBM API Connect Analytics check box.

Monitoring Events

To enable access to monitoring event data for analysis within the API Connect user interfaces, ensure that the associated Use IBM API Connect Analytics check box is selected. This is the default option.
To disable access to monitoring event data for analysis within API Connect, clear the Use IBM API Connect Analytics check box.

Log Events
To enable recording of log event data within API Connect, ensure that the associated Use IBM API Connect Analytics check box is selected. This is the default option.
You must enable the webapi-mntr service to capture log events, which is disabled by default. Because the default state is disabled, you must enable it each time that you refresh your DataPower server. To enable the webapi-mntr service, complete the following steps:

Log in to your DataPower Console.

Select the API Connect domain.

Select Logging Targets in the navigation.

Select webapi-mntr.

Select the checkbox for Enable administrative state.

Select Apply > Save.

You should only enable the webapi-mntr service temporarily to debug a problem. The service can slow down the rate at which the gateway pushes the API events to the management server.
Remember: Even with the Log Events enabled and the webapi-mntr service enabled, you cannot view them in the API Connect user interfaces. To view them, you must configure your system to offload the log events.

To disable recording of log event data within API Connect, clear the Use IBM API Connect Analytics check box.
Audit Events

To enable access to audit event data for analysis within the API Connect user interfaces, ensure that the associated Use IBM API Connect Analytics check box is selected. This is the default option.
To disable access to audit event data for analysis within API Connect, clear the Use IBM API Connect Analytics check box.
Click the Save icon to save the check box settings.
Optional: Configure the offload of API, monitoring, log, or audit events to one or more third-party systems. Events are not offloaded by default to third-party systems, as indicated by the Export events to a third-party system check box, which is initially clear for each event type.
For more information, see Configuring the offload of analytics event data to third-party systems.