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:

Internal Data Store

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

Enabling log aggregation starts log collection from various sources. If the Internal Data Store is configured as the destination the aggregated log is displayed in the API Gateway dashboard. The dashboard provides a simple user interface where you can view the aggregated logs and details of the logs. 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 configure the log aggregation and 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.

Note: Only when this is enabled, the log aggregation is done.

4. In the Log aggregation section, select one of the following:

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

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

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

Note: You must have an external Elasticsearch configured with API Gateway to store the data.

In addition provide the following information:

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.