1. Installation and Configuration Troubleshooting Guide
  2. Using EPM System Logs
  3. ODL Configuration

ODL Configuration

Each Oracle Enterprise Performance Management System product using the ODL logging format has at least one logging configuration file, logging.xml. EPM System components have descriptive names in the format loggingCOMPONENT_NAME.xml.

Logging configuration files comprise two sections: log_handlers and loggers. The log_handlers section defines the loggers and their parameters while the loggers section identifies details including the logging level and the log_handler to use.

See Table 3-9 for a list of log_handler properties that you can specify.

ODL Logging Levels

Table 3-7 ODL Logging Levels

Level Description
INCIDENT_ERROR:1 Messages related to a serious problem caused by unknown reasons. Users must resort to Oracle support to resolve the problem.
ERROR:1 Messages related to a serious problem that requires immediate attention from the System Administrator, but which are not caused by a defect in an EPM System component
WARNING:1 Messages related to a potential problem that a System Administrator should review
NOTIFICATION:1 Messages related to a major lifecycle event such as the activation or deactivation of a primary subcomponent or feature
NOTIFICATION:16 Messages related to normal events in EPM System components
TRACE:1 Trace or debug messages of events that are meaningful to end users of EPM System components
TRACE:16 Detailed trace or debug messages that Oracle Support can use to diagnose problems with EPM System components
TRACE:32 Very detailed trace or debug messages, usually intended for an Oracle Developer to locate the source from which the error emanated

ODL Configuration File: Single Managed Server Deployments

Deployment of EPM System components to a single managed server generates a unified logging configuration file logging.xml for all deployed Java web applications. On a Windows server, this file is usually located in MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/EPMServer0.

ODL Configuration Files: Standard Deployments

Standard deployment of EPM System generates a logging configuration file logging.xml for each deployed Java web application. On a Windows server, these files are usually located as follows:

Table 3-8 Location of ODL Configuration Files in Standard Deployments

Component Location of logging.xml
Administration Server (Oracle WebLogic Server Administration Console, Oracle Web Services Manager, Enterprise Manager) MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/AdminServer/logging.xml
Oracle Hyperion Provider Services MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/AnalyticProviderServices0/logging.xml
Oracle Hyperion Calculation Manager MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/CalcMgr0/logging.xml
Oracle Essbase Administration Services MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/EssbaseAdminServices0/logging.xml
Oracle Hyperion Foundation Services MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/FoundationServices0/logging.xml
Oracle Hyperion Financial Management Web MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/HFMWeb0/logging.xml
Oracle Hyperion Planning MIDDLEWARE_HOME/user_projects/domains/EPMSystem/config/fmwconfig/servers/Planning0/logging.xml

Modifying ODL Configuration Files

You modify the properties of the loggers defined in logging.xml to determine the message levels that are logged. By default, the logging level appropriate for normal operation of EPM System components are set in logging.xml. Additional log handler parameters can be set to change the logging behavior. For example, you can specify the logging file rotation frequency by including the rotationFrequency parameter to the log handler. See Table 3-9 for a comprehensive list of parameters.

Table 3-9 Configurable ODL Log Properties

Log Property Description

path

Log path

format

Format to use

The recommended value is ODL-Text.

maxFileSize

Maximum size in bytes for each log file

When the main log file reaches the given size, a log rotation is triggered, and the main log file is archived and a new log file is created.

maxLogSize

Maximum size in bytes for the entire log

Older archive files are deleted to keep the total log size under the given limit.

rotationFrequency

Frequency, in minutes, for rotating the logs

The value must be a number (of minutes), or the word hourly, daily, or weekly. (This setting is not case-sensitive.)

baseRotationTime

Base time for time-based log rotation; for example, the starting point for the rotationFrequency setting

Default: January 1, 1970, UTC

Use one of these formats:

  • HH:mm

  • yyyy-MM-dd

  • yyyy-MM-ddT-HH:mm

  • yyyy-MM-dd-HH:mm:ss.sTZ, where TZ is the time zone indicator and can be Z for UTC or an offset from Greenwich Mean Time in the format plus_or_minusHH:mmm

Note:

If the time format does not specify a time zone, the local time zone is used.

retentionPeriod

How long log files are kept

Files that are older than the given period are deleted. Files are deleted only when there is a log rotation; no background thread deletes log files. As a result, files may not be deleted for some time after the retention period expires. The value must be a number (minutes), or day, week, month (30 days), or year (values are not case-sensitive).

encoding

The type of character encoding to use

XML files must be UTF-8 encoded to handle extended characters. The default is <?xml version="1.0" encoding="UTF-8" ?>.

supplementalAttributes

A comma-separated list of supplemental attribute names, which can be added to each log message

The attribute value must be defined in class ExecutionContext.

useSourceClassAndMethod

Whether the Java source class and method name should be added to each log message

The value is a Level name. Messages of a given level or lower include the source class and method name. The constants true and false are also accepted as aliases for OFF and ALL. The default value is TRACE:1 (Fine).

useDefaultAttributes

Whether default attribute values should be added to each log message

The default attributes that can be assigned are HOST_ID, HOST_NWADDR and USER_ID. The value should be true or false. The default value is true for the ODL-XML format and false for the ODL-Text format.

includeMessageArguments

Whether message arguments are included with formatted log messages that also have a message ID

Possible values: true (default) or false.

useThreadName

The useThreadName flag, which flags controls if the handler attempts to log the real thread name instead of the threadID provided by the java.util.logging.LogRecord.

If the flag is true, the handler attempts to log the real thread name. In some cases, the handler may not be able to determine the real thread name, in which case it will log the threadID. The default value is true.

useRealThreadId

The useRealThreadId flag, which flags controls if the handler attempts to log the real thread ID instead of the threadID provided by the java.util.logging.LogRecord.

If the flag is true, the handler attempts to log the real thread ID. In some cases, the handler may not be able to determine the real thread name, in which case it will log the threadID. The default value is false. Logging the real Thread ID is mutually exclusive with the useThreadName property. If useThreadName is true, the value of the useRealThreadId property is ignored.

locale

Default Locale override for localizing messages

The default value is the default Locale, which is set in EPM System Configurator.

keepOpen

Whether the main log file is kept open at all times or opened and closed upon each log operation.

Possible settings: true and false. The default setting is true, which keeps the main log file open at all times.

In most cases you should use the default value.

autoFlushLevel

The level setting for autoflushing

The ODLHandler allows log records to be buffered, but it automatically flushes the buffer when it gets a log record with level equal to or higher than the specified autoFlush level. The default value is NOTIFICATION:1.

addJvmNumber

The JVM number added to the log file name

The JVM number is defined by system property oracle.process.index. If the system property is not set, this option is ignored.

applicationContextProvider

The name of a class that implements the ApplicationContext interface

The class must have a default constructor. The special value disabled can be used to disable logging of application name. The default application context provider is platform-specific; in most cases you need not set this property.

userContextProvider

The name of a class that implements the UserContext interface

The class must have a default constructor. The special value disabled can be used to disable logging of the user name. The default user context provider is platform-specific; in most cases you need not set this property.

You modify the properties of loggers to debug a component or generate the information that Oracle Support requests to identify issues with an EPM System component.

For example, to capture Oracle Hyperion Shared Services debugging messages, change the logging level in each Shared Services logger definition to TRACE:32.

Note:

After debugging is complete, restore original logging.xml from a backup copy to ensure optimal logging settings.

To modify the logging configuration file:

  1. Create a backup copy of the logging configuration file of the EPM System component whose logging behavior is to be changed. See EPM System Product Logging Matrix.

  2. Using a text editor, open logging.xml.

  3. Locate the logger definitions. For example, to change the logging level of Shared Services, change the following logger definitions: 

    <logger name="oracle.EPMCAS" level="NOTIFICATION:1" useParentHandlers="false">
     <handler name="epmcas-handler" />
</logger>
<logger name="oracle.EPMCES" level="NOTIFICATION:1" useParentHandlers="false">
     <handler name="epmces-handler" />
</logger>
<logger name="oracle.EPMCMS" level="NOTIFICATION:1" useParentHandlers="false">
     <handler name="epmcms-handler" />
</logger>
<logger level="NOTIFICATION:1" name="oracle.EPMCSS">
     <handler name="epmcss-handler" />
</logger>

  4. Modify the level property as needed to change the message logging level. For example, set the level property of each logger to TRACE:32 to log detailed debug messages.

    See ODL Logging Levels.

  5. Save and close logging.xml.

  6. Restart the EPM System component to activate the changes.