Logging for Web Services

Overview

To extend logging support to more granular level and provide inside-out views for web service activities, Oracle E-Business Suite Integrated SOA Gateway provides an enhanced, flexible web service logging mechanism. An integration administrator can configure log settings at the service type (SOAP or REST) level of an interface. This includes selecting a desired interface name and service type that the logging feature should be set, enabling or disabling the design-time log, and selecting an appropriate runtime log severity level. Additionally, the web service auditing feature can be enabled or disabled through the same logging user interface at the service type level.

With proper logging setups and configuration, you can easily monitor and audit SOAP and REST service activities provided through Oracle E-Business Suite Integrated SOA Gateway. You can track log messages and troubleshoot any issues occurred at design time and runtime. Moreover, the administrator can delete existing log settings, and purge audit information through Service Monitor if needed.

Important: In this release, logging feature is supported for both SOAP and REST services.

Key Features

The enhanced web service logging feature includes the following features:

Design-time logs capture each stage of service generation and development lifecycle activities only if the design-time log for a desired service type (SOAP or REST) is enabled for an interface. For example, if the selected interface can be exposed as both SOAP and REST service types, you must select either SOAP or REST from the Service Type drop-down list for the logging to be enabled in one configuration.

Note: For interfaces that can be available as both SOAP and REST services, to enable the logging and auditing features for both service types of the same interface, you need to create two separate configurations for each service type.

Runtime logs record service processing details during the invocation of an Oracle E-Business Suite service if the service with a desired service type has runtime log enabled. If log information is available for a given instance, the Log icon appears for that instance in Service Monitor. The administrator can view the log messages.

Auditing allows you to monitor and track SOAP service activities passed through Oracle SOA Suite and REST service activities if the auditing feature for a desired service type of an interface is enabled. All messages for the specified service type of an interface including the associated payloads and fault messages can be saved and audited through Service Monitor.

To better understand the logging feature, the following topics are discussed in this chapter:

Accessing the Logging Configuration User Interface

To access the log and audit setup page, log in to Oracle E-Business Suite as a user who has the Integration Administrator role.

Select the Integrated SOA Gateway responsibility from the navigation menu, and then select Administration > Configuration. The Administration tab appears with the Configuration subtab.

Note: The Administration selection from the navigation menu appears only to the users who have the Integration Administrator role after logging in to Oracle E-Business Suite with the Integrated SOA Gateway responsibility.

All administrative tasks performed outside the Integration Repository user interface are grouped and displayed under the Administration tab. These tasks include managing log and audit setups in the Configuration subtab, monitoring inbound invocations for Oracle E-Business Suite services in the Service Monitor subtab, and monitoring outbound service invocations through Service Invocation Framework in the Invocation Monitor subtab.

Log & Audit Setup Details Page

the picture is described in the document text

The Log & Audit Setup Details page is the entry page to perform all the following logging setup and management activities:

Viewing and Searching Existing Configurations

Logging is enabled at the service type level of an interface. When an integration administrator logs in to Oracle E-Business Suite, then selects the Integrated SOA Gateway responsibility, and then selects the Administration > Configuration link from the navigation menu, the Log & Audit Setup Details page appears. All existing log configurations by interface are automatically displayed in the configuration table.

Log & Audit Setup Details Page with Existing Configurations Displayed

the picture is described in the document text

Each log entry listed in the table contains interface name, internal name, product name, service type (REST or SOAP), service status, web service status, design-time log status (On or Off), runtime log severity level, and audit feature status (On or Off).

Searching Existing Configurations

Search feature is available only if there are more than 10 interfaces that have log settings configured. In this situation, the Interface Name field appears on the top of this page letting you filter or search the configurations by interface name. After specifying the desired interface name (such as 'Order%') that you want to view the configuration details, click Search to run the query. All interface names that match your search criteria will be listed in the table.

If no log configuration has been defined, then an empty table with message 'No interface level logging configuration is defined.' appears.

From the configuration table, you can perform the following tasks:

To view and search existing configurations:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Administrator role. Select the Integrated SOA Gateway responsibility.

    From the navigation menu, select the Administration > Configuration link from the menu selection. The Log & Audit Setup Details page is displayed.

  2. All existing log and audit configurations are automatically displayed by interface name in the table.

  3. If there are more than 10 configurations listed in the table, you can perform a search by entering interface name and click Search to run the query. All matched interfaces will be listed in the table.

  4. To delete existing configurations, select desired settings that you want to delete and click Delete to remove them from the database.

  5. To add a new configuration, click + (Add Another Row) icon to add a new setting.

Adding a New Configuration

With the support for both SOAP and REST services in the logging mechanism, you can configure new log settings at the service type level of an interface. After you click the + (Add Another Row) icon in the Log & Audit Setup Details page, an empty row is added to the end of the current configuration table letting you add a new configuration for a desired interface. This includes selecting a desired service type, specifying runtime log severity information (disabling it with value 'Off'), and enabling or disabling the design-time log and the service auditing feature for the selected interface.

Note: Only if the design-time log is enabled for a specified service type of an interface, design-time activities will then be captured and logged. These activities include the Generate, Deploy, Undeploy, Reset, Retire, and Activate actions for SOAP services and the Deploy and Undeploy actions for REST services. Without enabling the design-time log, the logs will not be written.

Enter information in the following fields to add a new configuration:

Note that log messages can be correlated across application and database servers. If a new configuration is added for a service type of an interface that has been deployed, the newly-configured log setting including the runtime log level configured for that deployed service will be added to Oracle SOA Suite if it's for the SOAP service type. When the configuration is deleted for a deployed service, the runtime log level would be reset at the composite level as well in Oracle SOA Suite for SOAP services. The same mechanism applies when an integration administrator updates an existing log level for a deployed service, that is the new log level will be updated in the database.

If a new configuration is added for a service type of an interface that is not deployed, then the runtime log configuration including log level set for that service would be effective after the service with desired service type is deployed.

To add a new configuration:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Administrator role. Select the Integrated SOA Gateway responsibility.

    Select Administration > Configuration from the navigation menu. The Log & Audit Setup Details page is displayed.

  2. To add a new configuration, click + (Add Another Row) icon.

    An empty row appears allowing you to enter information in the following fields:

    • Interface Name: Specify an appropriate interface name for the log is configured.

      Once the Interface Name field is selected, the associated Internal Name, Product, and Service Status fields are automatically populated. The rest of configuration fields such as the Design Time Log, Run Time Log, and Audit fields are also displayed with default values. You can change them if needed.

    • Service Type: Select a desired service type available for the selected interface.

    • Design time Log: By default, it is set to "Off'. You can enable the design-time log by selecting 'On' from the drop-down list.

    • Run time Log: By default, it is set to "Off' and the runtime log is turned off. You can change the default value by selecting an appropriate value from the drop-down list.

    • Audit: By default, it is set to "Off'. You can enable the auditing feature by selecting 'On' from the drop-down list.

  3. Click Apply to save the information.

Updating an Existing Configuration

From the Log & Audit Setup Details page, you can modify an existing configuration for a selected interface including changing service type and runtime log severity, and enabling or disabling the design-time log and the auditing feature.

Log & Audit Setup Details Page with Updating Runtime Log Information Highlighted

the picture is described in the document text

To update the log settings for an interface, select an appropriate value from the drop-down list. For example, to enable the runtime log for the 'Order Capture' REST service, you need to select 'REST' as the service type for the 'Order Capture' interface and change the 'Off' value to 'Information' in the Run Time Log field. All messages during service invocation specific to the 'Order Capture' REST service will be written.

After you modify the existing settings for an interface, click Apply to save changes to the database and on Oracle SOA Suite if the changes applied to a SOAP service that has been deployed. Click Cancel to display the previous saved details.

To update an existing configuration:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Administrator role. Select the Integrated SOA Gateway responsibility.

    Choose Administration > Configuration from the navigation menu. The Log & Audit Setup Details page is displayed.

  2. Update the basic log settings for an interface by selecting appropriate values from the drop-down lists for the service type, design-time log, runtime log level, and the Audit field.

  3. After the modification, click Apply to save the changes. Click Cancel to display the previous saved details.

Deleting an Existing Configuration

If an existing configuration is no longer needed, you can remove it directly from the Log & Audit Setup Details page.

To delete existing configurations, select at least one setting that you want to remove and then click Delete. This removes the records from the existing configuration list and database. A confirmation message appears indicating that the selected log setups have been successfully deleted. This disables the logging and audit features for the selected interfaces.

Log & Audit Setup Details Page with "Delete" Button Selected

the picture is described in the document text

For a SOAP service that has been deployed to Oracle SOA Suite, once a configuration is deleted for that service, the runtime log level would be reset at the composite level as well in Oracle SOA Suite.

To delete an existing logging configuration:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Administrator role. Select the Integrated SOA Gateway responsibility.

    Choose Administration > Configuration from the navigation menu. The Log & Audit Setup Details page appears.

  2. To delete an existing configuration, select a desired interface level setting that you want to remove and click Delete. The configuration for the selected interface is removed from the list and the system.

Viewing, Deleting, and Exporting Log Messages

To effectively troubleshoot or debug errors if occurred at each stage of the service deployment life cycle, you can view and download log details recorded for an interface or service if it has the logging feature enabled properly.

Note that sensitive information such as passwords and security credentials in unencrypted plain text will not be logged.

Viewing Service Processing Logs

To effectively monitor SOAP and REST messages at runtime during the invocation of Oracle E-Business Suite services, if the runtime logging is enabled for a specific interface with a service type specified in the Log & Audit Setup Details page, log messages can be captured in Service Monitor against that instance for the specified service.

When a SOAP or REST request is received, Service Provider generates a unique numeric instance ID based on a database sequence and passes it to Service Monitor. Therefore, each request in Service Monitor appears with instance ID and the Log icon letting you retrieve the log details.

Click the Log icon in the search result table to view log messages in the Web Service Runtime Logs page.

Important: For SOAP services, runtime logging for PL/SQL, Concurrent Program, XML Gateway interface types is handled by Oracle SOA Suite; therefore, setting runtime log levels for these services in the Log & Audit Setup Details page will display Oracle SOA Suite logs if the services are deployed in Oracle SOA Suite. Limited runtime log statements from the Oracle E-Business Suite Integrated SOA Gateway code (identified by the package name oracle.apps.fnd.isg) will be displayed for these services. Runtime logging for Business Service Object interface type is handled by Oracle E-Business Suite Integrated SOA Gateway; therefore Service Monitor shows Oracle E-Business Suite Integrated SOA Gateway logs for these interfaces based on the log level selected in the Log & Audit Setup Detail page.

Web Service Runtime Logs Page

the picture is described in the document text

The Web Service Runtime Logs page contains the following log regions:

To view log messages in Service Monitor:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Administrator role. Select the Integrated SOA Gateway responsibility.

    From the navigation menu, select the Service Monitor link from the Administration section to open the Monitor Search page.

  2. Perform a search to display the search result. See: Searching SOAP and REST messages.

  3. In the search result table, click the Log icon for a desired instance. The Web Service Runtime Logs page appears letting you view the log details.

  4. In the Adapter Logs region, click Delete Log to delete all the logs listed in the table for a given instance if needed. Click Yes to confirm the action. Click No to return to the Web Service Runtime Logs page.

    Click Export to export log list table to Microsoft Excel.

Configuring File Logging (Optional)

In Oracle E-Business Suite release 12.2, log statements can be captured in either of the following places:

This section describes the steps to enable the file logging for both SOAP and REST services.

When the file logging is enabled, log statements for design-time and runtime operations are not shown in the Interface Details page and Service Monitor user interface.

Steps to Enable File Logging for SOAP Services

To capture log statements recorded for SOAP services on the file system, you need to enable the file logging using the following steps:

  1. Set the following properties from $INST_TOP/soa/isgagent.properties in Oracle E-Business Suite and <ISGTEMP>/appsutil/<EBS_CONTEXT_NAME>/bpel/isg.properties in Oracle SOA Suite:

    <ISGTEMP> indicates a temporary folder created with write permission on the Oracle SOA Suite server. For details about this folder and isg.properties, see Installing Oracle E-Business Suite Integrated SOA Gateway, Release 12.2, My Oracle Support Knowledge Document 1311068.1.

    Note: Logging mechanism should be the same across Oracle E-Business Suite and Oracle SOA Suite. If file logging is enabled in Oracle E-Business Suite, then it must be enabled in Oracle SOA Suite as well.

    • <SID>.ISG_GLOBAL_LOG=TRUE

    • <SID>.ISG_LOGGER=FILE

  2. Stop and restart the oafm and oacore managed servers in an Oracle E-Business Suite environment and the Oracle SOA Suite managed server in Oracle SOA Suite.

    Note: If your instance is configured with multiple nodes, stop and restart the oafm and oacore managed servers on each Oracle E-Business Suite and Oracle SOA Suite node of the multi-node environment.

    The ISGLog.log file is created in <SID>.ISG_TEMP_DIRECTORY_LOCATION specified in the isgagent.properties file and isg.properties.

Steps to Enable File Logging for REST Services

To capture log statements recorded for REST services on the file system, you need to enable the file logging using the following steps:

  1. Set the following properties from $INST_TOP/soa/isgagent.properties in Oracle E-Business Suite:

    • <SID>.ISG_GLOBAL_LOG=TRUE

    • <SID>.ISG_LOGGER=FILE

  2. Stop and restart the oafm and oacore managed servers in an Oracle E-Business Suite environment.

    Note: If your instance is configured with multiple nodes, stop and restart the oafm and oacore managed servers on each Oracle E-Business Suite node.

    The ISGLog.log file is created in <SID>.ISG_TEMP_DIRECTORY_LOCATION specified in the isgagent.properties file.