Configuring Events for Digital Events Destination
Pre-requisites:
API Gateway, by default, communicates with the Digital Event Services (DES) component which runs within the API Gateway server. For more information on configuring DES using Command Central, see Using Digital Event Services to Communicate between Software AG Products.
Digital Event Services (DES) enables API Gateway to communicate by exchanging digital events. Digital events are typed and serialized data structures that are used to convey or record information about the execution of a runtime. This information can be application information, such as the state of a business process step, including any associated business data, or it can be system information, for example, how much memory and how many threads an application is using.
You have to configure the Digital Event Services destination so that the event types and performance metrics data can be published to Digital Event Services.
![*](icon_task_xpe.png)
To configure events for Digital Event Services destination
1. Expand the menu options icon
, in the title bar, and select Administration. 2. Select Destinations.
3. Select Digital Event Services > 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 Digital Event Services.
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) 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 Digital Event Services 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:
Access profile management
Alias management
Analytics management
API management
Application management
Approval management
Group management
Package management
Plan management
Policy management
Promotion management
User managementNote:
By default, audit logging is disabled for all of the above-listed management areas in the Digital Event Services destination.
8. Click Save.
Post-requisites:
After performing the server configurations, select Digital Events as a Destination in the Policy Properties page for each policy, to receive the transaction events logs for the assigned policies.