Reporting and Analysis Framework Logs

Table 11. Reporting and Analysis Framework Log Files

Log LocationLog Name and Description

Reporting and Analysis Framework:

EPM_ORACLE_INSTANCE/diagnostics/logs/ReportingAnalysis

  • Reporting and Analysis Framework services logging information:

    • configuration_messages_${module}.log—Reporting and Analysis Framework services configuration information

    • eiengine.log—Log messages of EIEngine utility (export/import utility)

    • logwriter_messages_${module}.log—Log file with inside log Reporting and Analysis Framework services messages

    • server_messages_${OriginatorType}.log—The pattern for Reporting and Analysis Framework services log files. These files contain RAF services log messages.

    • stdout_console_${module}.log—stdout (console) log file for Reporting and Analysis Framework services. It contains the information about started Reporting and Analysis Framework services, some stdout console logs.

  • agent.log and stdout_console_agent.log—Reporting and Analysis Framework Agent logging information

  • JobUtilities.log—Job Utilities activities for Calendar Manager

  • migrator.log—Migration activities

  • /MigrationUtility/migration_systime}.log—Migration utility logs

  • /SDK/sdk.log—Software Development Kit log

Web application logs:

MIDDLEWARE_HOME/user_projects/domains/domain name/servers/managed server name/logs

  • RaFramework0.log—Reporting and Analysis Framework Web application server logs

  • RaFramework_Bpmui.log - Miscellaneous messages; for example, locale detection

  • RaFramework_AdministrationServlet.log—Reporting and Analysis Framework Web application logs related to administration servlet

  • RaFramework_BrowseServlet.log—Reporting and Analysis Framework Web application logs related to browse servlet

  • RaFramework_Changemgmt.log—Impact Manager logs

  • RaFramework_CommonClient.log—Reporting and Analysis Framework Web application logs from common client functionality

  • RaFramework_DataAccessServlet.log - Reporting and Analysis Framework Web application logs related to data access servlet

  • RaFramework_Foundation.log - Reporting and Analysis Framework Web application logs related to interaction with Reporting and Analysis Framework services

  • RaFramework_JobManagerServlet.log - Reporting and Analysis Framework Web application logs related to job manager servlet

  • RaFramework_PersonalPagesServlet.log - Reporting and Analysis Framework Web application logs related to personal pages servlet

  • RaFramework_Portlets.log – Portlet infrastructure messages

  • RaFramework_Search.log – Search-related messages

  • RaFramework_WebServices.log – Web services-related messages

  • RaFramework_configuration_messages.log – Configuration messages

  • RaFramework_iHTMLServlet.log—Reporting and Analysis Framework Web application logs related to ihtml servlet

  • RaFramework_logwriter_servlets_messages.log—Reporting and Analysis Framework Web application log writer messages

  • RaFramework_stdout_console_servlets.log—log-stdout (console) log file for Reporting and Analysis Framework Web application

Service Log Files

Each service has a log file. In a distributed environment, all services of one type log their messages to one file. Separate log files are generated for configuration or environment information and for stdout messages.

Services log file names format:

server_messages_OriginatorType.log

where

OriginatorType is one of these service log files:

  • AnalyticBridgeService

  • AuthenticationService

  • AuthorizationService

  • CommonServices

  • DataAccessService

  • EventService

  • GSM

  • HarvesterService

  • IntelligenceService

  • IRJobService

  • IRServiceHelper

  • JobService

  • LoggingService

  • LSM

  • PublisherService

  • RepositoryService

  • SearchIndexing

  • SearchKeywordProvider

  • SearchMonitor

  • SessionManager

  • ServiceBroker

  • TransformerService

  • UsageService

Special log files:

  • COMPONENT_NAMELoggingBackup.log—Contains logging messages when Logging Service is unavailable (for example, rafservicesLoggingBackup.log)

  • configuration_messages.log—Contains basic environment and configuration information

  • stdout_console_MODULE_NAME.log—Contains messages sent to stdout and stderr

Remote and Local Logging

Some EPM System products use remote logging by communicating with Reporting and Analysis Framework logging service.

In a distributed environment, you can use the remote logging feature to create all logs in one place for all the components running on different machines.

Select one machine in your distributed environment for this purpose, and enable logging service only on this machine. You must disable logging service on all other machines. See the Hyperion Reporting and Analysis Framework Administrator’s Guide.

By default, Reporting and Analysis Framework services and Interactive Reporting services are configured to use remote logging:

When you configure a machine for remote logging, the log files are not created on the local file system but are created on the machine where the logging service is running. You can change this default configuration and choose to log messages locally. Interactive Reporting Log Service uses remote logging by default.

If a component is configured for local logging, then Logging Service is not used by that component.

Changing From Remote to Local Logging

  To change the logging approach from remote to local:

  1. Stop the product.

  2. Open the product ODL configuration file.

  3. Find the required loggers and their corresponding handlers.

  4. Replace the handler class attribute from

    com.brio.one.services.mgmt.logging.RemoteODLHandlerFactory

    to

    com.brio.one.mgmt.logging.LocalODLHandlerFactory

  5. Add the required handler properties:

    • Logs folder location: path

    • Maximum file size: maxFileSize

    • Maximum log size: maxLogSize

  6. Start the product.

Backup Files Used for Remote Logging

If the Logging service fails, logging service log messages are written to backup files at the same location as the log files. Backup file names syntax:

COMPONENT_NAMELoggingBackup.log

When the remote login approach is used, log messages are backed up in EPM_ORACLE_INSTANCE/diagnostics/logs/ReportingAnalysis/rafservicesLoggingBackup.log.

After a failure, when the logging service becomes available, the data from the backup files are transferred to the appropriate log files on the machine where the logging service is running. The backup files are then removed.

Dynamically Changing of Logger Levels

  To dynamically change the logger levels for Reporting and Analysis Framework services:

  1. In EPM Workspace, click Navigate, then Administer, then Reporting and Analysis, and then Services.

  2. Open the Properties dialog box for Reporting and Analysis Framework or the Interactive Reporting services Logs panel.

  3. Add, (for Reporting and Analysis Framework), remove (for custom loggers for Reporting and Analysis Framework), or modify logger levels.

  4. To apply the changes, in the context menu, click Refresh log Configuration. The changes are quickly applied.

  To dynamically change the logger levels for Reporting and Analysis Framework Web application:

  1. Open EPM_ORACLE_INSTANCE/ReportingAnalysis/RAFrameworkWebapp/WEB-INF

  2. Create logging.properties.

  3. Add the required loggers with specific levels. Syntax for loggers: 

    oracle.EPMRAF.[logger name].level=[logger level]

  4. The changes are quickly applied.