4 Monitoring the SOA Infrastructure

This chapter describes how to monitor the overall status of the SOA Infrastructure or individual partition, Oracle SOA Suite routing topology, SOA Infrastructure performance summary metrics, message delivery processing requests, and service and reference binding components in the SOA Infrastructure.

This chapter includes the following topics:

For more information, see Introduction to the SOA Infrastructure Application.

4.1 Monitoring the Overall Status of the SOA Infrastructure or Individual Partition

You can monitor the overall status of your environment from the Dashboard pages of the SOA Infrastructure or an individual partition. The Dashboard pages enable you to view information such as the following:

  • The overall health of the SOA runtime, including any faults with which to be concerned.

  • The health of deployed applications and adapter endpoints (for example, any problems when the system was restarted or when applications were deployed or upgraded).

  • The health of the business transactions, including any faults with which to be concerned.

  • The key events that occurred in the system in the last operating time range (for example, 24 hours).

The information that is displayed on the Dashboard page of the SOA Infrastructure or an individual partition differs in some sections. Table 4-1 describes the sections of the Dashboard pages and how they differ.

Table 4-1 Dashboard Page Sections at SOA Infrastructure and Individual Partition Levels

Section Displayed on SOA Infrastructure Dashboard Page? Displayed on Individual Partition Dashboard Page?

Key Configuration

Yes

Yes, and also includes the work manager group of the partition.

SOA Runtime Health

Yes

No

System Backlogs

Yes

No

Business Transaction Faults

Yes, shows all faults for the entire SOA Infrastructure.

Yes, shows faults for the individual partition only.

Composites and Adapters Availability

Yes, shows composite and adapter availability for the entire SOA Infrastructure.

Yes, shows composite and adapter availability for the individual partition only.

Search

Yes, shows all instance and bulk recovery job searches and saved searches for the entire SOA Infrastructure.

Yes, shows instance and bulk recovery job searches and saved searches for the individual partition only.

Fault Alerts

Yes, shows error notification alerts for the entire SOA Infrastructure.

Yes, shows error notification alerts for the individual partition only.

The information that you can view on the Dashboard pages is based on your permissions. For example, if you only have permissions on a specific partition, you cannot access the SOA Infrastructure Dashboard page. However, you can access the Dashboard page for that specific partition.

To monitor the overall status of the SOA Infrastructure or individual partition:

  1. Access this page through one of the following options:

    1. To access overall status information for the SOA Infrastructure:

      From the SOA Infrastructure Menu... From the SOA Folder in the Navigator... From the SOA Composite Menu...
      1. Select Home > Dashboard.

      1. Expand SOA.

      2. Select soa-infra > server_name.

      1. Select SOA Infrastructure.

      The SOA Infrastructure Dashboard page displays the following details:

    2. To access overall status information for the individual partition:

      From the SOA Infrastructure Menu... From the SOA Folder in the Navigator...
      1. Select Manage Partitions.

      2. In the SOA Partition column, select a specific partition.

      1. Expand SOA.

      2. Expand soa-infra > server_name.

      3. Select the specific partition.

      The Dashboard page of the selected partition displays the following details:

    You can perform the following overall status monitoring tasks:

4.1.1 Viewing Key Configuration Settings

The Key Configuration section enables you to view important system configuration settings for the SOA profile, instance tracking, default query duration, work manager group (for a partition), and automatic purging. The same configuration settings are displayed on the Dashboard pages of the SOA Infrastructure and individual partition. In addition, the work manager group of the partition is displayed on the Dashboard page of the individual partition.

To view key configuration settings:

  1. View the following details in the Key Configuration section.

  2. Perform the following monitoring and management tasks from this section.

    Element Description

    Profile

    Displays the current configuration profile selected on the SOA Infrastructure Common Properties page (for example, BPM Classic). SOA profiles provide subsets of SOA functionality and reduce the overall memory footprint of the SOA Infrastructure. A default profile is automatically set during installation.

    To change this value:

    1. To the right of the Profile field, click the icon.

    2. Click Change Profile. The SOA Infrastructure Common Properties page is displayed.

    3. From the list, select the profile and click OK.

    4. Restart the server.

    Note: Profile changes, if not done properly, put the system in an unstable state. Only a qualified SOA administrator must immediately restart all Oracle WebLogic Servers on which this SOA Infrastructure is deployed. Otherwise, the system is in an unstable state. For more information about profiles, see Configuring and Oracle BPM Suite Profiles.

    Instance Tracking

    Displays the audit level setting (Off, Production, or Development). This setting determines the level of information to be collected by the message tracking infrastructure. This information is collected in the instance data store (database) associated with the SOA Infrastructure. For details about these settings, see Configuring the Audit Trail_ Payload Validation_ and Default Query Duration.

    To change this value:

    1. To the right of the Instance Tracking field, click the icon.

    2. Click Change Audit Level. The SOA Infrastructure Common Properties page is displayed.

    3. From the Audit Level list, select the appropriate value, and click Apply.

    Default Query Duration

    Displays the time period during which to retrieve instances and faults data. This property controls the amount of instance and fault data fetched by default by all out-of-the-box queries. This value is also displayed as the default time range value on pages with query/search functionality (for example, the Dashboard page regions that include query functionality, the Flow Instances pages, Error Hospital pages, the Resequencer pages, and so on). You can override this value on the corresponding page, as needed.

    Note: It is highly recommended that you set a time period duration because it has a significant impact on the performance of multiple Oracle Enterprise Manager Fusion Middleware Control pages and queries.

    Some of the more data intensive pages do not initially preload the data for performance reasons. You must explicitly request to view the data by clicking a search or refresh button. If you have not specified a different time period, the query executes using the default duration setting.

    The default value is 24 hours. The value is set in the Default Query Duration section on the SOA Infrastructure Common Properties page.

    To change this value:

    1. To the right of the Default Query Duration field, click the icon.

    2. Click Change Default Query Duration. The SOA Infrastructure Common Properties page is displayed.

    3. From the Default Query Duration list, change the time period, and click Apply.

    For more information about setting this property, see Configuring the Audit Trail_ Payload Validation_ and Default Query Duration.

    Work Manager Group

    Displays the work manager group for the partition. This section is displayed only on the Dashboard page of the individual partition.

    Work manager groups isolate partition configuration and request processing. A work manager is an Oracle WebLogic Server entity that represents a logical thread pool. It is similar to a queue in which work items line up for processing.

    For more information, see Managing Work Manager Groups.

    Auto Purge

    Displays whether Oracle SOA Suite is enabled to automatically remove older flow instances, adapter reports, and fault alerts data from the database. By default, this option is enabled for Oracle SOA Suite production installations.

    To change this value:

    1. To the right of the Auto Purge field, click the icon.

    2. Click Set Up Auto Purge. The Auto Purge page is displayed.

    3. Based on the requirements for your environment, select or deselect the Enable checkbox.

    Note: The Auto Purge element is not displayed if you are using the Java database included with the Oracle SOA Suite Quick Start installation option.

    For more information about automatically removing data from the database, see Deleting Large Numbers of Instances with .

    EDN Paused

    This message is only displayed when the delivery of business events has stopped. This occurs in the following scenarios:

    • The edn System MBean Browser property is set to true.

    • When patches are applied, the EDN is automatically placed into paused mode. If the patch fails, EDN remains in paused mode.

    For more information about setting this property, see Tuning EDN Event Bus and Delivery.

4.1.2 Viewing the Overall Runtime Health of the SOA Infrastructure

The SOA Runtime Health section enables you to view the overall health of the SOA Infrastructure in a cluster or a single-node environment and whether the migration of 11g to 12c data has completed. This section is only displayed on the Dashboard page of the SOA Infrastructure.

To view the overall runtime health of the SOA Infrastructure:

  1. View the following details in the SOA Runtime Health section.

    1. If the SOA Infrastructure for each node is running and all composites are successfully loaded, the following message is displayed.

    2. If the data sources are stopped, not targeted to the SOA server, or not working (for example due to a connection timeout), the following message is displayed.

    3. If the Oracle Web Services Manager (OWSM) policy manager is not running, the following message is displayed.

  2. Perform the following monitoring and management tasks from this section.

    Element Description

    Data Migration

    Displays the 11g to 12c data upgrade status. The following message links can be displayed.

    • Data Migration Not Completed

      Click this message link to invoke a message that displays the following details.The migration status of active instances (completed or not completed).The migration status of inactive instances (completed, older than date and not yet migrated, or not completed).

    • Data Migration Completed

      Click the alert icon next to this message link to invoke a message indicating that all data available before the upgrade is now available and you can run the report migration script to view specific details.

      To close this message, click the close icon to the upper right of the message. This invokes a confirmation message in which to select not to display the migration completion message again.

    To run the report migration script, see Section "Using the Upgrade Administration Scripts" of Upgrading Oracle SOA Suite and Business Process Management.

    For information about migration status, see Section "Monitoring Upgrade Status with Fusion Middleware Control" of Upgrading Oracle SOA Suite and Business Process Management.

    soa-infra (server_name)

    Displays the overall status of all nodes in a clustered or single-node environment. Click the server name to go to the home page of the managed server. If the SOA Infrastructure for each node is running and all composites are successfully loaded, the following message is displayed.

    Initialized Successfully
    

    There are several issues that can impact the overall health of the SOA Infrastructure runtime environment:

    • If the data sources are stopped or not working (for example, due to a connection timeout), the following message is displayed:

      Data Sources unavailable: number
      

      The following data sources are monitored:

      - EDNDataSource

      - EDNLocalTxDataSource

      - SOADataSource

      - opss-data-source

      - mds-SOA

      Expand the warning message to display the impacted data source type (for example, EDNDataSource). You can click the data source to access the JDBC Data Sources (Monitoring) page.

    • The SOA Infrastructure Java Transaction API (JTA) application is running, but not all SOA composite applications are loaded. A warning message indicating that the SOA Infrastructure is down and currently initializing is displayed. The SOA Infrastructure may not be completely initialized to administer incoming requests until all deployed composites are loaded. Therefore, the response metrics that are displayed on some Oracle Enterprise Manager Fusion Middleware Control pages may not reflect their actual status. This is most apparent when the SOA Infrastructure is in a cluster with multiple managed servers and a large number of deployed composites. During the initialization stage, Oracle Enterprise Manager Fusion Middleware Control does not prevent you from executing operations such as composite deployment, composite undeployment, and others, even though these operations may not complete successfully. Do not perform operations such as composite deployment, composite undeployment, and others while this message is displayed. Once initialization completes, the message is no longer displayed. You see this after you refresh the page. You can then perform operations.

    • If the OWSM policy manager is not running, the following message is displayed:

      Policy Manager validation failed
      

      - Expand the message and click Navigate to WSM Diagnostics.

      - In the System MBean Browser, click Operations.

      - Click checkPolicyManagerStatus.

      - Click Invoke.

4.1.3 Viewing System Backlogs in the SOA Infrastructure

The System Backlogs section enables you to view the number of messages in the queues. You must click the Refresh Backlogs button to retrieve the message queue backlog counts. This section is only displayed on the Dashboard page of the SOA Infrastructure.

To view system backlogs in the SOA Infrastructure:

  1. View the following details in the System Backlogs section.
  2. Perform the following monitoring and management tasks from this section.
    Element Description

    Messages in Queues

    Displays the number of messages in the queues for the following message types. The number of messages currently in the queue for these message types is not loaded by default.

    • BPEL Invoke

    • BPEL Callback

    • Mediator Parallel Routing

    • EDN WLS JMS

    Refresh Backlogs icon Refresh Backlogs

    Click to refresh the display of the number of messages in the queues.

4.1.4 Viewing Business Transaction Faults

The Business Transaction Faults section enables you to set the specified time period during which to retrieve nonrecoverable faults, faults requiring recovery, recovered faults, and automatically retried system faults at the SOA Infrastructure or individual partition level. The default value is 24 hours.

To view business transaction faults:

  1. View the following details in the Business Transaction Faults section.
  2. Perform the following monitoring and management tasks from this section.
    Element Description

    Last Time_Period

    Specify the time period during which to check for faults.

    Refresh icon Refresh icon

    Click to refresh the page to display the total number of nonrecoverable faults, faults requiring recovery, recovered faults, automatically retried system faults in each partition of the SOA Infrastructure or individual partition, and the inactive resequencer groups count.

    Click a specific graph of a partition to access fault details on the Error Hospital page. When you access the Error Hospital page, the following is displayed:

    • At the SOA Infrastructure level, the specific partition name is automatically populated in the Partition Name list of the Composite filter in the Report Filters section.

    • At the individual partition level, the specific SOA composite application is automatically populated in the Composites field of the Composite filter in the Report Filters section.

    • At the SOA Infrastructure and individual partition levels, the number of inactive (faulted and timed out) resequencer groups is displayed. Click the Inactive Resequencing Group link to access the Mediator Resequencing Groups page.

4.1.5 Viewing SOA Composite Applications and Adapters Availability

The Composites and Adapters Availability section enables you to view the composites that did not start, adapters with connectivity errors, and scheduled downtimes for the composite and adapter endpoints. This section is displayed in both clustered and single-node environments.

To view SOA composite applications and adapters availability:

  1. View the following details in the Composites and Adapters Availability section. On the SOA Infrastructure Dashboard page, the availability of all composites and adapters in the SOA Infrastructure are displayed. On the individual partition Dashboard page, the availability of all composites and adapters within only that partition are displayed.

  2. If you have composite startup errors, expand the message to display the SOA composite application name and time of the error.

  3. If you have EIS connectivity errors, expand the message and place your cursor over the error timestamp to display fault details.

  4. Perform the following monitoring and management tasks from this section.

    Element Description

    Select server icon

    Select the SOA Infrastructure in a clustered or single-node environment for which to obtain the following composite and adapter availability details. For a clustered environment, all managed servers are displayed in the list.

    • Composite start-up error status.

    • EIS connectivity errors status: Errors are displayed when the connection between the endpoint and EIS is down (for example, for the database adapter when the database is down and for the file adapter when the file does not exist at a specified location or the file is not readable or writable). These errors are applicable for adapter service binding component endpoints, and not for reference binding component endpoints.

    • Composite downtime status (up or down): Downtime status typically refers to scheduled downtimes and is more planned than the first two statuses in this list.

    When an error occurs, a warning sign and the number of errors are displayed next to the section.

    1. Expand the section to display the list of composites or adapter endpoints that have problems.

    2. Click the error description for more specific details about the error.

    3. Click the name of a composite or adapter to go to its home page.

4.1.6 Searching for Instances and Bulk Recovery Jobs

The Search section enables you to search for recent instances and bulk recovery jobs. The Bulk Recovery Jobs search option is not displayed if Oracle Enterprise Scheduler is not deployed.

For the Trace Instance, Bulk Recovery, and SOA Diagnostic job to work with remote agent, you must use SSH credentials as host credentials.

To search for instances and bulk recovery jobs:

  1. View the following details in the Search section.

    1. Click Instances to view preseeded and custom instance search filters.

    2. Click Bulk Recovery Jobs to view preseeded job search filters.

  2. Perform the following monitoring and management tasks from this section.

    Element Description

    Instances

    Select to search for recent instances. This search returns instances created within the time period specified by the Default Query Duration property in the SOA Infrastructure Common Properties page. The default time period for which to search is 24 hours.

    1. Click one of the links in the list of predefined search queries and saved search queries to initiate a search.

      With Faults: This search returns recent instances that have faults.

      All: This search returns all instances created in the default time period.

      Saved Searches: Displays the saved searches available for execution. If you create a saved search on the Flow Instances page or Error Hospital page and specify this partition name, the search is displayed in this list.

    Or:

    1. Enter values for any of the following elements and click Search Instances.

      Composite

      Instance Name or ID

      Sensor Name

      Sensor Value

    You are redirected to the Flow Instances page with the search results.

    Bulk Recovery Jobs

    Select to search for recent bulk recovery jobs. This search displays only if Oracle Enterprise Scheduler is deployed, and returns the jobs created within the time period specified by the Default Query Duration property on the SOA Infrastructure Common Properties page. (More search options are provided in the Oracle Enterprise Scheduler page.)

    1. Click one of the links in the list of predefined search queries. You are redirected to the Oracle Enterprise Scheduler page where the search results are displayed.

      Error

      Pending

      All

    Or:

    1. In the Job Request ID, enter a value to find a specific bulk recovery job by its job ID, and click Check Job Status. This field is displayed if Oracle Enterprise Scheduler is deployed.

    You are redirected to the Oracle Enterprise Scheduler job page for viewing the status of the job.

    For more information about the job request ID, see Performing Bulk Fault Recoveries and Terminations in a Single Operation.

For more information about using Oracle Enterprise Scheduler in Oracle Enterprise Manager Fusion Middleware Control, see Administering Oracle Enterprise Scheduler.

4.1.7 Viewing Error Notification Alerts

The Fault Alerts section enables you to view error notification alerts for the SOA Infrastructure and individual partitions if you have the correct permissions. If there are no errors in the system, then this section is visible with the message No Alerts found in place of a list of fault alerts.

To view error notification alerts:

Alerts are triggered when a rule condition is met (for example, you define an alert to trigger if more than 10 faults occur within a 48 hour period). Error alerts are displayed if the Send Alert to Dashboard option is selected on the Create Error Notification Rules page. You create error notification rules on the Create Error Notification Rules page to be sent when specific fault criteria are met.

  1. View the following details in the Fault Alerts section.
  2. Perform the following monitoring and management tasks from this section.
    Element Description

    Rules

    Select to view error notification alerts for the following:

    • All: Click to display all alerts.

    • System: Click to display alerts created at the SOA Infrastructure level.

    • Partition. Click and select the partition for which to view alerts.

    Click the fault number to access error details on the Error Hospital page.

    Alert_Name

    Displays the following details:

    • Name of the alert.

      Click the alert name to view the error notification rule that triggers this alert.

    • Number of faults associated with the alert.

      Click the fault number to go to the Error Hospital page to view details about the faults. The Time part of the Report Filters section on the right side is automatically selected to show you when the fault alert initially occurred and last occurred.

    • Time at which the alert was triggered.

    Note: If you do not select Send Alert to Dashboard on the Create Error Notification Rule page, alerts are not displayed on the Dashboard page.

    For more information, see Creating Error Notification Rules.

4.2 Discovering the Oracle SOA Suite Routing Topology

The Topology Viewer is useful for when you are tasked to administer an existing Oracle SOA Suite environment. The Topology Viewer quickly provides you with a graphical representation of the deployed resources (servers, databases and data sources, SOA composite applications, and so on) and their relationships.

The Topology Viewer shows the routing relationships across components and elements. The Topology Viewer enables you to discover your Oracle Enterprise Manager Fusion Middleware Control environment and identify how requests are routed across components.

For example, you can use the Topology Viewer to understand the following:

  • Which databases your SOA servers rely on

  • Which data sources are used to connect to these databases

  • Which entities such as SOA servers are up and down

  • Performance metrics for components, such as the request processing time for the administration server.

To discover the Oracle SOA Suite routing topology:

  1. From the WebLogic Domain menu, select Routing Topology.

    The Topology Viewer is displayed. The Topology Viewer shows the routing relationships between Oracle Fusion Middleware components (administration server, managed servers, clusters, and databases).

  2. Expand the handles on the left sides of the icons to display additional details. For example, if you expand soa-infra, you can view the partitions in the SOA Infrastructure.
  3. Expand a partition to display the SOA composite applications deployed to that partitions.
  4. From the View By list, select Application. This displays the routing relationships between the applications. The configured Oracle Metadata Services (MDS) repositories are also displayed.
  5. Above the Topology Viewer, click the Up arrow to display targets whose status is running.
  6. From the Options icon, select Annotations and an option to display details such as the state of various entities, which servers are down, and key performance metrics for the components.
  7. Right-click a component (such as soa-infra) to invoke a menu for performing operations. For example, select Home to access the Dashboard page of the application.
  8. Click a line between components to view the JDBC routing relationship, such as the host, port, and database being used.
  9. Place the cursor over the edge of one of the entities (for example, the AdminServer) to invoke a small icon.
  10. Select the icon to display details about server type, host name, and port.
  11. Click more for additional details.

For more information about the Topology Viewer, see Section "Viewing the Routing Topology" of Administering Oracle Fusion Middleware.

4.3 Monitoring SOA Infrastructure Performance Summary Metrics

You can view a summary of SOA Infrastructure performance metrics on the Performance Summary page.

The Performance Summary page provides a graphical representation of the following information by default:

  • Total number of messages in the SOA Infrastructure since the last server restart.

  • Total number of service component messages (BPEL process, Oracle Mediator, human workflow, and business rule (decision service)) since the last server restart.

To monitor SOA Infrastructure performance summary metrics:

  1. Access this page through one of the following options:

    From the SOA Infrastructure Menu... From the SOA Folder in the Navigator...
    1. Select Monitoring > Performance Summary

    1. Right-click soa-infra.

    2. Select Monitoring > Performance Summary.

    The Performance Summary page is displayed.

  2. At the bottom of the page, view additional message information.

  3. Click Show Metric Palette to display a hierarchical tree of all metrics for the SOA Infrastructure. The tree organizes the metrics into various categories of performance data.

  4. Expand a folder and select a metric in the Metric Palette to display a performance chart that shows the changes in the metric value over time. The chart refreshes automatically to show updated data.

  5. Click Slider to display a slider tool that lets you specify the time frame for the data shown in the charts.

For more information about the Performance Summary page, see the online Help for the Performance Summary page and Section "Viewing the Performance of Oracle Fusion Middleware" of Administering Oracle Fusion Middleware.

For information about monitoring message delivery processing requests, see Monitoring Message Delivery Processing Requests.

For information about monitoring SOA composite application summary metrics, see Monitoring SOA Composite Application Performance Summary Metrics.

For information about monitoring service engine statistics, see the following:

4.4 Monitoring Message Delivery Processing Requests

You can monitor SOA Infrastructure message delivery processing requests. These are metrics for the message delivery between the service engines, service infrastructure, and binding components. Once a message is handed over to a service engine, the amount of time it takes to process that message (instance processing time) is not captured in these metrics.

To monitor message delivery processing requests:

  1. Access this page through one of the following options:

    From the SOA Infrastructure Menu... From the SOA Folder in the Navigator...
    1. Select Monitoring > Request Processing.

    1. Right-click soa-infra.

    2. Select Monitoring > Request Processing.

    The Request Processing page enables you to monitor the following details:

    • The average request processing time for both synchronous and asynchronous messages, active requests, requests processed, and faulted requests in the service engines and service infrastructure.

    • The average request processing time, requests processed, and errors occurring in service (inbound) and reference (outbound) binding components.

  2. In the Service Engines section, click a specific service engine (for example, BPEL Engine) to access details such as recent instances using this service engine, components using this service engine, and recent fault occurrences.

For more information, see the following sections:

4.5 Monitoring Service and Reference Binding Components in the SOA Infrastructure

You can monitor all service and reference binding components used in all SOA composite applications deployed to the SOA Infrastructure. Services provide the outside world with an entry point to the SOA composite application. The WSDL file of the service advertises its capabilities to external applications. References enable messages to be sent from the SOA composite application to external services in the outside world.

To monitor service and reference binding components in the SOA Infrastructure:

  1. Access this page through one of the following options:

    From the SOA Infrastructure Menu... From the SOA Folder in the Navigator...
    1. Select Services and References.

    1. Right-click soa-infra.

    2. Select Services and References.

    The Services page displays details about the names and types of the services, the SOA composite applications in which the services are used, the partitions in which the SOA composite applications are deployed, the total number of messages processed, the average processing time, and the number of faults occurring in the services.

  2. In the Service column, click a specific service to access its home page.

  3. In the Composite column, click a specific SOA composite application to access its home page.

  4. In the Partitions column, click a specific partition to access its home page.

  5. Click the References tab.

    The References page displays details about the names and types of the references, the SOA composite applications in which the references are used, the partitions in which the SOA composite applications are deployed, the total number of messages processed, the average processing time, and the number of faults occurring in the references.

  6. In the Reference column, click a specific reference to access its home page.

  7. In the Composite column, click a specific SOA composite application to access its home page.

  8. In the Partitions column, click a specific partition to access its home page.

For more information about services and references, Introduction to Binding Components

4.6 Using SOA Health Check

The SOA Health Check framework provides a number of health checks and health check categories to monitor the health of your system. Checks include memory checks, data source checks, SOA-related service checks, SOA application-targeting checks, BPEL-related checks, and so on.

Startup checks execute automatically at server startup, and periodic checks can be scheduled to run at periodic intervals. You can also execute individual health checks or health check categories using WLST.

This section includes the following topics:

4.6.1 SOA Health Checks

SOA health checks include memory checks, data source checks, SOA-related service checks, SOA application-targeting checks, BPEL-related checks, and so on.

Table 4-2 summarizes the SOA health checks that are available in this release.

Table 4-2 SOA Health Checks

Health Check Name Description

BPELAsyncRequestCheck

Checks if the BPEL asynchronous request count is within the configured threshold of 1000.

BPELComponentInstanceCheck

Checks if the number of open BPEL component instances are within the threshold of 1000. Also checks if the number of faulted BPEL component instances are within the threshold of 500.

DatasourceCheck

Checks if the data sources are appropriately targeted for use by the soa-infra application.

For each data source, the check verifies if the targets of the data source cover all targets of the soa-infra application. If any of the soa-infra application targets is missing from any of the data source targets, an error is raised.

DBStatsCheck

Checks if the MDS database statistics are current.

EDNMessageCheck

Checks if the pending messages count in the EDN event queue and OAOO queue are within thresholds. The threshold limit used for the EDN event queue is 2000 and the threshold limit used for the OAOO queue is 5000.

JDBCPoolsCheck

Checks if the SOA, EDN, and MDS data sources are healthy at runtime.

SOAAppCheck

Verifies targeting of SOA applications. SOA applications should at least target all of the soa-infra application targets.

SOALibraryCheck

Verifies the targeting of SOA, and related, libraries. SOA libraries should at least target all of the soa-infra application targets.

ServiceCheck

Verify if SOA-related services are functional. Currently, this check verifies if the OWSM Policy Manager service is functional.

MemoryCheck

Checks if the available (free) heap memory is above the configured threshold of 25%.

A health check ends with one of the following states:

  • Success: The check completed, and passed.

  • Error: The check completed, but did not pass.

  • Warning: The check completed and passed, but something may need user attention.

  • Failure: The check could not be completed/executed.

  • Skipped: The check is not applicable for the environment.

  • Disabled: The check is disabled and cannot be run.

4.6.2 SOA Health Check Categories

The SOA health check framework logically groups health checks into health check categories. A health check can be part of more than one category.

When you execute a health check category, using the WLST command for example, all health checks in the category automatically get executed. Certain health check categories are automatically executed. For example, the Startup category, if enabled, runs all the startup health checks at server startup.

Table 4-3 summarizes the SOA health check categories and their constituent health checks.

Table 4-3 SOA Health Check Categories

Health Check Category Description Default Health Checks included in the Category

Startup

Runs at server startup

DatasourceCheck, JDBCPoolsCheck, SOAAppCheck, SOALibraryCheck, ServiceCheck, MemoryCheck

Quick

Lightweight set of checks

JDBCPoolsCheck, ServiceCheck, MemoryCheck

Intermediate

Intermediate set of checks

BPELAsyncRequestCheck, BPELComponentInstanceCheck, DBStatsCheck, EDNMessageCheck

Extensive

Extensive set of checks

For future use

Config

Configuration checks

DatasourceCheck, SOAAppCheck, SOALibraryCheck

4.6.3 Invoking SOA Health Checks

The SOA health checks can be invoked in a number of ways. You can have checks that run automatically at server startup or those that run at periodic intervals. You can use the WLST command-line utility to manually run health checks.

Server Startup

When a production SOA server starts, health checks in the Startup category are automatically run. The startup health check is enabled by default. The result of the startup run is logged in the SOA server logs.

You can choose to disable the startup run using WLST commands. You can also change the category of tests run at startup using the appropriate WLST command. See "enableHCStartupRun" and "setHCStartupRunCategory" in Oracle Fusion Middleware WLST Command Reference for SOA Suite.

Periodic Invocation

SOA health check is pre-configured with periodic runs that automatically run on the production SOA server.Table 4-4 lists the pre-configured periodic runs.

Table 4-4 Pre-Configured Periodic Runs

Periodic Run Name Category Scheduling Enabled by Default?

Frequently

Quick

Every two hours at :07

Yes

Daily

Intermediate

Every day at 05:15

Yes

Weekly

Extensive

Every Sunday at 03:30

No (for future use)

Periodic runs are enabled by default. The result of the periodic runs are logged in the SOA server logs.

You can disable periodic runs, or change the health-check category associated with a periodic run. You can also change the scheduling, or add new periodic runs. See "createHCPeriodicRun", "enableHCPeriodicRun", "setHCPeriodicRunInterval", "setHCPeriodicRunSchedule", and "setHCPeriodicRunCategory" in Oracle Fusion Middleware WLST Command Reference for SOA Suite.

WLST Invocation

You can use WLST commands to:

  • List health checks

  • Configure health checks

  • List health check categories

  • Execute a health check by name

  • Execute a category of health checks

  • Get results (Returned as an HTML report at the specified location)

  • Purge results

See "SOA Health Check Commands" in Oracle Fusion Middleware WLST Command Reference for SOA Suite for details on all health check commands.

The WLST commands need to be executed in the online mode. You must be connected to the SOA server.

4.7 Monitoring and Troubleshooting SOA-Wide Issues Using IWS Reports

Integration Workload Statistics (IWS) Reports provide SOA system-wide reports that can help you analyze utilizations, identify potential bottlenecks and backlogs, and perform top-down analysis of your integration system.

Note:

This SOA Suite feature is part of Oracle Integration Continuous Availability. Please refer to the Oracle Fusion Middleware Licensing Information for more details on Oracle SOA Suite for Middleware Options.

So, for instance, if there are stressed components or endpoints in your SOA system that are slowing down the system, IWS reports can help you narrow down on these. For example, a slow FTP or database adapter reference endpoint can be identified in the reports. Likewise, a BPEL process running slower than usual can also be identified. You can look at internal queue backlogs, like BPEL queues and EDN queues. SOA composite-wise summaries are also available.

IWS reports can include metrics like system resource usage, composite statistics, statistics for internal system queues, statistics for synchronous and asynchronous business processes, and endpoint statistics. The components supported in this release include BPEL Service Engine, EDN, Web Service Binding, File Adapter, JMS Adapter, FTP Adapter, DB Adapter, AQ Adapter, and MQ adapter.

Refer to Statistics Included in an IWS Report for more information on the statistics collected.

IWS takes periodic snapshots of performance statistics to generate these reports. You can choose the granularity of data collected for your IWS reports. The following table illustrates the data collection levels, or statistics levels, and the data collected for each level.

Table 4-5 Data Collection Levels for IWS Reports

Data Collection Level/Statistics Level Data Collected
OFF No data is collected. This is the default level.
MINIMUM System-wide resource usage data.
BASIC MINIMUM + Service and reference endpoint statistics, BPEL and EDN backup queue statistics, BPEL instance statistics.
NORMAL BASIC + Data on BPEL activities like Receive, Invoke, Pick, and onMessage.
FINEST NORMAL + Data on all BPEL activities.

4.7.1 Enabling and Configuring IWS

Integration Workload Statistics (IWS) snapshot data is collected at periodic intervals. You can enable snapshot data collection, configure snapshot interval, and the granularity of data collected.

Use the following steps to enable and configure IWS using Enterprise Manager Fusion Middleware Control:
  1. Select Monitoring > IWS Reports from the SOA Infrastructure menu.
    The IWS Reports page appears.
  2. Click Configure near the top right corner of the page.
    The Configure IWS Data Collection dialog appears.
  3. Select a Snapshot Interval in minutes.
    The snapshot interval is the periodic interval at which data snapshots are collected.
  4. Select a Data Collection Level. The level selected determines the metrics that are collected.
    The default level is OFF, which in effect disables IWS data collection. Use the Minimum level to collect only system-wide resource usage data. The Basic level additionally includes service and reference endpoint statistics, BPEL and EDN backup queue statistics, and BPEL instance statistics. If you choose Normal, it includes additional statistics on BPEL activities like Receive, Invoke, Pick, and onMessage. The Finest level additionally includes data on all BPEL activities.
  5. Click OK to save your configuration changes.
You have now configured the IWS data collection settings.

4.7.2 Generating an IWS Report

Use the IWS Reports page to create SOA-wide reports that help you identify bottlenecks and backlogs in the system. Integration Workload Statistics (IWS) include metrics like system resource usage, composite statistics, statistics for internal system queues, statistics for synchronous and asynchronous business processes, and endpoint statistics.

Use the following steps to create an IWS report in Enterprise Manager Fusion Middleware Control:
You must have already configured IWS data collection and set a snapshot interval. See Enabling and Configuring IWS for more information.
  1. Select Monitoring > IWS Reports from the SOA Infrastructure menu.
    The IWS Reports page appears.
  2. Select the period for which you wish to generate a report. Select timestamps for Start Date and End Date.
    Ensure that the time period does not span server restarts, or periods where you have disabled IWS by setting Data Collection Level to OFF.
  3. Select the SOA Server Name.
    You can either accept the default server, or choose a different node in cases of multi-cluster environments. For clusters, you can also choose the cluster name to generate a consolidated report for all nodes in the cluster.
    (Optional) Enter the result of the step here.
  4. Optionally choose a partition name if you are using composite partitions and wish to limit your report to a particular partition.
    The Select Composites field appears. This option enables you to select from all composites in the selected partition.
  5. Under Select Composites, optionally choose one or more composite names to restrict your report to the specified composite applications.
  6. Optionally change the number of results that are displayed.
    So, if you choose the default of 10, the 10 slowest endpoints, the 10 longest running business processes, and so on, are selected.
  7. Click the appropriate report format near the top right of the window to generate and download the report.
    You can choose between CSV (comma-separated values), HTML, and XML formats.
The IWS report is generated and downloaded.

4.7.2.1 About the IWSReport MBean

You can use the IWSReport MBean, and its associated operations, to retrieve information about the data collected for your Integration Workload Statistics (IWS) reports. Data such as snapshot IDs, date, and timestamps can be retrieved. IWS report operations enable you to generate IWS reports using the supplied snapshot parameters.

Select Administration > System MBean Browser from the SOA Infrastructure menu to access the System MBean Browser. Refer to for more information on the System MBean Browser.

You can search for the IWSReport MBean, which can be found under Application Defined MBeans > oracle.as.soa.iws > Server : name > Application : name > SOAIWSReportMXBean.

The following image shows the various operations, and their descriptions, available for the IWSReport MBean.

System MBean Browser showing IWSReport Operations tab.

4.7.2.2 WLST Commands to Generate IWS Reports

You can use WLST commands to generate IWS reports or retrieve IWS metrics like IWS data collection level or IWS snapshot information.

IWS WLST Commands

You can retrieve detailed help, and list of parameters, for any command by typing help(‘command’) while connected to the SOA server in the WLST online mode.

The following table lists the various WLST IWS configuration commands.

Table 4-6 IWS Configuration Commands

WLST Command Name Description
getSoaIWSSnapshotInterval Retrieves the snapshot metrics collection interval.
setSoaIWSSnapshotInterval Sets the snapshot metrics collection interval in minutes.
getSoaIWSStatisticsLevel Retrieves the SOA IWS Statistics level (data collection level).
setSoaIWSStatisticsLevel Sets the SOA IWS Statistics level.
getSoaIWSStatisticsLevelList Retrieves the SOA IWS Statistics level list.

The following table lists the various WLST IWS snapshot retrieval and reporting commands.

Table 4-7 IWS Snapshot Retrieval and Reporting Commands

WLST Command Name Description
getSoaIWSSnapshotInfo Retrieves snapshot info from a SOA server or all servers for the supplied number of hours.
getSoaIWSSnapshotInfoByDate Retrieves snapshot info from a SOA server or all servers for the supplied time period.
getSoaIWSReportBySnapshotID Generates a SOA IWS Report for the supplied snapshot IDs.
getSoaIWSReportByDateTime Generates a SOA IWS Report for the supplied time period.

4.7.3 Statistics Included in an IWS Report

An Integration Workload Statistics (IWS) report contains various statistics, depending on the data collection level that you have set. In addition to system-wide resource usage data, the report can include service and reference endpoint statistics, BPEL and EDN backup queue statistics, and BPEL instance statistics. Statistics on BPEL activities may also be included.

The IWS report contains the following broad sections when the data collection level is set to finest:

  • System Resource Usage

    Statistics include Java Virtual Machine (JVM) statistics like CPU utilization and memory utilization (for JVM heap and non-heap memory), SOA Data Source statistics that show active connections and connection pool details, and SOA Work Manager statistics that include details on threads.

  • Composite (Rollup) Statistics

    Aggregate composite-wise statistics that indicate flow rate (throughput/transactions per second) and latency (in milliseconds) for the composite endpoints and internal backup queues (EDN and BPEL queue).

  • Slowest Composite Endpoints

    Aggregate composite-wise statistics that indicate the latency (in milliseconds) and flow rate (throughput) for the slowest endpoints.

  • Backups in Internal Queues

    Aggregate statistics for the backups in internal system queues (BPEL queue and EDN queue).

  • Longest Running Business Processes

    Aggregate statistics for top asynchronous and synchronous business (BPEL) process instances based on execution time

  • Most Time-Consuming Business Process Activities

    Aggregate statistics for top business process activities (BPEL activities like Receive, Invoke, etc) based on execution time.