Using the Oracle BI Presentation Services Logging Facility Structure for the Oracle BI Presentation Services Configuration File

Diagnosing and Resolving Issues in Oracle Business Intelligence 8-19

8.5.3 Examples of the Formats of Logged Messages

The fmtName attribute of the Writer element formats logged messages in one of three formats: default 10g style, ODL-TEXT, and ODL-XML. The following entries are examples of these formats. Example 8–5 shows the default format. Example 8–5 Default Format The default format generates messages with identifying headings, such as: Type: Information Severity: 30 Time: Wed Jul 26 11:22:20 2006 File: project\sawserver\sawserver.cpp Line: 399 Properties: ThreadID-2552 Location: saw.sawserver saw.sawserver.initializesawserver saw.sawserver Oracle BI Presentation Services has started successfully. Example 8–6 shows the ODL-TEXT format. Example 8–6 ODL-TEXT Format The short format generates messages in a shortened form without identifying headings, such as: [timestamp] [component id] [messagetype:level] [message-id] [module id] [field-name: field-value] message-text [[ supplemental-detail ]] [2010-05-27T10:51:20.000-07:00] [OBIPS] [NOTIFICATION:1] [] [saw.sawserver] [ecid: 1243446680218334471555761] [tid: 2552] Oracle BI Presentation Services OBIPS FilterRecord warning Contains an integer that specifies the severity of the corresponding message type. Only messages with a severity index less than the provided number are logged. FilterRecord error Contains an integer that specifies the severity of the corresponding message type. Only messages with a severity index less than the provided number are logged. FilterRecord trace Contains an integer that specifies the severity of the corresponding message type. Only messages with a severity index less than the provided number are logged. FilterRecord incident_error Contains an integer that specifies the severity of the corresponding message type. Only messages with a severity index less than the provided number are logged. Table 8–3 Cont. Oracle BI Presentation Services Log Configuration File Elements Element Attribute Description 8-20 System Administrators Guide for Oracle Business Intelligence Enterprise Edition 11.1.1.2 Build 0 are starting up.[[ File:sawserver.cpp Line:432 Location: saw.sawserver saw.sawserver.initializesawserver saw.sawserver ecid: 1243446680218334471555761 ]] Example 8–7 shows the ODL-XML format. Example 8–7 ODL-XML Format The xml format generates messages in XML format, such as: msg time=2010-05-08T18:41:05.000+00:00 comp_id=OBIPS type=NOTIFICATION level=1 msg_id= module=saw.sawserver ecid=124180446517874242628761 tid=127c txt Oracle BI Presentation Services has started successfullytxt suppl_detail msg

8.5.4 Oracle BI Presentation Services Message Structure

Each message that is logged by Presentation Services has several components, as described in Table 8–4 .

8.5.5 Oracle BI Presentation Services Log Filters

FilterRecords customize logging details. Use FilterRecords to specify the implementation output type and logging levels for categories of Web logs: Incident Error, Error, Trace, Warnings, and Information. In the following example, the first two FilterRecords contain the following string: path=saw This string logs the informational events at level 1, the error messages at level 31, and so on: FilterRecord writerClassGroup=Console path=saw information=1 warning=31 error=31 trace=0 incident_error=32 Table 8–4 Components of Presentation Services Log Message Message Component Description Message Text The text of the log message to the user. Message Type One of five types: information, warning, error, incident_error or trace. For information, see Table 8–1 . Severity The severity is represented as a positive integer. The lower the value, the more important the message. A message with severity of 0 is the most important type of message, whereas a message with a severity of 32 is not important at all. Message Properties Properties indicate other kinds of information. The kind varies among messages and might include user name, the IP address of the client browser, the thread ID, and so on. Diagnosing and Resolving Issues in Oracle Business Intelligence 8-21 FilterRecord writerClassGroup=File path=saw information=1 warning=31 error=31 trace=0 incident_error=32 FilterRecord writerClassGroup=File path=saw.mktgsqlsubsystem.joblog information=1 warning=2 error=31 trace=0 incident_error=32 This high-level path applies to every event. You can customize FilterRecords by adding new FilterRecords, such as the third one shown in the preceding example, with finer-grain specification of log levels for events of various types. In this example, information is being logged to a disk file from saw.mktgsqlsubsystem.log, which generates Marketing job events. You can disable logging of job details by changing the information level from 1 to 0, as shown in the following example, or by commenting out the lines: FilterRecord writerClassGroup=Console path=saw information=1 warning=31 error=31 trace=0 incident_error=32 FilterRecord writerClassGroup=File path=saw information=1 warning=31 error=31 trace=0 incident_error=32 FilterRecord writerClassGroup=File path=saw.mktgsqlsubsystem.joblog information=1 warning=2 error=31 trace=0 incident_error=32

8.5.6 Diagnosing Issues with Agents

If an agent fails to execute fully or if debugging is turned on in Oracle BI Scheduler, then a log file is generated for the agent. You manually turn on debugging by setting the Debug element to True in the Oracle BI Scheduler instanceconfig.xml file. For information, see Section 8.3.2, What Are Diagnostic Log Configuration Files and Where Are They Located? The location for agent log files is specified in the instanceconfig.xml file for the Oracle BI Scheduler. For information, see Section 19.3.3.3, Agent Scheduler Configuration Settings. The default location for log files is the Log directory in the Oracle Business Intelligence installation directory on the computer where the Oracle BI Scheduler is installed. The log file name has the following format: Agent-JobID-InstanceID.xxx In this file name: ■ Agent is the prefix for all agent log files. ■ JobID is the Oracle BI Scheduler job identifier for the agent. ■ InstanceID is the Oracle BI Scheduler instance identifier for the agent. ■ xxx is the file extension: – .err for agent error log files. – .log for debug log files. The agent error and debug log files are written as separate files for each agent instance that fails to execute. You can use a text editor to view the files. Entries are generally self-explanatory. The presence of an error log does not necessarily mean that an agent failed completely. For example, suppose an agent delivers content to multiple e-mail addresses. If some addresses are invalid or the mail server is down, then an error log is generated for the agent. 8-22 System Administrators Guide for Oracle Business Intelligence Enterprise Edition You can also view error messages and exit codes for job instances in Job Manager. For information, see Instance Properties in Job Manager in Oracle Fusion Middleware Scheduling Jobs Guide for Oracle Business Intelligence Enterprise Edition. Exit status shows the number of deliveries successfully completed. 9 Managing Usage Tracking 9-1 9 Managing Usage Tracking The Oracle BI Server supports the collection of usage tracking data. When usage tracking is enabled, the Oracle BI Server collects usage tracking data for each query and writes statistics to a usage tracking log file or inserts them directly to a database table. It is strongly recommended that you use direct insertion instead of writing to a log file. If you are upgrading from previous versions of Usage Tracking, then see the usage tracking topics in Oracle Fusion Middleware Installation Guide for Oracle Business Intelligence. This chapter includes the following topics: ■ Section 9.1, Setting Up Usage Tracking ■ Section 9.2, Description of the Usage Tracking Data

9.1 Setting Up Usage Tracking

The Oracle BI Server supports the accumulation of usage tracking statistics that can be used in a variety of ways such as database optimization, aggregation strategies, or billing users or departments based on the resources that they consume. The BI Server tracks usage at the detailed query level. When you enable usage tracking, statistics for every query are inserted into a database table or are written to a usage tracking log file. If you use direct insertion, then the BI Server directly inserts the usage tracking data into a relational database table. It is recommended that you use direct insertion to write statistics to a database table. When the BI Server starts, it validates the column names in the metadata against the list of valid columns in the usage tracking table. The following events occur: ■ Column names. If there is a mismatch between the columns in the database table and the columns in the metadata, then it results in a database error on insert. ■ Varchar length. If the length in the metadata and the set length in the table do not match, then an error is written to the nqserver.log file and usage tracking is disabled. Note: A sample usage tracking implementation is provided with the Oracle Business Intelligence installation at: ORACLE_ INSTANCE\bifoundation\OracleBIServerComponent\coreapplicatio n_obisn\sample\usagetracking