Skip Headers
Oracle® Fusion Applications Administrator's Guide
11g Release 6 Refresh 4 (11.1.6)

Part Number E14496-14
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

15 Managing Oracle Fusion Applications Log Files

This chapter describes how to use incidents, log files, and QuickTrace to support normal operations for Oracle Fusion Applications and to prepare for future troubleshooting.

This chapter contains the following topics:

For information about using diagnostics tests to support normal operations for Oracle Fusion Applications, see Chapter 16. For information about troubleshooting using log settings, log files, the QuickTrace feature (in-memory logging), diagnostic tests, and incidents, see Chapter 17.

15.1 Overview of Oracle Fusion Applications Incidents, Logging, and QuickTrace

Incidents, log files, and QuickTrace can all help you administer Oracle Fusion Applications. If your Oracle Fusion Applications environment includes Oracle Enterprise Manager Cloud Control (Cloud Control), then you can also use Support Workbench to help you investigate, report, and resolve problems.

Incidents are collections of information about error conditions. It is strongly recommended that you follow Information Technology Infrastructure Library (ITIL) best practices by establishing a help desk or service desk within your organization to support Oracle Fusion Applications, and have the help desk personnel use incidents to track the troubleshooting and resolution of all problems. Some incidents are created and gather information automatically when problems occur. For example, the information associated with an automatically created incident may include detailed operational information collected by the QuickTrace (in-memory logging) feature for Oracle Fusion Applications. For problems that do not automatically create incidents, administrators or help desk personnel can manually create incidents and manually gather and add related system information.

Log files contain information about both normal and problematic events. Log files can help you both to monitor normal operations and to diagnose and address some problems yourself. For example, log messages that state that a service cannot be reached might indicate a hardware failure. If you discover a more complex issue, then Oracle Support personnel may use log files to trace the execution code paths of relevant requests, as part of diagnosing the problem. Log files are particularly helpful if your Oracle implementation contains custom code that needs debugging, especially when using a debugger is not feasible, such as on a production system.

The QuickTrace (in-memory logging) feature continuously records a specified level of log detail in an area of memory. The memory is recycled on an ongoing basis, with the oldest information being deleted or overwritten first. Because QuickTrace writes to memory instead of to a log file, it can gather operational information continuously without significantly affecting system performance. The information that QuickTrace stores in memory is written to disk only when an incident occurs or when an administrator manually dumps the contents of a QuickTrace buffer.

In Cloud Control, Support Workbench helps you investigate, report, and resolve problems (critical errors). You can use Support Workbench to perform the following kinds of operations:

For information about using Support Workbench to administer Oracle Fusion Applications targets, specifically, see Chapter 17. For general information about using Support Workbench, see the topic "Support Workbench Page" in the Cloud Control online help and the chapter on investigating, reporting, and resolving problems in Oracle Database 2 Day DBA.

15.2 Understanding Oracle Fusion Applications Log Files and Log Messages

Log files can help you administer and support Oracle Fusion Applications over time. Oracle developers use mechanisms such as application programming interface (API) calls in Oracle Fusion Applications code to record application operations in log files and to provide error messages as appropriate.

This section contains the following topics:

You can set system log levels to determine how much information is logged. For more information about setting log levels, see Section 15.4.

For more information about monitoring log files, see Section 15.3 and Section 15.4.4. For more information about using logs to help diagnose a problem, see Chapter 17.

It is important to be familiar with the following additional concepts that are related to log files:

15.2.1 Standard Log File Administration Tasks and Tools

Under ordinary circumstances, the following administrative tasks are part of the necessary setup and maintenance of Oracle Fusion Applications log files:

  • Tuning system performance by adjusting configuration settings for logs

  • Reviewing log files for general monitoring of system health

  • Searching for specific information in log files

  • Managing available disk space for log files

If your Oracle Fusion Applications environment includes Cloud Control, then you may find it convenient to use Cloud Control to monitor log files in multiple domains, simultaneously.

You can use the Oracle Enterprise Manager Fusion Applications Control (Fusion Applications Control) user interface to complete all of the tasks listed in this section, but only for one WebLogic domain at a time. In particular, you can use Fusion Applications Control to configure log profile option values for Oracle Fusion Applications, although you can also configure profile options by using the Manage Administrator Profile Values screen in the Setup and Maintenance work area. You can use either Cloud Control or Fusion Applications Control to view and search Oracle Fusion Applications log files.

Note:

Fusion Applications Control and Cloud Control are compliant with Information Technology Infrastructure Library (ITIL) best practices.

During troubleshooting activities, additional log administration tasks may include downloading log files from servers and packaging incidents for transmittal to Oracle Support. For more information about these activities and the tools for accomplishing them, see Chapter 17.

15.2.2 Log Files and Settings

Oracle provides settings that determine the amount of information that is gathered into the log files for your Oracle Fusion applications. You can either use the default setting values or change one or more values to adjust how much information is gathered. When your system is operating correctly, you may need log entries only for particularly important kinds of events. If your system experiences a problem, then you can temporarily increase the amount of information that is logged to get more detailed information while you attempt to reproduce and resolve the problem.

Most Oracle Fusion applications write log output in Oracle Diagnostic Logging (ODL) format. For information about the attributes that appear in standard log files for Oracle Fusion Applications, see the "Understanding ODL Messages and ODL Log Files" section in the Oracle Fusion Middleware Administrator's Guide.

Some Oracle Fusion applications use nonstandard logging mechanisms that are disabled by default. For these applications, you must turn on the logging facility when you need it and specify the kind of information that you want to record in the log file. For more information about these special logging mechanisms, see Section 15.4.6.

15.2.3 Log Message Structure

A typical log message consists of three parts:

  • Attributes that are logged by the Oracle Fusion Middleware layer or the Oracle Database layer

  • Attributes that are logged by logging APIs for Oracle Fusion Applications, including AppsLogger

  • Message text

This section contains the following topics:

15.2.3.1 Log Message Attributes Supplied by the Oracle Fusion Middleware and Oracle Database Layers

The log message attributes logged by the Oracle Fusion Middleware layer or the Oracle Database layer may include the following:

  • Date/time: The date and time when the message was recorded in the log.

  • Component ID: The component or Oracle WebLogic Server (WebLogic Server) instance from which the message originated. For the Oracle Fusion Middleware layer, a typical value is the name of the Oracle WebLogic Server that was executing the Oracle Fusion application when the message was generated. For the database layer, a typical value is rdbms.

  • Message Type:Level: Shows the level being logged for the particular message

  • Message ID: A unique identifier for a seeded message, composed of the product code and a message number. A typical value for a message ID might be FND-12343.

  • Module ID: The system or application module that generated the message. This is usually the name of the logger object that generated the message. In some cases, the logger name may reflect the full Java class name of the application code module that was executing when the message was logged. In other cases, the logger object may generate messages for multiple Java classes.

  • Execution context ID (ECID): A global unique identifier and a sequence number of the thread of execution in which the originating component participates. The identifier can be used to correlate messages from several components that may be involved in the same thread of execution.

  • Host: The name of the host from which the message originates. For Java, this should be the value returned by the java.net.InetAddress.getLocalHost().getHostName() method.

  • Thread ID (TID): A unique identifier for the thread within the Java process where the message was generated.

  • Java EE application name: Name of a Java EE application that was executing when the message was logged.

  • User name: A unique identifier that the user enters when signing in to an Oracle Fusion application. This attribute is logged both by Oracle Fusion Middleware and by the logging APIs for Oracle Fusion Applications.

  • Selective trace ID (labeled ODL_TRACE_ID in the log file): An identifier for operations in the Oracle Fusion Middleware layer that match criteria an administrator supplied as part of a request to log additional information.

    Note:

    Selective trace operations do not affect the information that is logged from the Oracle Fusion Applications layer, but the Oracle Fusion Middleware log messages that selective tracing operations obtain are stored in the same log files as log messages from the Oracle Fusion Applications layer. Similarly, log messages from the Oracle Fusion Applications layer are listed with Oracle Fusion Middleware log messages in selective trace output if those log messages match the trace criteria that the administrator specified. For more information about selective tracing, see the "Configuring and Using Selective Tracing" section in the Oracle Fusion Middleware Administrator's Guide.

15.2.3.2 Log Message Attributes Supplied by Logging APIs for Oracle Fusion Applications

The log message attributes logged by logging APIs for Oracle Fusion Applications include the following:

  • User Name: A unique identifier that the user enters when signing in to an Oracle Fusion application. This attribute is logged both by Oracle Fusion Middleware and by the logging APIs for Oracle Fusion Applications.

  • User GUID: A global unique identifier representing the user.

  • Role IDs: A list of IDs representing the job roles granted to the user.

  • Session ID: A unique identifier for the application user session.

  • Thread Name: A name that identifies the thread generating the log in Java Virtual Machine (JVM). Applies only to Oracle Fusion applications that are written in Java. Logging APIs for Oracle Fusion applications that are written in C and PL/SQL do not populate this attribute.

  • Apps Source: The portion of the Oracle Fusion Applications code that is executing when the message is logged.

  • Apps Auto Log: Indicates whether the message being logged was logged implicitly.

  • DB Connection URL: The URL connection string for the application database data source.

Depending on the value of the AFLOG_EXTENDED_ENABLED profile option, the following supplemental attributes may also be logged:

  • Message Cause: The reason that the message is being logged.

  • Admin Action: Recommended follow-up action for Oracle Fusion Applications administrators.

  • Admin Details: Additional information for administrators about the condition being logged.

  • User Action: Recommended follow-up action for Oracle Fusion Applications users.

  • User Details: Additional information for users about the condition being logged.

For more information about how the AFLOG_EXTENDED_ENABLED profile option affects the logging of these supplemental attributes, see Section 15.4.1.

15.2.3.3 Log Message Attributes Supplied by the Application Session

The log message attributes logged by the application session include the following:

  • Product Family: The name of the product family that is executing when the message is logged.

  • Product: The name of the product that is executing when the message is logged.

15.2.3.4 Log Message Attributes Supplied by Oracle Enterprise Scheduler Job Requests

The following attributes appear in the log if the log entry is written from an Oracle Enterprise Scheduler job request.

  • Job Request ID: The identifier of the Oracle Enterprise Scheduler job request that is being executed when this message is logged.

  • Job Definition Name: The name of the Oracle Enterprise Scheduler job definition. A job definition is the smallest unit of work that is performed in the context of the client application.

  • Job Package Name: The package location of the Oracle Enterprise Scheduler job definition that is executing when this message is logged.

  • Job Definition Application: The application that owns the Oracle Enterprise Scheduler job.

15.2.3.5 Log Message Attributes Supplied by SOA

The following attributes appear in the log if the log entry is written from SOA:

  • SOA Composite Name: The name of the SOA Composite that is executing when the message is logged

  • SOA Component Name: The name of the SOA Component that is executing when the message is logged

  • SOA Composite Instance ID: The instance ID of the SOA Composite that is executing when the message is logged

  • SOA Component Instance ID: The instance ID of the SOA Component that is executing when the message is logged

  • Log Token Map: One or more primary key values for the logical entity that a BPEL process is handling when the message is logged. Oracle Support may require this information for troubleshooting purposes.

15.3 Viewing and Searching Log Files During Normal Operation

To view and search Oracle Fusion application log files effectively, it is important to be familiar with the software that is available for working with log files. You may also find it helpful to know where log files are stored for various application modules.

This section contains the following topics:

Note:

Each Oracle Fusion Applications module is written in one of the following code languages: Java, SOA, PL/SQL, or C. Details of logging vary depending on the coding language of the application module.

In general, you can administer logging for Oracle Fusion Applications without knowing which programming language implements particular modules. However, it is important to become familiar with the configuration settings and log file locations used for each language, so you can monitor or adjust all relevant parts of the system when necessary.

15.3.1 Viewing Logs from Fusion Applications Control

When you want to view log files for one Oracle Fusion Applications product family or product that uses standard logging functionality, one typical way that you can view the log files is to use Fusion Applications Control.

By default, you can use Fusion Applications Control to view standard log files for the Oracle WebLogic Servers that host Oracle Fusion applications and standard log files generated by Java code within Oracle Fusion applications. In addition, you can configure your system to allow Fusion Applications Control to view log files generated by PL/SQL or C code within Oracle Fusion applications. For more information about how to configure this capability, see Section 15.4.7.

From Fusion Applications Control, you can view log messages for different system components by selecting different targets. In the product family part of the navigation tree, the following target types allow viewing of log messages for Oracle Fusion Applications:

  • An entire product family. When you select this target type and view log files, you view the aggregated logs for all of the servers and clusters in the selected product family's domain.

  • A particular Oracle Fusion application, such as Procurement, sometimes called an Oracle Fusion Applications cluster application. When you select this target type and view log files, you view the aggregated logs for all of the servers in the selected cluster.

  • A particular instance of an Oracle Fusion application deployed to a Managed Server. When you select this target type and view log files, you view the log for the selected individual Managed Server.

The Fusion Applications Control page also gives you access to log files for the following target types in the farm part of the navigation tree, but the functionality used to view those logs is part of Fusion Middleware Control.

  • A particular Oracle WebLogic Server domain

  • A particular server cluster

  • A particular server within a particular server cluster

Note:

For information about viewing Oracle Fusion Middleware log files, including log files for Oracle Enterprise Scheduler and Oracle Enterprise Crawl and Search Framework, see the "Viewing and Searching Log Files" and "Viewing Log Files and Their Messages Using Fusion Middleware Control" sections in the Oracle Fusion Middleware Administrator's Guide.

To view the contents of Oracle Fusion Applications logs from Fusion Applications Control:

  1. From the navigation pane, select the target for which you want to display log contents.

    In the part of the navigation tree for the product family, you can display logs for the following kinds of targets:

    • A product family target lets you display the aggregated log entries for all of the Oracle Fusion applications in the selected product family. For example, Financials is a product family target that appears as a top-level folder in the navigation tree.

    • An Oracle Fusion Applications cluster application target lets you display the aggregated logs for all of the Managed Servers that run the selected application, including the logs for any other Oracle Fusion applications that run on those Managed Servers. For example, if you expand the product family, Financials, and then expand Fusion Applications, then PayablesApp is a cluster application target.

    • An Oracle Fusion application instance target lets you display the log entries for the selected application on the selected sever. For example, if you expand the product family, Financials, and then expand Fusion Applications, and then expand PayablesApp, then PayablesApp (PayablesServer_1) is an application instance target.

    Note:

    When you select a target, the header of the context pane displays a dropdown menu name that depends on the target type:

    • For a product family target, the menu name is Product Family.

    • For an Oracle Fusion Applications cluster application target, the menu name is Fusion Cluster Application.

    • For an Oracle Fusion application instance target, the menu name is Fusion J2EE Application.

    Alternatively, if you want to view a log file for an Oracle Fusion Middleware target, then you can select such a target from the farm part of the navigation tree. For more information about viewing log files for Oracle Fusion Middleware components, see the "Viewing Log Files and Their Messages Using Fusion Middleware Control" section in the Oracle Fusion Middleware Administrator's Guide.

  2. In the context pane, from the dynamic target menu, choose Logs > View Log Messages to display the log messages screen.

15.3.2 Searching for Specific Information in Log Files within a Single Domain

For most Oracle Fusion applications, you can use Fusion Applications Control to search for log messages that have specific characteristics. Searches that use Fusion Applications Control are similar to searches that use Fusion Middleware Control. For more information about these searches, see the "Viewing and Searching Log Files" section in the Oracle Fusion Middleware Administrator's Guide.

By default, you can use Fusion Applications Control to search standard log files for Oracle Fusion applications that are written in Java and the Oracle WebLogic Servers that host those applications. You can configure your system to allow Fusion Applications Control to search log files for Oracle Fusion applications that are written in PL/SQL or C. For more information about the necessary configuration steps for PL/SQL and C logs, see Section 15.4.7.

To search standard Oracle Fusion Applications log files using Fusion Applications Control:

  1. From the navigation pane for Fusion Applications Control, select the target for which you want to search log contents.

    For your target, you can select a product family such as Financials, an Oracle Fusion Applications cluster application such as LedgerApp, or an Oracle Fusion application instance such as LedgerApp (LedgerServer_1). For information about searching log files in multiple domains, using a Fusion Instance target, see Section 15.3.3.

    Note:

    When you select a target, the header of the context pane displays a dropdown menu name that depends on the target type:

    • For a product family target, the menu name is Product Family.

    • For an Oracle Fusion Applications cluster application target, the menu name is Fusion Cluster Application.

    • For an Oracle Fusion application instance target, the menu name is Fusion J2EE Application.

    For example, if you want to search the aggregated log entries for all of the Oracle Fusion applications in the Financials product family, then you select the Financials entry in the navigation tree. The Product Family dropdown menu appears under Financials in the context pane header.

    If you want to search the aggregated logs for the Ledger cluster application, then you expand the Financials entry in the navigation tree, then expand the Fusion Applications entry, and then select LedgerApp. The Fusion Cluster Application dropdown menu appears under LedgerApp in the context pane header.

    If you would rather search the Ledger application log entries for only a particular server, then you expand the Financials entry in the navigation tree, then expand the Fusion Applications entry, then expand the LedgerApp entry, and then select the individual LedgerApp Managed Server for the log you want to search. The Fusion J2EE Application dropdown menu appears under LedgerApp in the context pane header.

  2. In the context pane, from the dynamic target menu, choose Logs > View Log Messages.

    If you selected an Oracle Fusion application as your target, then the content pane displays the aggregated log messages from all of the servers for the Oracle Fusion application that you selected.

    If you selected an individual Oracle Fusion application instance running on a particular Managed Server as your target, then the content pane displays the log messages for the selected Oracle Fusion application operations that were handled by the selected server.

    If you selected a product family such as Financials as your target, then the content pane displays the aggregated log messages for all of the Managed Servers that handle Oracle Fusion applications in the selected product family.

  3. If necessary, expand the Search area of the content pane.

  4. If you selected an Oracle Fusion application instance in Step 1, skip to Step 5.

    If you selected a product family or Oracle Fusion Applications cluster application in Step 1, then complete the following substeps to determine which members of the selected target will be included in the log search:

    1. Expand the Selected Targets section of the Search area.

    2. If you want to search the log files for only some of the listed target members, then select the ones you want to omit from the search and click Remove.

    3. If you want the log search operation to search log files that are not currently listed, then click Add, select the additional targets that you want to search, and click Select.

    4. Go to Step 5.

  5. Enter or select applicable search criteria in any visible search fields, such as the following fields that are visible by default:

    • In the Date Range fields, specify the time period for which you want to display log messages.

      To specify a specific number of the most recent minutes, hours, or days, select Most Recent from the dropdown list, enter your preferred number, and select the appropriate time units.

      To specify the time period using starting and ending dates and times, select Time Interval from the dropdown list and enter the starting and ending dates and times.

    • In the Message Types field, select one or more checkboxes to specify the kinds of log messages that you want to display.

    • In the Message fields specify some or all of the message text in the log messages that you want to display.

      If you select either the matches search operator or the does not match search operator, then you must either specify the full text of the message, or you must use a standard Java language expression to specify the characteristics of the missing text. For example, in standard Java expressions, the period (.) acts as a wildcard that matches most single characters, and the combination of a period and an asterisk (.*) acts as a wildcard to match any string of characters.

      In contrast, the following search operators contain implicit wildcard semantics. You do not need wildcard characters or other Java expressions when you use any of these operators to search for a part of the text of a message:

      • contains

      • does not contain

      • starts with

      • does not start with

      • ends with

      • does not end with

      Note:

      If you search for multiple values within a single search field, using commas to separate the values, then the search results display log entries that match any of the criteria specified for that field (logical OR). However, if you specify criteria in multiple search fields, then the search results display only log entries that match specified criteria in all of those search fields (logical AND).

  6. If you want to use search criteria in fields that are not currently visible, then complete the following substeps; otherwise, skip this step.

    1. Click Add Fields.

    2. Select one or more checkboxes for the additional fields you want to use in your search, and then click Add.

      For example, you might select ECID to search for all log messages that are associated with a particular execution context identifier.

    3. In each field that you added, specify the value that you want the search to match.

      For example, you might enter the ECID value of 004bYSyedEi3v1A5Jb8Dyf0002kx003XFf.

  7. Click Search.

15.3.3 Searching for Specific Information in Log Files Across Multiple Domains

If your Oracle Fusion Applications environment includes Cloud Control, then you can use Cloud Control to search for information in the log files of multiple domains within a single Fusion instance.

To search standard Oracle Fusion Applications log files in multiple domains using Cloud Control:

  1. In Cloud Control, from the Target menu, choose Fusion Applications.

  2. In the list of Oracle Fusion instances and Oracle Fusion Applications product families, click the name of the instance that interests you.

  3. From the dynamic Fusion Instance target menu, choose Logs > View Log Messages.

  4. If it is collapsed, then expand the Search area of the Log Messages pane.

  5. Expand the Selected Targets part of the Search area, and make sure that it lists the targets for all of the log files that you want to search:

    • If you want to search the log files for only some of the listed target members, then select the ones you want to omit from the search and click Remove.

    • If you want the log search operation to search log files that are not currently listed, then click Add, select the additional targets that you want to search, and click Select.

  6. Enter or select applicable search criteria in any of the visible search fields, such as the following fields that are visible by default:

    • In the Date Range fields, specify the time period for which you want to display log messages.

      To specify a specific number of the most recent minutes, hours, or days, select Most Recent from the dropdown list, enter your preferred number, and select the appropriate time units.

      To specify the time period using starting and ending dates and times, select Time Interval from the dropdown list and enter the starting and ending dates and times.

    • In the Message Types field, select one or more checkboxes to specify the kinds of log messages that you want to display.

    • In the Message fields, specify some or all of the message text in the log messages that you want to display.

      If you select either the matches search operator or the does not match search operator, then you must either specify the full text of the message, or you must use a standard Java language expression to specify the characteristics of the missing text. For example, in standard Java expressions, the period (.) acts as a wildcard that matches most single characters, and the combination of a period and an asterisk (.*) acts as a wildcard to match any string of characters.

      In contrast, the following search operators contain implicit wildcard semantics. You do not need wildcard characters or other Java expressions when you use any of these operators to search for a part of the text of a message:

      • contains

      • does not contain

      • starts with

      • does not start with

      • ends with

      • does not end with

      Note:

      If you search for multiple values within a single search field, using commas to separate the values, then the search results display log entries that match any of the criteria specified for that field (logical OR). However, if you specify criteria in multiple search fields, then the search results display only log entries that match specified criteria in all of those search fields (logical AND).

  7. If you want to use search criteria in fields that are not currently visible, then complete the following substeps; otherwise, skip this step.

    1. Click Add Fields.

    2. Select one or more checkboxes for the additional fields you want to use in your search, and then click Add.

      For example, you might select ECID to search for all log messages that are associated with a particular execution context identifier.

    3. In each field that you added, specify the value that you want the search to match.

      For example, you might enter the ECID value of 004bYSyedEi3v1A5Jb8Dyf0002kx003XFf.

  8. Click Search.

15.3.4 Saving Log Search Criteria for Reuse

If your Oracle Fusion Applications environment includes Cloud Control, then you can use Cloud Control to save log search criteria so that repeating the same search is more convenient in the future.

To save log search criteria using Cloud Control:

  1. Make sure that you are logged into Cloud Control as the user who will need to reuse the criteria that you plan to save.

    Only the user who saves a set of log search criteria can reuse that set.

  2. Decide upon the target for which you expect to need repeated log searches.

    For example, you might want to save a log search for a target about which you have repeatedly received alert notifications.

    Note:

    For maximum flexibility when reusing search criteria, you may want to use the highest level target that you expect to be applicable. Such a saved log search can be reused for the selected target or any target beneath it in the hierarchical navigation tree.

    For example, if you save log search criteria for a particular Oracle Fusion Applications cluster application, then you can reuse those saved search criteria for that same cluster application or for any Managed Server within that cluster.

  3. Use either of the following methods to navigate to a screen where you can specify log search criteria for your preferred target:

    • From the Target menu, choose Fusion Applications, and then expand the hierarchical navigation tree, select your preferred target, and choose Logs > View Log Messages from the dynamic target menu.

    • From the Enterprise menu, choose Monitoring > Logs, and then expand the Selected Targets section and add your preferred target.

  4. Enter or select the desired search criteria in all applicable search fields.

    For more information about these fields, see Section 15.3.3.

  5. Click Search.

  6. Review the search results to make sure that you specified the target and search criteria that you want to save, then click Save Search.

    A confirmation message appears, including the default name for the saved search, which can include lengthy information about the criteria you used.

    Note:

    If the Save Search button is not available, then the system has not detected any change in target or search criteria since your last log search. To reenable the Save Search button, select a different target or specify different search criteria.

  7. To assign the saved search a more convenient name, complete the following sub-steps:

    1. From the Saved Searches dropdown list, select Manage Saved Searches.

    2. In the Manage Favorites dialog, click the first column of the table row that lists the saved search that you want to rename.

      If the list of saved searches is long, you can click the query by example button and use standard techniques to help you locate the saved search that interests you.

    3. In the Name field, enter a new name for the saved search.

      Saved log search names can be up to 256 characters long. It is recommended that you specify a name that will help you remember the target that the search applies to, as well as the search criteria.

      Note:

      The name is the only characteristic of a saved log search that you can modify. To save different search criteria, or to save the same criteria for a different target, you must create a new saved search by repeating all steps of this procedure, starting with Step 1.

    4. Click OK.

For information about using saved log search criteria, see Section 15.3.5

15.3.5 Reusing Saved Log Search Criteria

If your Oracle Fusion Applications environment includes Cloud Control, then you can reuse saved log search criteria. For information about saving log search criteria, see Section 15.3.4.

To repeat a log search that you previously saved using Cloud Control:

  1. Make sure that you are logged into Cloud Control as the user who saved the search criteria that you want to reuse.

    Only the user who saved a set of log search criteria can reuse that set.

  2. Use either of the following methods to navigate to a screen where you can specify log search criteria for your preferred target:

    • From the Target menu, choose Fusion Applications, and then expand the hierarchical navigation tree, select your preferred target, and choose Logs > View Log Messages from the dynamic target menu.

    • From the Enterprise menu, choose Monitoring > Logs, and then expand the Selected Targets section and add your preferred target.

    Note:

    For the search to be effective, the target that you select must be either the target for which the search criteria were originally saved, or a target that is below the original target in the hierarchical navigation tree.

    For example, if you originally saved the search for a cluster application target, you can reuse that search only for the same cluster or for a Managed Server that belongs to that cluster.

  3. From the Saved Searches dropdown list, select the saved search for the search criteria that you want to reuse.

    Note:

    The Saved Searches dropdown list contains all of the log searches that the current user previously saved, regardless of the saved or current target contexts.

    Provided that the current target is either the target for which the selected search was saved or a target that is below the original target in the hierarchical navigation tree, then the search is reexecuted as soon as you select the saved search that you want to reuse.

    If the current target is below the originally saved target in the navigation tree, then the reexecuted search uses only the saved search criteria that apply to the subsidiary target.

    If the current target is not either the target for which the selected search was saved or a target that is below the original target in the hierarchical navigation tree, then the search is not executed.

  4. If some of the saved search criteria did not apply to your currently selected target, and if you want to save just the applicable search criteria and current target context, then click Save Search.

  5. To assign the new saved search a more convenient name, complete the following sub-steps:

    1. From the Saved Searches dropdown list, select Manage Saved Searches.

    2. In the Manage Favorites dialog, click the first column of the table row that lists the saved search that you want to rename.

      If the list of saved searches is long, you can click the query by example button and use standard techniques to help you locate the saved search that interests you.

    3. In the Name field, enter a new name for the saved search.

      It is recommended that you choose a name that will help you remember the target that the search applies to, as well as the search criteria.

    4. Click OK.

15.3.6 Typical Log File Locations

Note:

The following information is provided for reference purposes. For maximum clarity and convenience, it is recommended that you use Fusion Applications Control to work with Oracle Fusion Applications log files, rather than working directly with the log files.

Each Oracle Fusion application runs in one or more logical Managed Servers. Each Managed Server is dedicated to a single Oracle Fusion application. Different Managed Servers do not typically share log files with each other, even if they are running on the same physical server computer.

Most Oracle Fusion Applications code modules use standard logging code. On each Managed Server, all Java and SOA application code modules that use standard logging code write log entries to a single file. The location of this file is specified by a log_handler entry in a logging.xml file. The default location for the logging.xml file is as follows, where DOMAIN_HOME is the path to your Oracle WebLogic Server (WebLogic Server) domain, and WebLogic_Server_Name is the name of the WebLogic Server that uses the logging.xml file:

DOMAIN_HOME/config/fmwconfig/servers/WebLogic_Server_Name/logging.xml

Example 15-1 shows a typical log_handler entry in the logging.xml file, which includes the path and file name of the log file.

Example 15-1 Typical log_handler Entry Showing Log File Name and Location

<log_handlers>
  <log_handler name='apps-handler' class='oracle.core.ojdl.logging.ODLHandlerFactory'>
    <property name='path' value='${domain.home}/servers/${weblogic.Name}/logs/apps/
       ${weblogic.Name}-diagnostic.log'/>
    <property name='maxFileSize' value='10485760'/>
    <property name='maxLogSize' value='104857600'/>
    <property name='encoding' value='UTF-8'/>
    <property name='supplem8entalAttributes' value='APPS_USER_NAME, 
APPS_SESSION_ID, APPS_THREAD_NAME, APPS_SOURCE, APPS_USER_ID, APPS_AUTO_LOG, 
APPS_JOB_REQUEST_ID, APPS_JOB_DEFINITION_NAME, APPS_JOB_PACKAGE_NAME, 
APPS_JOB_DEFINITION_APP, APPS_COMPOSITE_NAME, APPS_COMPONENT_NAME, 
APPS_COMPOSITE_INSTANCE_ID, APPS_COMPONENT_INSTANCE_ID, APPS_PRODUCT_FAMILY, 
APPS_PRODUCT, APPS_INDUSTRY, APPS_TERRITORY, APPS_DB_CONNECTION_URL, 
APPS_MESSAGE_CAUSE, APPS_USER_ACTION, APPS_ADMIN_ACTION, APPS_USER_DETAILS, 
APPS_ADMIN_DETAILS, APPS_LOG_TOKEN_MAP'/>
  </log_handler>
</log_handlers>

Example 15-2 shows the default location for the standard log file is as follows, for Oracle Fusion applications that are implemented in Java and SOA, where DOMAIN_HOME is the path to your Oracle WebLogic Server domain:

Example 15-2 Default Log File Location for Oracle Fusion Applications Implemented in Java and SOA

DOMAIN_HOME/servers/domain_name/logs/apps/server_name-diagnostic.log

For Oracle Fusion Applications code modules that are implemented in PL/SQL, the location of the standard log file is set by the AFLOG_PLSQL_FILENAME profile option. By default, the value of this profile option is APPLLOG_DIR/diagnostic.log, where APPLLOG_DIR is a directory object that was defined as a custom variable through the use of the Oracle Fusion Applications Repository Creation Utility during installation. For more information about directory objects, see the section about the CREATE DIRECTORY command in the Oracle Database SQL Language Reference

For Oracle Fusion Applications code modules that are implemented in C, the location of the standard log file is set by the AFLOG_FILENAME profile option. By default, the value of this profile option is diagnostic.log, but it is recommended that you set the value to directory_path/Cdiagnostic.log, where directory_path is a location that can be written to by all system users and by the Managed Server where Oracle Enterprise Scheduler is deployed for your Oracle Fusion applications. For example, you might set the value of directory_path to /tmp, or to an explicitly specified directory path that corresponds to the value of the APPLCP_DIR custom variable that was defined through the use of the Oracle Fusion Applications Repository Creation Utility during installation.

By default, the following Oracle Fusion Applications code modules do not write log entries. If you configure these modules to write log entries, then the entries for those modules are written to nonstandard log file locations. These modules do not specify any configuration settings using the standard logging.xml file:

  • Oracle Fusion Global Payroll

    Note:

    For optimum performance, it is recommended that you use the logging functionality that is available in the Oracle Fusion Global Payroll application only when troubleshooting an existing problem. For more information about using this feature and viewing the results, see Section 17.3.10 and Section 17.5.2.

  • The following kinds of batch jobs for Oracle Fusion Incentive Compensation:

    • Calculation

    • Classification

    • Collection

    • Crediting

    • Rollup

    Note:

    For optimum performance, it is recommended that you use the logging functionality that is available for these kinds of Oracle Fusion Incentive Compensation batch jobs only when troubleshooting an existing problem. For more information about using this feature and viewing the results, see Section 17.3.11 and Section 17.5.3.

  • The following kinds of batch jobs for Oracle Fusion General Ledger:

    • OpenPeriod

    • Posting

    • Translation

    • Close Process - Create Income Statement Closing Journals

    • Close Process - Create Balance Sheet Closing Journals

    Note:

    For optimum performance and log file sizes, it is recommended that you use the logging functionality for these kinds of Oracle Fusion General Ledger batch jobs only when troubleshooting an existing problem. For more information about using this feature and viewing the results, see Section 17.3.12.

  • The AutoInvoice portion of the Oracle Fusion Receivables application

    Note:

    The amount of information that is logged for AutoInvoice depends on the value of the Log File Message Level system option setting for each business unit. Any AutoInvoice log messages that meet the level requirements are written to the standard log file for Oracle Enterprise Scheduler.

    For more information about configuring the Log File Message Level system option setting, see Section 15.4.6.4. For more information about adjusting this setting for troubleshooting and viewing the results, see Section 17.3.13.

15.3.7 Location of Logged Information When Using Multiple Managed Servers

Note:

The following information is provided for reference purposes. For maximum clarity and convenience, it is recommended that you use Fusion Applications Control to work with Oracle Fusion Applications log files, rather than working directly with the log files.

If an Oracle Fusion application is deployed to multiple Managed Servers in a cluster domain, each Managed Server records log entries in its own log file, for the transactions or other operations handled by that server.

For your convenience in monitoring Oracle Fusion applications that run on multiple Managed Servers, Fusion Applications Control lets you view either individual standard log files for individual Managed Servers or the aggregated contents of the standard log files of all of the servers in the cluster domain. The aggregated log is especially useful if you need to find a particular log entry but do not know which Managed Server recorded it. For more information about viewing log files, see Section 15.3.1.

Fusion Applications Control does not currently support viewing the contents of any nonstandard log files generated by Oracle Fusion Incentive Compensation, Oracle Fusion General Ledger, or the AutoInvoice portion of the Oracle Fusion Receivables application. For information about viewing nonstandard log files for Oracle Fusion Incentive Compensation, see Section 17.5.3. For information about viewing nonstandard log files for Oracle Fusion General Ledger, see Section 17.3.12. Log entries for the AutoInvoice portion of Oracle Fusion Receivables are placed in the standard log file for Oracle Enterprise Scheduler. For information about viewing Oracle Fusion Middleware log files, including log files for Oracle Enterprise Scheduler, see the "Viewing and Searching Log Files" section in the Oracle Fusion Middleware Administrator's Guide. For information about viewing nonstandard log files for Oracle Fusion Global Payroll, see Section 17.5.2.

Note:

When an Oracle Fusion application is deployed to multiple Managed Servers in a cluster domain, it is recommended that you set the log level to the same value for all of the Managed Servers, so that all of the servers will log comparable amounts and kinds of information. However, you can configure each Managed Server's log level independently, if you have a reason to do so.

15.4 Configuring Settings for Log Files During Normal Operation

Although critical business logic sections of Oracle Fusion applications may write more information to log files than less critical areas of the application code, the amount of information that Oracle Fusion applications log depends primarily on how the environment is configured. Oracle supplies default values for log settings, but you can specify different setting values if you want to adjust the amount of information to be logged. Most Oracle Fusion Applications components use a standard set of log configuration settings. For information about the selected components that use nonstandard log settings, see Section 15.4.6.

This section contains the following topics:

The concepts of logging levels and profile options apply to most Oracle Fusion applications. Logging levels are thresholds that can be set to control how much information to log.

To set logging levels either for a whole site or for a particular user, administrators change profile option values from either the Log Configuration dialog in Fusion Applications Control or the Manage Administrator Profile Values screen in the Setup and Maintenance work area. For more information, see the chapter on maintaining common reference objects in the Oracle Fusion Applications Common Implementation Guide.

Under certain specific conditions, Oracle Fusion Applications users can set their own profile option for logging levels, from the Troubleshooting Options dialog under the Oracle Fusion Applications Help > Troubleshooting menu. Setting a logging level for a particular user is useful if you want only that user to gather more detailed log information while attempting to reproduce a problem. However, the Help > Troubleshooting menu displays the Troubleshooting Options command only for Oracle Fusion Applications users who have a job role that is mapped to the following three duty roles:

Note:

Oracle Fusion Applications seed data does not include a preconfigured job role that maps to these three duty roles. It is recommended that you define such a job role when you first need to give an Oracle Fusion Applications user access to the Troubleshooting Options dialog. You can reuse the same job role for other users who subsequently need the same access.

For more information about making the Troubleshooting Options command and dialog available to selected Oracle Fusion Applications users, and about working with those users to gather troubleshooting data, see Section 17.3.1.

The following types of settings affect how logging is done, including the effective logging level:

15.4.1 Default System Log Settings

The seed data for Oracle Fusion Applications contains default values for many profile option settings. Normal operation settings for log files are described in Table 15-1. For information about default system settings for incidents and QuickTrace, see Section 17.3.

Table 15-1 Profile Options for Oracle Fusion Applications Logging

Profile Option Name
(and Display Name)
Environment Description Possible
Values or
Example
Applicable
Profile
Hierarchy
Levels
Default
Value

AFLOG_BUFFER_MODE

(FND: Buffer Mode for PL/SQL)

PL/SQL only

Asynchronous buffer mode for PL/SQL logging. A value of 0 disables buffering; a value greater than 0 enables buffering for messages that have levels lower than WARNING. PL/SQL log messages that have SEVERE level or WARNING level are not buffered.

You may want to use asynchronous buffering if you have set your log levels to collect detailed information and find that your system is running slowly. When asynchronous buffering is enabled, log messages from PL/SQL code that are at the INFO log level or below are written to a buffer rather than being immediately written to a log file. This reduces disk I/O activity. The buffer is written to the log file only when it contains the number of records specified in the AFLOG_BUFFER_SIZE setting.

0, 1

Site, User

0

AFLOG_BUFFER_SIZE

(FND: Buffer Size for PL/SQL)

PL/SQL only

Number of PL/SQL log records that are buffered in memory before they are written to the log file, when AFLOG_BUFFER_MODE is set to enable asynchronous buffering. Increasing the number of records to be buffered may improve performance by reducing disk I/O activity.

1024

Site, User

1000

AFLOG_ENABLED

(FND: Log Enabled)

Java, PL/SQL, C, and SOA

Enables or disables standard logging functionality for Oracle Fusion Applications. If the value of this profile option is N, and if the profile option sets the effective logging level, then standard Oracle Fusion Applications logging does not occur at runtime for application modules written in Java, PL/SQL, SOA, or C. This profile option does not affect the configuration for Oracle Fusion Middleware.

Y, N

Site, User

Y

AFLOG_EXTENDED_ENABLED

(FND: Log Extension Enabled)

Java and SOA

Determines whether or not to log the following extended attributes:

  • Message cause
    (APPS_MESSAGE_CAUSE)

  • User action
    (APPS_USER_ACTION)

  • User details
    (APPS_USER_DETAILS)

  • Admin action
    (APPS_ADMIN_ACTION)

  • Admin details
    (APPS_ADMIN_DETAILS)

When the value of this profile option is Y, all of these extended attributes are logged. When the value of this profile option is N, none of these extended attributes are logged.

Y, N

Site

Y

AFLOG_FILENAME

(FND: Log File for C)

C only

Full path and file name of the log file for all of the Oracle Fusion applications that are written in C and that use standard logging functionality.

It is recommended that you set the value of this profile option to directory_path/
Cdiagnostic.log, where directory_path is a location that can be written to by all system users and by the Managed Server where Oracle Enterprise Scheduler is deployed for your Oracle Fusion applications. For example, you might set the value of directory_path to /tmp, or to an explicitly specified directory path that corresponds to the value of the APPLCP_DIR custom variable that was defined through use of the Oracle Fusion Applications Repository Creation Utility during installation.

If you do not set a directory path for this log file, the file is written to the default location specified by Oracle Enterprise Scheduler.

/temp/
Cdiagnostic.log

Site, User

diagnostic.log

AFLOG_LEVEL

(FND: Log Level)

Java, PL/SQL, C, and SOA

Minimum level of information detail to be logged for Oracle Fusion applications that use standard logging functionality. If no value is set for this profile option, the default value is 1000 (SEVERE).

For more information about log levels, see Section 15.4.3.

1000, 900, 800, 700, 500, 400, 300

Site, User

1000

AFLOG_MAX_FILE_SIZE

(FND: Maximum size for log file in MB.)

PL/SQL

Specifies the size in megabytes beyond which the current standard log file for Oracle Fusion applications that are written in PL/SQL is automatically renamed and a new log file is started.

10

Site

10

AFLOG_MODULE

(FND: Log Module Filter)

Java, PL/SQL, C, and SOA

Specifies the Oracle Fusion applications for which logging takes place. Use a comma-separated list of modules for the value of this setting, and use % as a wildcard. If no value is specified, all modules are logged.

%, %financial%

Site, User

%

AFLOG_NUMBER_OF_LOG_FILES

(FND: Number of old log files)

PL/SQL

The maximum number of PL/SQL log files the system keeps at any one time.

Any integer greater than 0.

Site

10

AFLOG_PLSQL_FILENAME

(FND: Log File for PL/SQL)

PL/SQL only

The location and name of the log file for standard Oracle Fusion Applications log messages that are generated from PL/SQL. The location must be expressed as a directory object.

By default, the SITE level value for this profile option is set to APPLLOG_DIR/
diagnostic.log, where APPLLOG_DIR is a directory object that was defined using the Oracle Fusion Applications Repository Creation Utility during installation.

If you want the log file name to indicate that the log messages are generated from PL/SQL, then you can change the AFLOG_PLSQL_FILENAME profile option value to a value such as APPLLOG_DIR/
plsqldiagnostic.log.

For more information about directory objects, see the section about the CREATE DIRECTORY command in the Oracle Database SQL Language Reference.

APPLLOG_DIR/
mylog.log

Site, User

APPLLOG_DIR/
diagnostic.log

FND_MESSAGE_MODE

(Message Mode)

Java, PL/SQL, C, and SOA

For error conditions that use messages from the message dictionary, this setting determines whether administrator-level or user-level message details and suggested actions are displayed and logged.

ADMIN, USER

Site, Product, User

User


15.4.2 When Changes to Log File Configuration Settings Take Effect

For PL/SQL and C processes such as scheduled jobs, changes to log file profile options take effect in the same ways as changes to any Oracle Fusion Applications profile option values. For more information, see the chapter on maintaining common reference objects in the Oracle Fusion Applications Common Implementation Guide.

For user sessions, users may need to log out from an Oracle Fusion application and log in again to have changes to log profile options take effect.

15.4.3 Standard Logging Levels

Seven severity levels are used for log messages in Oracle Fusion Applications, and each level is associated with a number. In circumstances where the effective logging level depends on the AFLOG_LEVEL logging profile option (rather than a lower odlLevel setting value), then, after the profile option level is set, only application messages that have a predefined severity level greater than or equal to the value of the AFLOG_LEVEL profile option are logged.

You can set the value of the AFLOG_LEVEL profile option to one value for the site as a whole and to another value for any user whose operations you want to log at a different level of detail.

For example, setting the level to the lowest severity, 300 (FINEST), for a particular user means that messages of all seven severities are logged for that user's operations. Setting the level to 900 (WARNING) for the site means that logging occurs for 900 (WARNING) and 1000 (SEVERE) messages for all site operations initiated by other users.

Note:

The default severity level for Oracle Fusion Applications is 1000 (SEVERE). For optimum performance, it is recommended that you use this logging level for your sites unless you need to investigate a problem that specifically requires a change to a site's severity level. Gathering detailed log information for an entire site (rather than a single user) can decrease system performance and make it difficult to find relevant information in a log file.

Table 15-2 describes the seven severity levels that are used for log messages in Oracle Fusion Applications. The messages in the log file identify the severity of errors using the ODL Message Type/Level value.

Note:

Oracle Fusion applications that are written in PL/SQL have logging level names that start with LEVEL_. Oracle Fusion applications that are written in Java, SOA, and C do not use this LEVEL_ prefix for level names. For example, the log level that is called LEVEL_SEVERE in PL/SQL application code is comparable to the log level that is called SEVERE in Java, SOA, or C code.

Most log levels provide information that is useful to Oracle Fusion Applications administrators. However, the information that is logged at the FINER and FINEST log levels is primarily intended for use by Oracle.

Table 15-2 Severity Levels for Logging Messages

ODL Message Type/Level (in Log Files) Log Level Name (in Oracle Enterprise Manager Fusion Applications Control and Help > Troubleshooting > Troubleshooting Options) AFLOG_LEVEL Profile Option Value (internal values stored in database tables) Usage and Examples

Log Levels for Reporting Failures and Normal Events:

ERROR:1

SEVERE

1000

Highest severity level. Unexpected errors that occur during normal execution. Irrecoverable exceptions or any other serious problems that require immediate attention from the System Administrator. An error at this level may also create an incident. For example, the following error messages might be associated with this log level:

The process cannot be started now because another process is using the data.

The participant's rate could not be found. Contact your benefits administrator to validate the standard rate for this compensation object.

WARNING:1

WARNING

900

Internal software failures. Exceptions or errors that allow processing to continue without requiring immediate attention from an administrator. Any potential problem that should be reviewed by the System Administrator.

For example, the following error message might be associated with this log level:

You must change your password before date.

NOTIFICATION:1

INFO

800

Errors, warnings, and other kinds of information that allow processing to continue. May include key flow steps, high-level functional progress messages, and major life cycle events such as the activation or deactivation of a primary subcomponent or feature.

Log Levels for Tracing and Reporting Progress:

NOTIFICATION:16

CONFIG

700

Configuration properties and environment settings. This is a finer level of granularity for reporting normal events.

TRACE:1

FINE

500

High-level technical progress messages; more detailed than INFO level. Trace or debugging information for events that are meaningful to users of the product, such as public application programming interface (API) entry or exit points.

For example, the following error message might be associated with this log level:

User has chosen to cancel the Purge operation.

TRACE:16

FINER

400

Logging messages that are called at the beginning and end of a routine. Detailed trace or debugging information that can help Oracle Support diagnose problems with a particular subsystem.

For example, the following error message might be associated with this log level:

Entering validateLogin.

TRACE:32

FINEST

300

Very detailed trace or debugging information that would be useful to an Oracle developer who is working on the product and who is familiar with implementation details of the subsystem that generates the message.

For example, the following error message might be associated with this log level:

Copying string from buffer xyz to 
buffer zzz.

Note:

Whenever an incident is created, a different log level, INCIDENT_ERROR, automatically appears in the corresponding log entry. This is the only context in which the INCIDENT_ERROR log level is used. For more information about working with incidents, see Chapter 17.

15.4.4 Managing Log File Size and Disk Space Usage

In busy computing environments, the amount of disk space used by log files can become a concern. Large log files can also affect system performance. Oracle Fusion applications that are written in Java, SOA, or PL/SQL address this concern using automatic log file rotation.

This section contains the following topics:

Note:

Oracle Fusion applications that are written in C require you to monitor the space used and manually discard log files that are no longer needed.

15.4.4.1 Managing Rotating Log File Space Usage for Java and SOA Applications

For Oracle Fusion Applications modules that are implemented using Java or SOA and that use standard logging, when a the log file reaches a specific size or when a specific time period has passed, the file is automatically renamed, and a new log file is created.

You can use any of the following methods to adjust the settings that determine the maximum log file size and the maximum length of time that a log file covers:

  • Use Fusion Middleware Control commands to change the log rotation policies for the oracle.apps.appslogger logger. For more information, see "Specifying Log File Rotation Using Fusion Middleware Control" in the Oracle Fusion Middleware Administrator's Guide.

  • Edit the settings in the log_handler section of the ODL configuration file, at the following location, where DOMAIN_HOME is the domain home directory for the Oracle WebLogic Server domain, and WebLogic_Server_Name is the name of the WebLogic Server that uses the logging.xml file:

    DOMAIN_HOME/config/fmwconfig/servers/WebLogic_Server_Name/logging.xml
    
  • Use Oracle WebLogic Scripting Tool (WLST) Log Configuration commands to change the log rotation policies for the apps-handler log handler. For more information, see the section about the configureLogHandler command in the chapter on logging commands in the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference and "Specifying Log File Rotation Using WLST" in the Oracle Fusion Middleware Administrator's Guide.

The maxFileSize or Maximum Log File Size setting determines the maximum size that a standard Java or SOA log file can reach before being renamed. The default value is 10,485,760 bytes.

The rotationFrequency or Frequency setting determines the maximum amount of time that can pass before a standard Java or SOA log file is renamed. There is no default value for this setting. If no value is specified, then the log file is not renamed after any particular time period, but only when it reaches its maximum allowed size. Valid values for the rotationFrequency setting are numbers representing the length of the time period in minutes, and the following case-insensitive values:

  • Hourly

  • Daily

  • Weekly

When a standard Java or SOA log file is renamed, the new name is of the format log_file_name-n.log, where n is a positive integer and log_file_name is the file name specified for the path property of the apps-handler log handler in the logging.xml file. (By default, log_file_name is set to server_name-diagnostic.log.)

In log_file_name-n.log, the value of n depends on the names of the log files that are already present in the directory. If the directory contains no previously renamed log files, then the first renamed log file is called log_file_name-1.log. If other log files exist, then n is set to the next higher integer after the highest integer that is already in use. For example, if the directory contains log_file_name-1.log through log_file_name-8.log at the time when log_file_name.log reaches a time or size limit, then the log_file_name.log file is renamed to log_file_name-9.log

When the aggregated size of current and older log files reaches a specific value, older log files are deleted automatically, to keep the disk space usage of the log file directory below that specific value.

The maxLogSize or Maximum Size of All Log Files setting determines the directory size at which older log files begin to be deleted. The default value is 104,857,600 bytes.

15.4.4.2 Managing Rotating Log File Space Usage for PL/SQL Applications

For Oracle Fusion Applications modules that are implemented using PL/SQL, when a diagnostic.log file reaches a specific size, the diagnostic.log file is automatically renamed, and a new diagnostic.log file is created. If the AFLOG_PLSQL_FILENAME profile option is set so that the logging framework uses a log file name other than diagnostic.log, then the file name that the profile option specifies is used, instead of diagnostic.log.

Use the following profile options settings to specify the maximum log file size:

  • AFLOG_MAX_FILE_SIZE: This setting specifies the size in megabytes beyond which a PL/SQL log file name is automatically renamed and a new log file is started. The default value is 10 megabytes.

    Note:

    If the AFLOG_BUFFER_MODE profile option is set to a value larger than 0, enabling asynchronous buffering of PL/SQL log entries, then the actual maximum size of any single PL/SQL log file is the value of AFLOG_MAX_FILE_SIZE plus the number of megabytes that are flushed from the buffer. This value is approximate, because the amount of information that can accumulate in the buffer is set using the AFLOG_BUFFER_SIZE setting, which specifies a specific number of log records, rather than a specific number of megabytes.

  • AFLOG_NUMBER_OF_LOG_FILES: This setting specifies the maximum number of PL/SQL log files the system keeps at any one time. The default value is 10 files.

PL/SQL log rotation is currently done only on the basis of file size, not on the basis of the passage of a specified amount of time.

When a PL/SQL log file is renamed, the new name depends on whether or not the AFLOG_PLSQL_FILENAME profile option is set:

  • If the profile option is set, then the new log file name is of the format AFLOG_PLSQL_FILENAME_value-n.log, where n is a positive integer.

  • If the profile option is not set, then the new log file name is of the format diagnostic-n.log, where n is a positive integer.

The value of n depends on the names of the log files that are already present in the directory. If the directory contains no previously renamed log files, then the first renamed log file is called diagnostic-1.log or AFLOG_PLSQL_FILENAME_value-1.log. If other log files exist, then n is set to the next higher integer after the highest integer that is already in use. For example, if the directory contains diagnostic-1.log through diagnostic-8.log at the time when the diagnostic.log file surpasses the size limit set in the AFLOG_MAX_FILE_SIZE profile option, then the diagnostic.log file is renamed to diagnostic-9.log.

When the number of log files reaches the value specified using the AFLOG_NUMBER_OF_LOG_FILES profile option, then older log files are deleted automatically, to prevent the disk space usage of the log file directory from getting too large.

Over time, the value of n in diagnostic-n.log or AFLOG_PLSQL_FILENAME_value-n.log can become large enough to cause usability challenges or exceed the number of characters that the operating system allows in a file name. If you want to have the value of n start over at 1, you can move all existing log files except the currently active diagnostic.log file or AFLOG_PLSQL_FILENAME_value.log file into another directory. When the active file surpasses the size limit and the log rotation code finds no previously renamed log files in the directory, the active file is renamed using a value of 1 for n.

Note:

If your Oracle Fusion Applications environment includes multiple database nodes such as Oracle Real Application Clusters (RAC), then each database node corresponds to a server instance that has its own location for log files.

If an incident is created, then the server instance that creates the incident handles all subsequent jobs related to that incident. Identifiers for incidents are unique within a specific instance, but not across instances. For more information about working with incidents, see Chapter 17.

15.4.4.3 Managing Log File Space Usage for C Applications

Oracle Fusion Applications modules that are implemented in C currently produce log files that continually increase in size.

To manage log file space usage for log files created by Oracle Fusion Applications modules that are written in C:

  1. Navigate to the directory that contains the log files:

    • If the AFLOG_FILENAME profile option is set, then navigate to the location designated by the profile option value.

    • If the AFLOG_FILENAME profile option is not set, then navigate to the location set by Oracle Enterprise Scheduler Service.

      You can use Fusion Applications Control to determine the location of Oracle Enterprise Scheduler log files, as follows:

      1. In the navigation pane, expand the farm part of the navigational tree, then expand Scheduling Services, and then select an Oracle Enterprise Scheduler server as your target.

      2. In the context pane, from the Scheduling Service dropdown menu, choose Logs > View Log Messages.

      3. Click Target Log Files to view a list of log files associated with the selected server.

        For example, a typical path and file name might be the following, where DOMAIN_HOME is the domain home directory, SERVER_HOME is the server home directory, and serverName is the name of the Oracle Enterprise Scheduler server:

        DOMAIN_HOME/servers/SERVER_HOME/logs/serverName-diagnostic.log
        
  2. Rename the log file that is currently in use.

    For example, if the current log file is called Cdiagnostic.log, you might rename it to Cdiagnostic_MMDDYYYY.log, where MMDDYYYY is the current date.

  3. Delete any previously renamed log files that you no longer need.

15.4.5 Using Profile Options to Configure Standard Log Settings

Oracle Fusion applications that use standard logging functionality use profile option values to configure how much information to log. Ordinarily, these profile options are set at the Site level, but some can also be set at the User level, to gather more information into the log file for a particular user.

Note:

For information about configuring Oracle Fusion Middleware log settings, including settings for Oracle Enterprise Scheduler and Oracle Enterprise Crawl and Search Framework, see "Configuring Settings for Log Files" in the Oracle Fusion Middleware Administrator's Guide. For information about configuring profile option values for incident and QuickTrace settings, see Section 17.3.

You can use either Fusion Applications Control or the Setup and Maintenance work area to configure most profile options for standard Oracle Fusion Applications logging functionality. However, some settings may be available in only one of those two locations. For example, you can set the AFLOG_FILENAME profile option for an individual user by using the Manage Administrator Profile Values screen in the Setup and Maintenance work area, but not by using Fusion Applications Control. For information about how to use the Setup and Maintenance work area for setting profile option values, see the chapter on maintaining common reference objects in the Oracle Fusion Applications Common Implementation Guide.

Note:

To set logging profile option values that affect other users, you must log in as a user who has the Manage All Application Profile Values function security privilege. By default, this privilege is carried by the Applications Common Application Profile Value Administration Duty role, which the predefined Application Administrator job role inherits. You can use Oracle Identity Manager to determine whether you have the Application Administrator job role.

If you want to change profile option values for others without being provisioned with the Application Administrator job role or the Applications Common Application Profile Value Administration Duty role, then you can use Oracle Authorization Policy Manager to determine which other duty roles have the Manage All Application Profile Values function security privilege and which job roles inherit those duty roles. You can use Oracle Identity Manager to make sure that you have a job role that inherits one of those duty roles.

For more information about working with roles and privileges, see the Oracle Fusion Applications Security Guide, the Oracle Fusion Middleware User's Guide for Oracle Identity Manager, and the Oracle Fusion Middleware Oracle Authorization Policy Manager Administrator's Guide (Oracle Fusion Applications Edition).

To use Fusion Applications Control to configure profile options for standard Oracle Fusion Applications logging functionality:

  1. From the navigation pane, select one of the following target types:

    • A product family target that lets you configure the log profile options for all of the Oracle Fusion applications in the selected product family. For example, you could select the Financials product family target.

    • An Oracle Fusion Applications cluster application target that lets you configure the log profile options for the selected application on all of the servers in the selected cluster. For example, you could expand Financials and Fusion Applications and then select the PayablesApp cluster application target.

    • An Oracle Fusion application instance target that lets you configure the log profile options for the selected application on the selected sever. For example, you could expand Financials and Fusion Applications and PayablesApp and then select the PayablesApp (PayablesServer_1) application instance target.

  2. In the context pane, from the target type dropdown menu, choose Logs > Log Configuration.

  3. In the Logging Profile Configuration dialog, click one of the following tabs to determine whether you set the logging level for the whole site or for a single user:

    • Site-Level

    • User-Level

  4. If you clicked Site-Level, then skip to Step 5.

    If you clicked User-Level, then complete the following substeps:

    1. Inspect the table on the User-Level tab for the user name for which you want to change logging levels.

      If the user name is listed, then select it and click Edit to display the Edit User-Level Configuration dialog.

      If the user name is not listed, then click Add and enter it in the Name field of the Add Logging Profile Configuration dialog.

    2. From the Log Level dropdown list, select the log level that corresponds to the kinds of information you want to gather.

      For more information, see Table 15-2.

    3. In the Logging Enabled field, make sure that the checkbox is selected.

    4. In the Module Filters field, indicate if you want Oracle Fusion Applications to log only for a particular code module for the selected user—by default, log entries are written for all Oracle Fusion Applications code modules that use standard logging implementation for Oracle Fusion Applications.

      Note:

      If you specify that logging for the selected user should be done only for a particular code module, that setting will not affect the information that is logged for other users.

    5. If you want to change whether PL/SQL modules buffer log entries of levels lower than Warning, then expand the Advanced profile configuration section of the dialog and select Enabled or Disabled for the Buffer Mode setting.

    6. If Buffer Mode is set to Enabled and you want to change the number of PL/SQL log records that will be buffered in memory before they are written to the log file, then enter the number of records to buffer in the Buffer Size field.

    7. If you want PL/SQL log records to be written to a log file location other than the default, then enter the path and file name in the File Name field in the PL/SQL Settings section.

      Note:

      If you want a particular user's C log records to be written to a log file location other than the default, then you must change the value of the user's AFLOG_FILENAME profile option using the Manage Administrator Profile Values screen in the Setup and Maintenance work area, rather than Fusion Applications Control. For information about how to use the Setup and Maintenance work area for setting profile option values, see the chapter on maintaining common reference objects in the Oracle Fusion Applications Common Implementation Guide.

    8. Click OK.

    Skip Step 5.

  5. If you clicked Site-Level, complete the following substeps:

    1. From the Log Level dropdown list, select the log level that corresponds to the kinds of information you want to gather.

      For more information, see Table 15-2.

    2. Make sure that both Logging Enabled and Incident Enabled are selected.

    3. In the Module Filters field, indicate if you want Oracle Fusion Applications to log only for a particular code module—by default, log entries are written for all Oracle Fusion Applications code modules that use standard logging implementation for Oracle Fusion Applications.

    4. Expand the Advanced profile configuration section of the dialog.

    5. In the Java Settings section of the dialog, for purposes of normal operation, verify that the QuickTrace Enabled checkbox is selected and that QuickTrace Level is set to Fine.

      For more information about changing QuickTrace settings for troubleshooting, see Section 17.3.7.

    6. If you want to change whether PL/SQL modules buffer log entries of levels lower than Warning, then select Enabled or Disabled for the Buffer Mode setting.

    7. If Buffer Mode is set to Enabled and you want to change the number of PL/SQL log records that will be buffered in memory before they are written to the log file, then enter the number of records to buffer in the Buffer Size field.

    8. If you want PL/SQL log records to be written to a log file location other than the default, then enter the path and file name in the File Name field in the PL/SQL Settings section.

    9. If you want C log records to be written to a log file location other than the default, then enter the path and file name in the File Name field in the C Settings section.

    10. Click Apply.

15.4.6 Using Additional Settings to Configure Logs for Selected Components

Some functionality areas in Oracle Fusion Applications use nonstandard logging mechanisms that are disabled by default. For these areas, you must turn on the logging facility when you need it and specify the kind of information that you want to record in the log file. Some other functionality areas use nonstandard logging mechanisms that are usually set to gather minimal amounts of information. You may want to change those settings when troubleshooting.

This section contains the following topics:

15.4.6.1 Configuring Additional Log Settings for Oracle Fusion Global Payroll

The logging functionality for the Oracle Fusion Global Payroll application is separate from the standard logging functionality for Oracle Fusion Applications. By default, the Oracle Fusion Global Payroll application does not write log entries. For optimum performance and log file sizes, it is recommended that you use Oracle Fusion Global Payroll logging functionality only when troubleshooting an existing problem. For more information, see Section 17.3.10.

15.4.6.2 Configuring Additional Log Settings for Oracle Fusion Incentive Compensation Batch Jobs

The logging functionality for certain Oracle Fusion Incentive Compensation batch jobs is separate from the standard logging functionality for Oracle Fusion Applications. By default, the following kinds of Oracle Fusion Incentive Compensation batch jobs do not write log entries:

  • Calculation

  • Classification

  • Collection

  • Crediting

  • Rollup

For optimum performance and log file sizes, it is recommended that you use the logging functionality for these areas only when troubleshooting an existing problem. For more information, see Section 17.3.11.

15.4.6.3 Configuring Additional Log Settings for Oracle Fusion General Ledger

In the Oracle Fusion Financials product family, some logging functionality for the Oracle Fusion General Ledger application is separate from the standard logging functionality for Oracle Fusion Applications. By default, the following kinds of Oracle Fusion General Ledger batch jobs do not write log entries:

  • OpenPeriod

  • Posting

  • Translation

  • Close Process - Create Income Statement Closing Journals

  • Close Process - Create Balance Sheet Closing Journals

For optimum performance and log file sizes, it is recommended that you use the logging functionality for these areas only when troubleshooting an existing problem. For more information, see Section 17.3.12.

15.4.6.4 Configuring Additional Log Settings for Oracle Fusion Receivables AutoInvoice

In the Oracle Fusion Financials product family, logging functionality for the AutoInvoice portion of the Oracle Fusion Receivables application is separate from the standard logging functionality for Oracle Fusion Applications. The amount of information that is logged for AutoInvoice depends on the value of the Log File Message Level system option setting.

To set the amount of information that the Oracle Fusion Receivables application logs for the AutoInvoice functionality area:

  1. In the Oracle Fusion Receivables application, choose Setup and Maintenance from the Navigator menu.

  2. Complete the following substeps to navigate to the Edit System Options screen for the Manage Receivables System Options task.

    1. Expand the Search: Tasks pane.

    2. Enter Manage Receivables System Options in the Name field and click Search.

    3. In the Manage Receivables System Options row of the Search Results table, click Go to Task.

    4. In the Search area of the Manage Receivables System Options screen, select Business Unit from the dropdown list, enter the name of a business unit for which you want to set up the amount of AutoInvoice information to be logged, and then click Search.

      Alternately, you can click Search without specifying a business unit name to display a list of the available business units.

    5. In the Search Results table, click the name of the business unit for which you want to set up the amount of AutoInvoice information to be logged.

  3. In the Edit System Options screen, scroll down to display the AutoInvoice area of the screen, and then set Log File Message Level to the value of 0, which is the recommended value for normal operations.

    Note:

    For optimum performance and log file sizes, it is recommended that you keep the Log File Message Level system option set to the lowest value that meets your everyday needs, and increase the value of the setting only when troubleshooting an existing problem. For more information about using this setting when troubleshooting, see Section 17.3.13.

  4. Click Save to put your changes into effect.

    Repeat this entire procedure for each additional business unit for which you want to configure AutoInvoice system options.

For information about configuring the Maximum Memory in Bytes system option for AutoInvoice, see your product-specific documentation in Oracle Fusion Applications Help.

15.4.7 Configuring Access to Logs for Fusion Applications Control

By default, you can use Fusion Applications Control to view log file entries that are generated by Java code in Oracle Fusion applications. To make it possible to view log file entries that are generated by PL/SQL or C code, you must perform the following configuration steps.

To make PL/SQL and C log file entries visible in Fusion Applications Control:

  1. Determine the locations of the PL/SQL and C log files written by your Oracle Fusion applications.

    If the values of the AFLOG_PLSQL_FILENAME and AFLOG_FILENAME profile options have been set, then those values determine log file locations for PL/SQL and C log files, respectively. For more information about these profile options and the log file locations that are used when these profile options are not set, see Section 15.3.6 and Section 15.4.1.

  2. Decide which Managed Server you want to use to view PL/SQL log files, C log files, or both, and make sure that the server has read access to all of the log file locations that you determined in Step 1.

    It is recommended that you use an Oracle WebLogic Server that runs Oracle Enterprise Scheduler for this purpose.

    Note:

    If you want to use more than one Managed Server to view PL/SQL log files, C log files, or both, then you can do so, provided that each server has read access to the log files that you want to view through that server. However, it is not especially valuable to use multiple servers to view a particular log file, because each server is providing access to the same data.

  3. On the Managed Server that you picked in Step 2, navigate to the following location, where DOMAIN_HOME is the domain home for the Managed Server and server_name is the name of the Managed Server:

    DOMAIN_HOME/config/fmwconfig/servers/server_name/diagnostics-registration
    

    If this location does not currently exist, create it now.

  4. In the diagnostics-registration subdirectory, for each log file that you determined in Step 1 and want to view using this server, use a text editor to create and save a file that contains the following lines, using any file name that has the format yourChosenFileName.xml:

    <?xml version='1.0' encoding='UTF-8'?>
    <logs xmlns='http://www.oracle.com/iAS/EMComponent/ojdl'>
     <log path="path_to_log_file">
      <logreader class="oracle.core.ojdl.reader.ODLLogReaderFactory">
      </logreader>
     </log>
    </logs>
    

    Substitute the full path and name of the log file for path_to_log_file, using the form of the path that is correct for the current server to use when accessing the file:

    • For a PL/SQL log, make sure that the value for path_to_log_file corresponds to the same location and file name as the value that you have set for the AFLOG_PLSQL_FILENAME profile option.

      Note:

      You must resolve and enter the full path to the path_to_log_file location, explicitly, rather than entering the directory object that is used to set the value of the AFLOG_PLSQL_FILENAME profile option.

    • For a C log, make sure that the value for path_to_log_file indicates the same location and file name as the value that you have set for the AFLOG_FILENAME profile option.

    Repeat this step, as needed, to create an individual .xml file for each log file that you determined in Step 1 and want to view using this server. You can save each file using any unique valid file name that ends in .xml. For example, the file name might be plsqlfndlog.xml for a PL/SQL log and cfndlog.xml for a C log.

  5. In Fusion Applications Control, verify that each log file from Step 1 is now listed in an appropriate Target Log Files list:

    1. From the navigation pane, select a target for which you created an .xml file.

      For example, you might expand the Financials product family entry, and then expand the Fusion Applications and PayablesApp entries, and then select the PayablesApp (PayablesServer_1) application instance target.

    2. In the context pane, from the dynamic target menu, choose Logs > View Log Messages to display the log messages for the selected target.

    3. Click Target Log Files.

    4. Verify that the resulting list includes the all of the log files that are applicable for the selected target, including any applicable log files for which you created .xml files.

      The View Log Message page includes information from all log files that appear on this list.

  6. Repeat Step 5 for any other targets for which you created an .xml file.