This section discusses diagnostic log files and diagnostic log configuration files, and contains the following topics:
■ Section 8.3.1, "What Are Diagnostic Log Files and Where Are They Located?" ■ Section 8.3.2, "What Are Diagnostic Log Configuration Files and Where Are They
Located?"
■ Section 8.3.3, "What Are Log File Message Categories and Levels?" ■ Section 8.3.4, "What is Log File Rotation?"
8.3.1 What Are Diagnostic Log Files and Where Are They Located?
Diagnostic log files are files used to store message information that is generated by Oracle Business Intelligence servers. These log files are stored in the following location:
ORACLE_INSTANCE\diagnostics\logs\component_type\coreapplication
The following diagnostic log files are used in Oracle Business Intelligence:
■ Presentation Services
– \CatalogCrawler\sawcatalogcrawlerlogsysn.log — The catalog crawler log file, which is not searchable in the Fusion Middleware Control Log Viewer.
– sawlogn.log — The Presentation Services log file that represents the latest part of diagnostic log output and is searchable in the Fusion Middleware Control Log Viewer.
For more information specifically about Presentation Services logging, see
Section 8.5, "Logging in Oracle BI Presentation Services." ■ Oracle BI Server
– nqquery<n>.log — The Oracle BI Server query log, which is not searchable in the Fusion Middleware Control Log Viewer.
<n> = date and timestamp, for example nqquery-20101209-2135.log
– nqserver<n>.log — The Oracle BI Server main diagnostic log, which is searchable in the Fusion Middleware Control Log Viewer.
<n> = date and timestamp, for example nqserver-20101209-2135.log
– nqsadmintool.log — The log for the Oracle BI Administration Tool.
– Oracle BI Server utilities — For example, biserverxmlexec and equalizerpds, also generate their own logs when they are run.
■ JavaHost
– jh-n.log — The JavaHost Server main diagnostic log, which is searchable in the Fusion Middleware Control Log Viewer.
Understanding Diagnostic Log and Log Configuration Files
■ Oracle BI Scheduler
– nqscheduler-<n>.log — The Oracle BI Scheduler log file, which is searchable in the Fusion Middleware Control Log Viewer.
<n> = date and timestamp, for example nqscheduler-20100909-2135.log
■ Cluster Controller
– nqcluster-yyyyMMdd-hhmm.log — The Oracle BI Cluster Controller diagnostic file, which is searchable in the Fusion Middleware Control Log Viewer.
<n> = date and timestamp, for example nqcluster-20100909-2135.log
■ BI JEE log (Action Services and Security Services), both of the following log files
are searchable in the Fusion Middleware Control Log Viewer:
– AdminServer-diagnostic.log
– bi_server1-diagnostic.log
■ Upgrade
Log files for the upgrade of Oracle Business Intelligence are created in the following location:
ORACLE_HOME\upgrade\logs
For information about upgrade log files, see Oracle Fusion Middleware Upgrade Guide for Oracle Business Intelligence. These files are not searchable in the Fusion Middleware Control Log Viewer.
8.3.2 What Are Diagnostic Log Configuration Files and Where Are They Located?
Diagnostic log configuration files control output to diagnostic log files for Oracle Business Intelligence.
Log configuration files for Oracle Business Intelligence are stored in the following locations:
ORACLE_INSTANCE\config\component_type\bi_component_name
For example: ■ \OPMN\opmn\opmn.xml ■ \OracleBIClusterControllerComponent\coreapplication_obiccs1\ccslogconfig.xml ■ \OracleBIJavaHostComponent\coreapplication_obijh1\logging_config.xml ■ \OracleBIPresentationServicesComponent\coreapplication_ obips1\instanceconfig.xml ■ \OracleBISchedulerComponent\coreapplication_obisch1\instanceconfig.xml ■ \OracleBIServerComponent\coreapplication_obis1\logconfig.xml
Note: Editing a diagnostic log configuration file for a single component is not advised, because changes might subsequently be overwritten. For information, see Section 3.4, "Using a Text Editor to Update Configuration Settings."
Understanding Diagnostic Log and Log Configuration Files
Diagnosing and Resolving Issues in Oracle Business Intelligence 8-7
About Formats in Diagnostic Log Configuration Files
Diagnostic log configuration files conform to the Oracle Diagnostic Log (ODL) standard, although they can differ slightly in appearance.
Example 8–1 and Example 8–2 illustrate two of the log configuration files for Oracle Business Intelligence.
Example 8–1 BI Server Diagnostic Log Configuration File Format
<server> <ServerInstance> <Log> <MaximumFileSizeKb>10000</MaximumFileSizeKb> <MaximumLogAgeDay>60</MaximumLogAgeDay> <Format>ODL-TEXT</Format> <Level> <IncidentError>1</IncidentError> <Error>1</Error> <Warning>16</Warning> <Notification>1</Notification> <Trace>16</Trace> </Level> </Log> <UserLog> <MaximumFileSizeKb>10000</MaximumFileSizeKb> <MaximumLogAgeDay>10</MaximumLogAgeDay> <Format>ODL-TEXT</Format> </UserLog> </ServerInstance> </server>
Example 8–2 JavaHost Server Diagnostic Log Configuration File Format
<?xml version = '1.0' encoding = 'utf-8'?> <logging_configuration>
<log_handlers>
<log_handler name='odl-handler'
class='oracle.core.ojdl.logging.ODLHandlerFactory'> <property name='path' value='C:\oracle_bi_ee_ BIFNDNPTPSNT0911060426S-Release\jhlogs\javahost.log'/>
<property name='maxFileSize' value='1000000'/> <property name='maxLogSize' value='5000000'/> </log_handler>
</log_handlers> <loggers>
<logger name='saw' level='NOTIFICATION:1' useParentHandlers='false'> <handler name='odl-handler'/>
</logger> </loggers>
</logging_configuration>
Oracle Business Intelligence components control their diagnostic log files by using server-specific settings in their log configuration files, for example:
■ Oracle BI Presentation Services log configuration file:
- writerClassId settings configure messages that the system writes to the sawlog.log file.
Understanding Diagnostic Log and Log Configuration Files
- Log settings configure messages that the system writes to the nqserver.log file. For more information, see Section 8.3.5, "What Messages Are Included in the System Log?"
- UserLog settings configure messages that the system writes to the nqquery.log file.
For more information, see Section 8.4, "Managing the Query Log." ■ Oracle BI Scheduler log configuration file:
- Log settings configure messages that the system writes to the nqscheduler.log file.
■ JavaHost Server log configuration file:
- log_handlers elements and subelements enable configuration of the log file rotation policy and the specification of the log file name and its location.
- loggers elements and subelements enable appropriate handling of Java component (JavaHost Server) log levels, by mapping the JavaHost Server log levels to the standard Oracle Diagnostic Log (ODL) log levels.
8.3.3 What Are Log File Message Categories and Levels?
Categories and levels for log file messages define the detail and level of importance with which the system writes messages to a log file. Fusion Middleware Control enables you to control these settings in the logconfig.xml file.
Each message category in a log file for Oracle Business Intelligence is set to a specific default value between 1 and 32, and only messages with a level less than or equal to the log level is logged.
Log file message categories are described in Table 8–1.
Table 8–1 Log File Message Category Levels
Category:Level Description
IncidentError:1 A serious problem caused by unknown reasons has occurred. You can fix the problem only by contacting Oracle Support Services.
No performance impact.
Error:1 A problem that requires attention from the system administrator has occurred.
No performance impact.
Warning:1 An action occurred or a condition was discovered that should be reviewed and might require action before an error occurs. No performance impact.
Notification:1 A report of a normal action or event has occurred. This could be a user operation, such as "login completed" or an automatic operation such as a log file rotation.
No performance impact.
Notification:16 A configuration-related message or problem has occurred.
Low performance impact. It should be possible to enable this level broadly in a production environment without having a significant performance impact in the software.
Understanding Diagnostic Log and Log Configuration Files
Diagnosing and Resolving Issues in Oracle Business Intelligence 8-9
In the following log configuration file example, in the Notification message category, only level 1 messages are logged. If the log level is set to 0, then nothing is logged for that message category.
<Level> <IncidentError>1</IncidentError> <Error>1</Error> <Warning>1</Warning> <Notification>1</Notification> <Trace>1</Trace> </Level>
Avoid manually changing the default settings in the log file. Use Fusion Middleware Control to make changes. For more information, see Section 8.2.2.1, "Using Fusion Middleware Control to Configure Log File Rotation Policy and Specify Log Levels."
8.3.4 What is Log File Rotation?
Log file rotation is the creation of new log files, when the file exceeds a specified threshold or date. Take the MaximumFileSizeKb setting for the component log configuration file for the Oracle BI Scheduler as an example. Whenever a log file exceeds the size that is specified by this setting, then the existing Scheduler log file is renamed, and a new log file is created. Additionally, a log file date that is older than the MaximumLogAgeDay setting is deleted. The file naming convention for the Scheduler is as follows:
■ nqscheduler.log — The latest log file.
■ nqscheduler-<n>.log — The renamed previous log file.
where <n> = date and timestamp, for example nqscheduler-20100909-2135.log
Trace:1 A trace or debug message that is used for debugging or performance monitoring has been written. Typically this message contains detailed event data that is clear enough to be understood by someone who does not know internal implementation details.
Small performance impact. This level might be enabled broadly occasionally on a production environment to debug issues with the software. Enabling logging at this level might have a small performance impact, but not to the point of making the software unusable.
Trace:16 A fairly detailed trace or debug message has been written. The message is clear enough to be understood by Oracle Support Services engineers who have a deep knowledge of the product but might not know full details of the internal implementation.
High performance impact. This level should not be enabled on a
production environment, except on special situations to debug issues with the software.
Trace:32 A highly detailed trace or debug message has been written. The message is intended for an Oracle developer working on the software who knows enough details about the implementation of the subsystem that generates the message.
Very high performance impact. This level is not expected to be enabled in a production environment and developers use it only to debug the software on a test or development environment.
Table 8–1 (Cont.) Log File Message Category Levels
Managing the Query Log
The naming convention that is used for settings in log configuration files differs slightly across components.
For more information, see Section 8.2.2.1, "Using Fusion Middleware Control to Configure Log File Rotation Policy and Specify Log Levels."
8.3.5 What Messages Are Included in the System Log?
The Oracle BI Server writes messages to the nqserver.log file, based on configuration settings. In addition to writing messages to this log file, the BI Server writes certain severe messages to the system log file for UNIX systems. The following list includes the kinds of messages that the BI Server writes to the system log file:
■ When the BI Server cannot start (for example, because another server has
previously started), then the system log file includes a message such as the following one:
Another server is already running on : @1%ls and port: @2%ls.
■ When memory problems occur, the system log file includes a message such as the
following one:
Could not enable the Low-Fragmentation Heap.
■ When the hard disk on the computer is full, the system log file includes a message
such as the following one: Out of disk space.