Configuring Events for Elasticsearch Destination

Edit online

Before you begin

Pre-requisites:

You have to configure Elasticsearch to communicate with API Gateway before you select Elasticsearch as a destination.

About this task

You have to configure Elasticsearch as a destination so that the event types and performance metrics data can be published to Elasticsearch.

To configure Elasticsearch destination

Procedure

  1. Expand the menu options icon , in the title bar, and select Administration.
  2. Select Destinations.
  3. Select Elasticsearch > Events to configure the event types for this destination.
  4. In Event types, select the type of events that you want API Gateway to publish to Elasticsearch.

    The available event types are:

    • Error: Occurs each time an API invocation results in an error.
    • Lifecycle: Occurs each time API Gateway is started or shut down.
    • Policy violation: Occurs each time an API invocation violates the policy enforcement that was set for the API.
  5. Select Report performance data to publish performance metrics data.
  6. In the Publish interval box, enter a time interval (in minutes) to specify how often API Gateway must publish performance metrics. Enter a value from 1 through 60. The default is 60 minutes.
  7. In the Audit log data section, select the required management area for which the audit logs should be recorded in the Elasticsearch destination.

    Audit logs provide a record of system transactions, events, and occurrences in API Gateway. You can configure audit logging to show the following events:

    • API management
    • Application management
    • Team management
    • Group management
    • Package management
    • Promotion management
    • Approval management
    • Alias management
    • Analytics management
    • Policy management
    • Plan management
    • User management
    Note: By default, audit logging is disabled for all of the above-listed management areas in the Elasticsearch destination.
  8. Click Save.

What to do next

Post-requisites:

After performing the event configurations, select Elasticsearch as a Destination in the Policy Properties page for each policy, to publish the transaction and monitoring event logs for the assigned policies.