/
API Connect Single Transaction

IBM DataPower Operations Dashboard v1.0.23.x

API Connect Single Transaction

When you click a transaction’s ID in the transactions list, DPOD loads the full details of the transaction into the information window.

This view provides a plethora of information about the single transaction.

Transaction Details Panel

The panel at the top of the window displays various details about the transaction, such as time, status, device, domain, API Name, catalog, consumer details, etc.

Previous/Next Buttons

If you navigate to this page from a transactions list that contains more than one transaction, previous/next buttons will appear to quickly move to the next or previous transaction on that list.

The size of next/previous transactions results can be defined in the System Parameters list.

Transaction Analysis Panel

Error analysis

Displays a summary of all errors found by DPOD for this transaction.

In case a single error has been detected, DPOD will display additional information about the error, such as ways for further investigation and solving the problem. When several errors are detected, DPOD will list the errors and the related policies. View the relevant policy details to get the detailed information about each error.

Elapsed Time 

This diagram shows a breakdown of the transaction’s elapsed time between the gateway processing and back-end processing, to quickly identify the source of latency issues.

Payload Size

Displays the request and response sizes.

Policy Flow Diagram

The policy flow diagram displays all the policies that were executed during the processing of this specific API invocation:

  • Green boxes represent user policies.

  • Blue boxes represent the API-Connect framework builtin policies.

  • Boxes with a blue border represent pre/post policies.

  • An exclamation icon on a policy indicates that an error has occurred.

When “Primary Policies” option is selected, all the pre/post policies are grouped into 2 boxes (pre and post) with the aggregated latency and the number of policies. Choose “All Policies” to view all the policies, including the policies that are part of the pre/post flows.

Clicking on a policy opens the Policy Details window.

image-20250120-093503.png

Policy Details Window

The top part of the window shows the policy flow diagram. Clicking on a policy will show the details of that policy.

The Policy Details tab displays basic details about the policy, detailed error analysis and a list of side calls if exist.

The Logs tab displays the log messages received from the DataPower gateway for that policy.

Depending on whether API probe was captured, additional tabs will display the probe data that includes requests, responses and headers of invoke policies, inputs and outputs of map policies, etc.

Keyboard shortcuts:

  • Left and right arrows may be used to move to previous and next policy.

  • Escape closes the window.

image-20250120-094041.png

Logs Tab

This tab lists the log messages that were received from the DataPower gateway for that transaction.

Use the log messages to get more information about the processing of the transaction, error messages or view log messages that were written to the log by the API developer (e.g. by using GatewayScript).

The information is displayed in a table:

Column

Description

Column

Description

Category

The message’s category.

Severity

The message’s severity.

Time

The message’s timestamp.

Direction

The message’s direction. This may be:

  • Request

  • Response

  • Error (if message is an error)

  • Empty (if it is a system message)

Object Type

The object type associated with this message.

Object Name

The object name associated with this message.

Client IP

The Client IP this message originated from. This may be the actual client, or a load balancer.

Message Code

The message’s code.

Message

The actual message logged.

Correlated Transactions Tab

The Correlated Transactions Tab (Appears only if the user has appropriate permissions), shows all the transactions with the same Global Transaction ID, both Gateway transactions and API-C transactions are shown.
The transactions are sorted by their start time, where the first transaction that run appears on top..

The Trans. ID column displays the transaction ID of the correlated transaction, or "Current" for the current transaction in view. Click the Transaction ID to navigate to the Single Transaction Page of that transaction.
The link will appear only if the user has appropriate permissions to view that particular transaction.

The Service/API column displays the Gateway Service name, or the API Name+API Version.

The Status column displays the transaction status, as shown in the Single Transaction page.

The Message column displays the error message analysis, as shown in the Single Transaction Page. (see "Error Analysis" previously on this page)

Clicking on the Raw Errors links (appears only if the transaction did have any errors, and only if the user has appropriate permissions) will open a window with the all the transactions' error messages, note that the existence of error messages doesn't necessarily mean that the transaction failed. 

Side Calls Tab

The side calls tab shows both side calls that were made by user policies and internal side calls (such as calls to API-C Analytics).

Payload Tab

When payload is captured for this transaction, the Payload pane of the table will contain payload information for the messages displayed.
The payload is shown for both the front end and the back end (when applicable), for both the request and response.

A link to Payload Capture will appear if payload does not exist.

Headers Tab

When API-C Analytics data is captured via Payload Capture, headers information is displayed for both the request and response.

Extended Latency Tab

Detailed latency information for both the request and response phases.

API-C Analytics Tab

When API-Connect Analytics data is captured via Payload Capture, this data is displayed in this tab.

The "Analytics Data" inner tab displays the API-Connect Analytics data after it has been parsed and enriched by DPOD. Use the "Raw Data" inner tab to view the original event data received from API-Connect Analytics without parsing and enrichment.

API Probe Tab

When API-Connect Probe data is captured via API Probe Capture, this data is displayed in this tab.
The “API Probe Data" inner tab displays the API-Connect Probe data after it has been parsed and enriched by DPOD. Use the "Raw Data" inner tab to view the original event data received from API Probe capture without parsing and enrichment.



Related content

Copyright © 2015 MonTier Software (2015) Ltd.