Send event to Axway Sentinel

You can use the Axway Sentinel Event filter in API Gateway to configure the tracked-event message to send to Axway Sentinel.

Note   The tracked object definition must already exist in Axway Sentinel (see Configure Axway Sentinel).

Configure the Axway Sentinel Event filter

The following figure shows the configuration window for the Axway Sentinel Event filter, which is available in the Monitoring category in Policy Studio.

Axway Sentinel event filter configuration

The tracked object you have created in Axway Sentinel contains the list of attributes that can be sent in an event to Axway Sentinel. You must specify the tracked object to be used in the filter. You can find this information in the tracked object XML definition. For example, the following XML extract shows the tracked object version and name:

Tracked object XML file

For this example, the following tracked object details would be entered in the filter configuration:

  • Version: 3.0

To configure the tracked object click the browse button next to the Use the following tracked object field. In the dialog, right-click Sentinel Tracked Objects and select Add a tracked object. Enter the required Name and Version in the dialog and click OK.

Axway Sentinel tracked object name and version

Alternatively, an upstream product, for example Axway B2Bi, might have inserted tracking information inside some HTTP headers. You can use selectors to retrieve these from the message and use them as the definition of the tracked object to use. Select the Or use the following from the message option, and enter appropriate selectors in the Tracked object name and Tracked object version fields. For example, you might enter the following selectors to retrieve the values from the HTTP headers:

Selectors to retrieve name and version from HTTP request

After the tracked object has been configured you can configure what event attributes to send to Axway Sentinel. The named event attributes must be contained within the tracked object. For example, to send the cycle ID you must use a tracked object that contains the CycleId attribute:

CycleId attribute in tracked object XML definition

In this case you can select the Include Cycle ID option in the filter configuration, for example, to set the cycle ID to the value of the transaction ID in API Gateway:

Set the cycle ID to be the value of the transaction ID

The policy name and the filter name can be placed in any named attribute, as long as that attribute name exists within the tracked object definition. You can also add other attributes to be included in the event by populating entries in the table. For example, to populate the attribute UserName with the authenticated user, enter the following:

Set the UserName attribute to the authenticated subject ID

The tracked object definition must contain an attribute named UserName:

UserName event attribute in tracked object definition

For more information on configuring the Axway Sentinel Event filter, see the API Gateway Policy Developer Filter Reference.

Result in Axway Sentinel

When the Axway Sentinel Event filter is invoked as configured above, it results in the following event in Axway Sentinel Monitoring:

Event in Axway Sentinel Monitoring

The details of the event show where the event attributes have been populated by the filter:

Event details in Axway Sentinel Monitoring

Related Links