11 Discovering and Monitoring Oracle Service Bus

This chapter describes how you can discover and monitor Oracle Service Bus (OSB) using Enterprise Manager Cloud Control.

In particular, this document covers the following:

11.1 Supported Versions

The following are the versions of OSB that are supported for monitoring in Enterprise Manager Cloud Control Release 12c.

  • Aqualogic Service Bus 2.6

  • Aqualogic Service Bus 3.0

  • Oracle Service Bus 10gR3

  • Oracle Service Bus 11.1.1.2.0

  • Oracle Service Bus 11.1.1.3.0

  • Oracle Service Bus 11.1.1.4.0

  • Oracle Service Bus 11.1.1.5.0

  • Oracle Service Bus 11.1.1.6.0

  • Oracle Service Bus PS6 (11.1.1.7.0)

  • Oracle Service Bus (12.1.0.3)

11.2 Understanding the Discovery Mechanism

The OSB deployed to Oracle WebLogic Managed Server is automatically discovered in Enterprise Manager Cloud Control when that Oracle WebLogic Managed Server is discovered and added to Enterprise Manager Cloud Control.

The discovery of OSB depends on the whether the Oracle WebLogic Managed Server is already being monitored in Enterprise Manager Cloud Control.

  • If Oracle WebLogic Managed Server is not being monitored in Cloud Control, then first discover and add it to Cloud Control; this will automatically discover the OSB that is deployed to it.

  • If Oracle WebLogic Managed Server is already being monitored in Cloud Control, then refresh the membership of the Oracle WebLogic Server Domain to which the Oracle WebLogic Managed Server belongs. This will automatically discover the OSB that is deployed to it.

For instructions to discover OSB, see Section 11.5, "Discovering Oracle Service Bus".

11.3 Understanding the Discovery Process

The following table describes the overall process involved in discovering and monitoring OSB in Enterprise Manager Cloud Control. Follow the instructions outlined for each step in this process to successfully discover and monitor your OSB.

Table 11-1 Discovery Process

Step Requirement Description

1

Oracle Service Bus

Install the OSB software.

Note: Before you launch the OSB Deployment Procedure, ensure that Sun JDK has been installed.

2

Enterprise Manager Cloud Control

Install Enterprise Manager 12c.

For information about installing the base release of Enterprise Manager Cloud Control, see the Enterprise Manager Cloud Control Basic Installation and Configuration Guide available at:

https://docs.oracle.com/en/enterprise-manager/

Oracle recommends that you install the Enterprise Manager Cloud Control components on a host that is different from the host where OSB is installed. For example, if OSB is installed on host1.xyz.com, then install and configure Oracle Management Service (OMS) and the Management Repository on host2.xyz.com.

3

Oracle Management Agent

(Management Agent)

Install Oracle Management Agent 12c on the host where OSB is installed.

If OSB and Enterprise Manager Cloud Control are on the same host, then you do not have to install a separate Management Agent. The Management Agent that comes with Enterprise Manager Cloud Control is sufficient. However, if they are different hosts, then you must install a separate Management Agent on the host where OSB is installed. Alternatively, the Management Agent can also be installed on a different host and made to remotely monitor the OSB target on another host.

You can install the Management Agent in one of the following ways:

For information about installing the Management Agent, see the Enterprise Manager Cloud Control Basic Installation and Configuration Guide available at:

https://docs.oracle.com/en/enterprise-manager/

4

One-Off Patches

The support for discovering and monitoring of OSB is enabled only when the one-off patches as described in Section 11.4, "Downloading One-Off Patches" are applied to the WebLogic Server Home where OSB is running.

5

Discovery in Enterprise Manager Cloud Control

OSB is automatically discovered when the Oracle WebLogic Server Domain to which it is deployed is discovered and added to Enterprise Manager Cloud Control.


11.4 Downloading One-Off Patches

To view OSB services in Enterprise Manager Cloud Control, you must apply the following patches to your OSB servers.

Table 11-2 One-Off Patches

Oracle Service Bus Version ID Password

Oracle Service Bus 2.6

EMMU

83XNT2D4

Oracle Service Bus 2.6.1

9NAF

TLZE4IPI

Oracle Service Bus 3.0

RPCD

JJEC2EY2

Oracle Service Bus 10.3.0

9HPA

FFLQHDHP

Oracle Service Bus 10.3.1

No Patch Required

 

Oracle Service Bus 11.1.1.3.0 and 11.1.1.4.0, and Oracle Service Bus PS4, PS5 and PS6

No Patch Required

 

Oracle Service Bus 12.1.0.3

No Patch Required

 

You can apply the patches in one of the following ways:

  • Online mode - Using the SmartUpdate tool available with Oracle WebLogic Managed Server

  • Offline mode - Manually copying the JAR files and classes to the OSB directories

For information about downloading these patches and applying them in either offline or online mode, see My Oracle Support Note 804148.1. You can access My Oracle Support at:

https://support.oracle.com/CSP/ui/flash.html

Note:

After applying the patches, restart the WebLogic domain and all of the management agents monitoring the domain.

11.5 Discovering Oracle Service Bus

The OSB deployed to Oracle WebLogic Managed Server is automatically discovered in Enterprise Manager Cloud Control when that Oracle WebLogic Managed Server is discovered and added to Enterprise Manager.

Before discovering OSB, identify whether the Oracle WebLogic Managed Server is already being monitored in Enterprise Manager.

  • If Oracle WebLogic Managed Server is not being monitored in Enterprise Manager, then first discover and add it to Enterprise Manager Cloud Control; this will automatically discover the OSB that is deployed to it.

  • If Oracle WebLogic Managed Server is already being monitored in Enterprise Manager, then refresh the membership of the Oracle WebLogic Server Domain to which the Oracle WebLogic Managed Server belongs. This will automatically discover the OSB that is deployed to it.

This section outlines the instructions for discovering OSB for the cases described above. In particular, this section covers the following:

11.5.1 Discovering OSB Deployed to WLS Not Monitored by Enterprise Manager

To discover OSB deployed to Oracle WebLogic Manager Server that is not monitored in Cloud Control, first discover that Oracle WebLogic Manager Server in Enterprise Manager Cloud Control; this will automatically discover the OSB that is deployed to it. To discover Oracle WebLogic Manager Server, follow these steps:

  1. From the Targets menu, select Middleware.

    Enterprise Manager Cloud Control displays the Middleware page that lists all the middleware targets being monitored.

  2. In the Middleware page, select Oracle Fusion Middleware/WebLogic Server Domain from the Add drop-down list and click Go.

    Enterprise Manager Cloud Control displays the Add Oracle Fusion Middleware / WebLogic Server Domain wizard that captures the details of the Oracle WebLogic Server Domain to be discovered and monitored.

  3. In the Add Oracle Fusion Middleware / WebLogic Server Domain wizard, specify the required details and click Next on each page to reach the end of the wizard.

    For information about the details to be provided for each page of the wizard, click Help on each page.

  4. In the last page of the Add Oracle Fusion Middleware / WebLogic Server Domain wizard, click Finish to complete the discovery process and add the target to Cloud Control for monitoring purposes.

    Enterprise Manager displays the Middleware page with a confirmation message that confirms that the Oracle WebLogic Manager Server has been successfully added to Cloud Control.

    In the Middleware page that shows all the middleware targets being monitored, you can see the Oracle WebLogic Managed Server and the OSB you just added. Note that, at this point, OSB will be the last target listed in the table. To see it nested under its Oracle WebLogic Managed Server, click Refresh on this page. Alternatively, navigate to another tab or page, and then return to the Middleware page.

Note:

  • After discovering and adding OSB to Enterprise Manager Cloud Control, you can monitor its status from the OSB Home page. You can use the Services page to view a list of services.

    For the first collection that happens, you will see the value "0" for all the metrics that are enabled in Oracle Enterprise Manager Release 12c. This is an expected behavior. From the second collection onwards, you should see the actual metric values. However, if you still see the value "0", then perhaps the service monitoring is turned off. To resolve this issue, on the Services page, click Launch Console to access the OSB Console, and turn on the service monitoring and set the level to "pipeline" or "action"

  • In the case of clustered OSB domain, the Management Agent installed on Admin Server host should be used to discover the entire domain. This constraint is not applicable for version 12.1.0.2 of Cloud Control. This is only valid up to version 12.1.0.1 of Cloud Control.

For additional information about Fusion Middleware discovery, see Oracle Enterprise Manager Cloud Control Administrator's Guide.

11.5.2 Discovering OSB Deployed to WLS Monitored by Enterprise Manager

To discover OSB deployed to Oracle WebLogic Managed Server that is already being monitored in Cloud Control, refresh the membership of the Oracle WebLogic Server Domain to which the Oracle WebLogic Managed Server belongs. This will automatically discover the OSB that is deployed to it.

To refresh the membership of the Oracle WebLogic Server Domain to which the Oracle WebLogic Managed Server belongs, follow these steps:

  1. From the Targets menu, select Middleware.

  2. On the Middleware page, select the Oracle WebLogic Server Domain target from the list of Middleware targets being monitored.

  3. On the Oracle WebLogic Server Domain Home page, in the General section, click Refresh Domain. Enterprise Manager Cloud Control displays the membership page that lists the OSB that is currently not being monitored. Click OK.

    Enterprise Manager Cloud Control refreshes the membership and returns to the Oracle WebLogic Server Domain Home page.

    Note:

    On the Oracle WebLogic Server Domain Home page, in the Status section, the legend of the status pie chart may not show an increased count to indicate the newly added OSB target. This is an expected behavior because Enterprise Manager Cloud Control takes a few seconds to reflect the membership details in this section.
  4. Click the Members tab and verify whether the OSB has been added.

11.6 Enabling Management Packs

Besides monitoring the status of OSB, if you want to gain access to additional value-added features, then you must enable the Management Pack for SOA.

To enable the Management Pack for SOA:

  1. From the Setup menu, select Management Packs, then select Management Pack Access.

    Enterprise Manager Cloud Control displays the Management Pack Access page.

  2. In the Management Pack Access page, from the Search list, select Oracle Service Bus.

    Enterprise Manager Cloud Control lists all the Oracle Service Bus targets being monitored.

  3. From the table, for the Oracle Service Bus target you are interested in, enable the SOA Management Pack Enterprise Edition and click Apply.

11.7 Monitoring Oracle Service Bus in Cloud Control

Enterprise Manager Cloud Control helps you monitor the health of Oracle Service Bus targets deployed to Oracle WebLogic Managed Servers. When you discover Oracle WebLogic Managed Servers, Cloud Control automatically discovers the Oracle Service Bus targets deployed to them and adds them for central monitoring and management.

For each Oracle Service Bus target being monitored, Cloud Control provides information about its status, availability, performance, services, alerts, business services, proxy services, pipeline services, and split-join services. It also allows you to view the latest configuration details, save them at a particular time, and compare them with other Oracle Service Bus instances. Oracle Service Bus also provides a graphical view representation for the dependencies between proxy services and business services.

In addition to monitoring capabilities, Cloud Control also allows you to black out an Oracle Service Bus target and create infrastructure services. While blackout helps you suspend the monitoring of the target for a temporary period (for example, during maintenance), infrastructure services are dependency services that are created to identify the infrastructure components on which the Oracle Service Bus target depends.

11.7.1 Enabling Monitoring for OSB Services

If you are not able to view OSB data on Enterprise Manager pages, it may be because monitoring is disabled for OSB Services. Before you can view OSB data in Enterprise Manager, check to see if monitoring is enabled for OSB Services. You can do that by following these steps:

  1. From the Targets menu, select Middleware.

  2. On the Middleware page, select a Oracle Service Bus target. The Oracle Service Bus home page is displayed.

  3. On the Oracle Service Bus home page, click Fusion Middleware Control.

  4. Log into the OSB target.

  5. To enable monitoring, on the Global Settings tab, select Monitoring Enabled option.

    Note:

    For a more information about monitoring Oracle Service Bus, see Oracle Fusion Middleware Administrator's Guide for Oracle Service Bus.
  6. Click Apply.

11.8 Generating Oracle Service Bus Reports Using BI Publisher

You can use Enterprise Manager to print Oracle Service Bus reports using BI Publisher Enterprise Reports. Oracle Business Intelligence (BI) Publisher is an enterprise reporting solution for authoring, managing, and delivering highly formatted documents. Oracle BI Publisher also allows you to build custom reporting applications that leverage existing infrastructure. Reports can be designed using familiar desktop products and viewed online or scheduled for delivery to a wide range of destinations.

For example, you can generate an OSB Services Report that describes the way OSB services have been performing over a period of time. The report provides charts to list the top 5 OSB Services and a table with critical metric details for all the services.

The following table describes the OSB-related reports you can choose.

Table 11-3 OSB Reports

OSB Report Description

OSB Service Summary Report

The OSB Service Summary Report provides information about the Average Response Time, Open Instances Count, Fault Instances Count, and Web Service Security Violation Count for the selected service. The OSB Service Summary Report displays a chart with the top 5 OSB services based on Average Response Time or Throughput across the selected OSB services for the specified time period. The report can be sorted based on a performance metric (for example, Average Response Time) or a usage metric (for example, Instance Count). As part of the report parameters setting, you can use options that allow you to select the OSB Service by Projects or by selecting individual services.

OSB Service Operations Summary Report

The OSB Service Operations Summary Report provides internal operation level details for the selected service. The details in the report cover the Average Response Time, Open Instances Count, Fault Instances Count, and Web Service Security Violation Count. The report can be sorted based on a performance metric or a usage metric. As part of the report parameters setting, you can use options that allow you to select the OSB Service by Projects or by selecting individual services.

OSB Proxy Service Flow Component Performance Summary Report

A message flow is composed of components that define the logic for routing and manipulating messages as they flow through a proxy service. The OSB Proxy Service Flow Component Performance Summary Report provides internal flow component details for the selected proxy service. The details in the report display the Average Response Time, Open Instances Count, Fault Instances Count, and Web Service Security Violation Count. The report can be sorted based on a performance metric or a usage metric. As part of the report parameters setting, you can use options that allow you to select the OSB Service by Projects or by selecting individual services.


To print OSB reports using BI Publisher Enterprise reports, follow these steps:

  1. From the Enterprise menu, click Reports, and then click BI Publisher Enterprise Reports.

    Enterprise Manager Cloud Control displays the login page for BI Publisher Enterprise Reports.

  2. Enter your credentials to log into BI Publisher.

    The BI Publisher Enterprise page displays, showing you Recent reports, Others, and Favorites. You can use this page to create a new report, submit a report job, and perform other tasks.

  3. Click the Report you want to display.

  4. On the Report page, use the parameter filters to tailor the report structure that displays, then click Refresh.

    You can view the OSB Services Report using the filters based on the various search parameters available at the top of the page, such as Target Name, Date Range, and so on. Similarly, you can view the report based on the Sort By option as well, allowing you to sort the report by Service Name or Average Response Time, for example.

    You can refresh the report anytime by clicking the Refresh icon on the upper right side of the OSB Service Report tab. You can hide or display the search parameters by clicking the Parameters icon. You can choose to view the report in various formats such as HTML, PDF, RTF, Excel, and PowerPoint by clicking the View Report icon. Likewise you can display more available actions by clicking the Actions icon. For more help about using BI Publisher, click the help icon.

11.9 Troubleshooting Oracle Service Bus

This section describes the errors you might encounter while discovering OSB, and the workaround steps you can follow to resolve each of them.

11.9.1 Required Patches Missing

The following error occurs when you try to discover OSB from an Oracle WebLogic Admin Server that has not been patched with the required one-off patches.

Table 11-4 oracle.sysman.emSDK.emd.fetchlet.FetchletException Error - Workaround Steps

Error Message Workaround Steps
oracle.sysman.emSDK.emd.fetchlet.FetchletException: 
The MBean is not available on the OSB instance. The 
required EM plug in patch should be missing on OSB 
instance.

Apply the one-off patches as described in Section 11.4, "Downloading One-Off Patches".


11.9.2 System and Service

The following error occurs if configuration information has not been collected for the selected Application Server.

Table 11-5 Create System and Service Error - Workaround Steps

Error Message Workaround Steps
An error encountered while discovering the 
dependencies. This may occur if some configuration 
information is missing. Check whether the 
configuration information was collected for the 
dependent targets and then try again.

Collect the latest configuration data by navigating to the Application Server Home page and clicking Configuration and then select Last Collected from the Application Server menu.


11.9.3 SOAP Test

The following error occurs when the Management Agent is upgraded to Enterprise Manager 12c with OMS 10.2.0.5.

Table 11-6 SOAP Test Error - Workaround Steps

Error Message Workaround Steps
Add SOAP Test failed. The selected service
has an invalid or incorrect WSDL URL. Check
whether the Oracle Service Bus Target URL
value is valid in the Monitoring
Configuration page of the selected target.
To access the Monitoring Configuration
page, go to the Oracle Service Bus Homepage
and from the Related Links section, select
Monitoring Configuration.

If the Management Agent has been upgraded to 12c, the following workaround must be applied to support the SOAP test.

In the Monitoring Configuration page for the OSB target, set the Server URL to Access Proxy Services property to the URL for the specific WebLogic Server target. The URL must be in the format: http://<host>:<port>/. For example, http://stade61.us.example.com:7001/