Monitoring a Web Service

• Overview
• Enabling Message Monitoring
• Viewing Real-time Monitoring
• Viewing Message Monitoring
• Viewing Message Content
• Detecting Malformed Messages
• Monitoring a Remote Host
• Using Service Monitor
• Securing the Web Service

Overview

This topic explains how to monitor the ComInfoService example Web Service using the real-time monitoring tools provided with the Enterprise Gateway. It assumes that you have already performed the steps in the following topics:

1. Starting the Enterprise Gateway
2. Registering a Web Service

Enabling Message Monitoring

You must first enable message monitoring for the Enterprise Gateway using Policy Studio. To enable message monitoring, perform the following steps:

1. In the Enterprise Gateway Dashboard, double-click the Oracle Enterprise Gateway process to load the configuration for the active Enterprise Gateway.
2. If a passphrase has been set, enter it in the Enter Passphrase dialog, and click OK. Alternatively, if no passphrase has been set, click OK.
3. In the Policy Studio Services tree on the left, select the Oracle Enterprise Gateway process.
4. Right-click, and select Real time monitoring.
5. In the Real time monitoring settings dialog, ensure the following checkboxes are selected:
• Enable real time monitoring
• Path way through policies
• Message payload
6. Click OK.
7. Click the Deploy button in the Policy Studio toolbar to deploy these settings to the Enterprise Gateway. Alternatively, press F6.

Important Note:
Enabling monitoring of the message pathway and/or the message payload may have a negative impact on performance. If you wish to maximize performance, do not enable these settings.

Viewing Real-time Monitoring

You can view a range of monitoring statistics in the Real-time monitoring console (for example, status, audit messages, remote hosts, and Web Services). To launch the Real-time monitoring console from Service Manager, in the Service Manager main menu on the top left, select View -> Real-time Monitoring.

The following example shows the number of messages that have been passed by the Enterprise Gateway to the Web Service:

In Service Manager, each time you click the WSDL link in the Web Services window, the message sent to the example Web Service through the Enterprise Gateway is displayed in the Real-time monitoring console. Similarly, in Service Explorer, each time you send a test message to the example Web Service through the Enterprise Gateway, the message is displayed in the console.

Viewing Message Monitoring

When message monitoring is enabled, the Real-time monitoring console displays details for each message. The following example shows details displayed for messages sent to the ComInfoService through the Enterprise Gateway:

Viewing Message Content

When monitoring of the message path and payload are enabled, the Real-time monitoring console displays the message path and the contents of each response message. To view the message path and the content of the response message sent by the ComInfoService through the Enterprise Gateway, perform the following steps:

1. In the list of monitored messages, select the Message id whose contents you wish to view. This displays the Message path for message id for the selected message.
2. In the message path, select Message version 1:

   Message Path

3. Click the View button on the right of the console to view the contents of the response message.

   Message Contents

Detecting Malformed Messages

Messages with malformed content are blocked by the Enterprise Gateway and displayed in the Real-time monitoring console. To detect a malformed message sent to the ComInfoService and blocked by the Enterprise Gateway, perform the following steps:

1. In Service Explorer, on the Request tab, change the operation name from ns1:getInfo to ns1:getDetails.
2. Click the triangular green send button to send the message to the virtualized Web Service through the Enterprise Gateway. The Response tab displays an HTTP 500 error and a MessageBlocked SOAP fault.
3. In the Real-time monitoring console, on the Status tab, the message is displayed as blocked.

   Message Blocked

4. Click the Audit and Alert Messages tab to view the audit message for the blocked message.

Monitoring a Remote Host

The Remote hosts tab enables you to monitor statistics such as the response time of the Web Service host, and the number of bytes sent and received. To monitor a remote host, perform the following steps:

1. Click the Remote hosts tab.
2. In the list of Configured remote hosts, select the host to display its statistics, for example:

Using Service Monitor

This tutorial explains how to monitor the example Web Service using the real-time monitoring tools provided with the Enterprise Gateway. Service Monitor is a separately installed component that enables you to monitor Web Services and to generate reports on the traffic history of multiple Enterprise Gateways. For details on using Service Monitor, see the following topics:

• Service Monitor Install Guide
• Service Monitor User Guide

Securing the Web Service

When you have performed the steps required to monitor the example Web Service, the next steps are to secure the Web Service using Policy Studio. For details, see Securing a Web Service.