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 integration interface level. This includes selecting a desired interface name 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 interface level.

With proper logging setups and configuration, you can easily monitor and audit Web 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 run time. Moreover, the administrator can delete existing log settings, and purge audit information through Service Monitor if needed.

Important: Logging feature is supported for SOAP services only. This feature is not supported for REST services in this release.

Key Features

The enhanced Web service logging feature includes the following features:

Design-time logs capture each stage of SOAP service generation and development life cycle activities only if the design-time log is enabled for the selected interface or service.

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

Audit feature allows you to monitor and track Web service activities executed through Oracle SOA Suite if the audit feature for a specific interface or service is enabled. All SOAP messages for the interface or service that has the Audit feature enabled, 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 and monitoring SOAP requests in the Service 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 integration interface level. Once an integration administrator logs in to Oracle E-Business Suite with the Integrated SOA Gateway responsibility and selects Administration > Configuration link from the navigation menu, the Log & Audit Setup Details page is displayed. 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, 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 is displayed on the top of this page allowing you to 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 execute the query. All interface names that match your search criteria will be displayed 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 execute the query. All matched interfaces will be displayed 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 to add a new setting.

Adding a New Configuration

Oracle E-Business Suite Integrated SOA Gateway allows you to configure new log settings at the integration interface level. Click Add Another Row 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 specific interface. This includes specifying log severity information for runtime log or disabling the runtime log by setting its value to 'Off', as well as enabling or disabling the design-time log and the service auditing feature for the selected interface.

Note: Design-time logs capture only SOAP service activities recorded at design time, including Generate, Deploy, Undeploy, Reset, Retire, and Activate services, only if the design-time log is enabled for that interface or service. Without enabling the design-time log, the logs will not be written.

Perform the following tasks to add a new configuration in a new role:

Please note that log messages can be correlated across middle-tier and database servers. If a new configuration is added for a service that has been deployed, the newly-configured log setting including runtime log level configured for that deployed service will be added in the Oracle SOA Suite. 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. The same mechanism applies when an integration administrator updates an existing log level for a deployed service, the new log level will be updated in the database.

If a new configuration is added for a service that is not deployed, then the runtime log configuration including log level set for that service would be effective after the service 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.

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

    • 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.

    • 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 runtime log severity, and enabling or disabling the design-time log and the auditing feature.

Log & Audit Setup Details Page with Updating Run Time Log Information Highlighted

the picture is described in the document text

To update the log settings for an interface, select appropriate values from the drop-down lists. For example, enable the runtime log for the 'Order Capture' interface and set an appropriate log level. This is achieved by changing the 'Off' value to 'Information' in the Run Time Log field. All informational messages during service invocation specific for the 'Order Capture' service will be written.

After modifying the existing settings for an interface, click Apply to save changes to the database and in Oracle SOA Suite if the changes applied to a 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 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 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.

If you click Delete without first selecting log configurations that you want to delete, then an advice message appears indicating that you should select at least one interface level log configuration for deletion.

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 is displayed.

  2. To delete an existing configuration, select the 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 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.

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

Viewing Generate and Deploy Time Logs

At design time during service generation and deployment life cycle, logs can be captured through the Integration Repository user interface if the design-time log is enabled for a specific interface. If an interface has the design-time log enabled, View Log appears in the interface details page for that interface.

Note: If an interface that does not have the design-time log enabled and if errors occurred during the design-time activities such as Generate, Deploy, Undeploy, Reset, Retire, and Activate, View Error appears instead allowing you to view only the error or exception message details. You will not find log messages recorded at the design time because the design-time log is not enabled.

Click View Log to open the Log & Error Details page where you can view log messages compiled in a table in the Log Details region as well as view error message details in the Error Details region only if errors occurred during the design-time activities.

Deleting and Exporting Logs in the Log Details Region

After viewing log messages retrieved for an interface in the Log Details region, you can delete them if needed by clicking Delete Log. A warning message appears alerting you that this will permanently delete all the logs retrieved in the region. Click Yes to confirm the action. An empty log table appears in the Log Details region after logs have been successfully deleted.

Before deleting the logs, you can save a backup copy by clicking Export. This allows you to export the records listed in the Log Details region to Microsoft Excel and use it later.

For more information on viewing logs recorded during service deployment life cycle through Integration Repository, see Viewing Generate and Deploy Time Logs.

Viewing Service Processing Logs

At run time during the invocation of Oracle E-Business Suite services by Web service clients, log messages can be captured and viewed through Service Monitor. Click the Log icon in the search result table for a request in Service Monitor to open the Web Service Runtime Logs page where you can view the log details for the request against a specific instance.

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

Deleting and Exporting Adapter Logs Retrieved from Oracle E-Business Suite Table

After viewing adapter log messages retrieved from the Oracle E-Business Suite table for a service, you can delete them if needed by clicking Delete Log. A warning message appears alerting you that this will permanently delete all the logs retrieved in the Adapter log table. Click Yes to confirm the action. An empty log table appears after adapter logs have been successfully deleted.

Before deleting the logs, you can save a backup copy by clicking Export. This exports the records listed in the table to Microsoft Excel.

Note: Please note that the log records deleted here are instance specific, whereas the Purge program from the Service Monitor requiring you to enter specific date range in executing the concurrent request is not. The purge concurrent request will delete only the service processing logs for which the service is completed with a status of 'SUCCESS'. It does not delete the logs for the service with 'FAILURE' status.

For more information on purging logs through Service Monitor, see Purging SOAP Messages, Audits, and Logs.

For more information on viewing log messages recorded while processing service requests, see Viewing Service Processing Logs.