Monitoring Traffic

• Overview
• Enabling Traffic Monitor
• Viewing the Message Traffic Log
• Viewing Transaction Details
• Viewing Performance Statistics
• Troubleshooting

Overview

This topic introduces the Traffic Monitor tool used for operational diagnostics. Traffic Monitor provides a web-based message log of the HTTP and HTTPS traffic processed by the Enterprise Gateway. You can perform tasks such as the following:

• Filter messages on a range of criteria (for example, transaction ID, service name, or remote host)
• Drill down to view the message contents
• Change logging settings on-the-fly
• View performance statistics (for example, number of requests, average bytes sent, or average duration)

Enabling Traffic Monitor

Before you can start viewing messages with the Traffic Monitor tool, you must first ensure that Traffic Monitor has been enabled for the Enterprise Gateway process. To enable traffic monitoring in the Policy Studio, perform the following steps:

1. In the Policy Studio tree, select the Settings node, and select the Traffic Monitor tab at the bottom of the screen.
2. On the Traffic Monitor tab, ensure Enable Traffic Monitor is selected.
3. Click the Deploy icon in the Policy Studio toolbar to deploy this setting to the Enterprise Gateway. Alternatively, press F6.

Viewing the Message Traffic Log

The Message Traffic Log provides an historic log of the HTTP and HTTPS traffic processed by the Enterprise Gateway. To view the Message Traffic Log, click the Traffic Monitor link on the Welcome to Oracle Enterprise Gateway page, which is available from http://localhost:8090/index.html. Ensure that the Traffic Log tab at the top left is selected.

For example, the Traffic Log page is displayed as follows:

Filtering the Message Traffic Log
You can click the Filter button on the top right of the screen to filter the messages displayed based on a range of criteria. The default filters include Transaction ID, Request From (Client or Gateway), Maximum Results, and Time Interval. The Enterprise Gateway inserts a transaction ID in all HTTP and HTTPS traffic in a header named X-CorrelationID.

You can click the Add Search Criteria to search on different criteria (for example, Service Name, Remote Host, Authentication Subject, and Operation). When you have selected your search criteria, click the Search button.

Configuring Settings
You can click the Settings button on the top right of the screen to set logging settings on-the-fly. You do not need to refresh or deploy to the Enterprise Gateway. For example, the System Settings enable you to specify whether inbound and outbound transactions, the circuit path, and message trace are recorded. You can also select the HTTP interface in the tree on the left to override these settings and configure the interface trace level.

Select the Enterprise Gateway process on the left to configure the process trace level. Finally, you can also select a Relative Path or Web Service on the left, and select Service Settings, Logging levels, or Payload Logging on the right.

Viewing Transaction Details

You can click a message entry in the Message Traffic Log to view transactions details for that message. The transaction details include the filter execution path, the contents of the outbound and inbound HTTP request and response messages, and the message trace. You can click to view one of these sections in the screen. Alternatively, click the Expand All button at the top right of the screen.

Filter Execution Path
The filter execution path shows the filters that the message passes through in the policy circuit, for example:

Request from Client and Response from Gateway
The contents of an example request message from the client and the response message from the Enterprise Gateway are displayed as follows:

Request from Gateway and Response from Web Service
The contents of an example request message from the Enterprise Gateway and the response message from the Web Service are displayed as follows:

When viewing message contents, you can click the Save link to download the contents of the request or response message body. You can also click the Download button on the top right of the screen to download the entire transaction in binary format. This provides diagnostic information for the Oracle Support team.

Trace
The trace output for the message is displayed at the currently set trace level (for example, DEBUG). You can configure trace levels for the Enterprise Gateway process or HTTP(S) interface using the Settings button on the right. You can click the Save link at the bottom to download the contents of the trace file.

Viewing Performance Statistics

The Performance tab displays performance statistics for the HTTP and HTTPS traffic processed by the Enterprise Gateway. For example, these include the number of requests, average bytes sent, and average duration.

For example, the Performance page is displayed as follows:

Filtering the Performance Statistics
You can click the Filter button at the top right of the screen to filter the performance statistics displayed based on a different criteria. By default, the statistics are grouped by path name, with a time interval of 1 day. You can select different criteria from the Group By and Time Interval lists. When you have selected your search criteria, click the Search button.

Troubleshooting

When you have viewed the message traffic and message contents, you can learn more about how to configure tracing for the Enterprise Gateway, and how to configure logging for specific message filters. For details, see Troubleshooting.