Configuring Log Aggregation

You can configure log aggregation such that the aggregated logs from different sources can be stored at a single location in a common format. You can select any of the following destinations to store the aggregated data:

API Data Store

Elasticsearch, in case you have an external Elasticsearch configured with API Gateway

Enabling log aggregation collects log from the different components and store either in API Data Store or external Elasticsearch based on the log aggregation configuration settings. If the API Data Store is configured as the destination the aggregated log is displayed in the API Gateway dashboard under the Analytics > Application logs tab, where you can search and view the aggregated logs stored in the API Data Store. You can filter the logs as required and search for a particular log. You can filter or search for any specific log in the dashboard.

You must have the API Gateway's manage general administration configurations functional privilege assigned to:

enable the log aggregation and

configure the destination for log aggregation

To configure log aggregation

1. Expand the menu options icon

, in the title bar, and select Administration.

2. Select General > Application logs.

3. In the Log aggregation section, click the toggle button to change the status to

, to enable the log aggregation.

4. Select one of the following destination:

API Gateway Data Store: Select this to set API Data Store as destination to store the aggregated log.

If you select this option the aggregated logs are stored in the API Data Store and you can view them in the API Gateway dashboard.

External Elasticsearch. Select this to set the external Elasticsearch as destination to store the aggregated log.

Note:
Make sure you have configured an external Elasticsearch with API Gateway.

Provide the following information:

Field Name	Description
Protocol	The type of protocol (HTTP, HTTPS) to use for the host and port combination.
Hostname	Specifies the host name or IP address of the machine on which Elasticsearch resides.
Port	Specifies the port where Elasticsearch server runs
Indexname	Specifies the index of the collected logs.
Username	Specifies the Elasticsearch user ID for authenticating Elasticsearch when API Gateway communicates with it.
Password	Specifies the password of the Elasticsearch instance to be used for establishing communication between API Gateway and Elasticsearch.

5. Click Save.

The selected destination is now configured for log aggregation.