Diagnosing Issues with Agents
9.1.2 Setting Up a Log File to Collect Information for Usage Tracking
Log file collection is an alternate method for configuring usage tracking. Although this feature is supported, it is recommended that you use direct insertion to collect information for usage tracking. See Section 9.1.1, Setting Up Direct Insertion to Collect Information for Usage Tracking for details. The following sections explain how to configure log file collection for usage tracking. Before you configure the log file parameters, you must set the ENABLE parameter in the Usage Tracking section of the NQSConfig.INI file to YES to enable usage tracking. See Appendix A, NQSConfig.INI File Configuration Settings for more information about the usage tracking configuration parameters. This section contains the following topics: ■ Section 9.1.2.1, Selecting an Output Location ■ Section 9.1.2.2, File Naming Conventions ■ Section 9.1.2.3, Output File Format ■ Section 9.1.2.4, Performance Considerations9.1.2.1 Selecting an Output Location
The STORAGE_DIRECTORY parameter in the Usage Tracking section of the NQSConfig.INI file determines the location of usage tracking log files. If usage tracking is enabled, but no storage folder is specified, then the files are written in the logs folder in the software installation folder for example, in \OBI11g\logs. 9-4 System Administrators Guide for Oracle Business Intelligence Enterprise Edition Current files are periodically written to disk, and new files are created. The CHECKPOINT_INTERVAL_MINUTES parameter controls the frequency with which usage tracking data is flushed to disk, and the FILE_ROLLOVER_INTERVAL_ MINUTES parameter controls the frequency with which the current usage tracking log file is closed and a new file is created. When usage tracking is enabled, every query is logged to a usage tracking log file. This might require a large amount of available storage. For example, assume an average of 300 bytes of data output for each query and 10 queries per second over an 8 hour day. This results in approximately 83 MB of usage tracking data that is written to storage per day. If this example is extended to a 24 x 7 operation, then the result is approximately .25 GB of storage per day. The BI Server has no limit on the size or quantity of usage tracking log files that can exist in the specified location. You must ensure that sufficient space is available and that you remove or archive old usage tracking files.9.1.2.2 File Naming Conventions
The file naming scheme for the usage tracking log files is NQAcct.yyyymmdd.hhmmss.log, where yyyy is the year, mm is the month, dd is the day, hh is the hour, mm is the minute, and ss is the second of the timestamp when the file was created. For example, if the server creates the usage tracking log file at 07:15:00 a.m. on February 12, 2010, the file name would be NQAcct.20100212.071500.log. After the specified rollover interval, this file is flushed to disk and closed and a new log file, with the current date and timestamp, is created.9.1.2.3 Output File Format
The usage tracking log files are text files, in semicolon-delimited ; format. A semicolon is used as the column delimiter because the logical SQL text contains commas. A line feed delimits the end of each row of data. Although there is no guaranteed unique key for the usage tracking data, a combination of User name, Node ID, Start timestamp, and Query text is usually sufficient. Query_Key can be used as an unique key but Query_Key is available only in direct insert. For information about sample scripts to help you extract data from usage tracking log files and load it to appropriately formatted relational database tables, see Chapter 9, Managing Usage Tracking. See also Section 9.2, Description of the Usage Tracking Data for more information about the contents of each column. Table 9–1 shows the format of the usage tracking output file. Caution: Insufficient storage space might cause you to lose usage tracking data. If the BI Server encounters an error while accessing a usage tracking output file, then it immediately discontinues the collection of usage tracking statistics and issues an error message to the nqserver.log and, on Windows, to the Windows Event log. Even if additional storage space is made available, the collection of usage tracking statistics does not resume until the server is restarted. Table 9–1 Usage Tracking Output File Format Column Number Column Name Data Type Max Data Size Nullable 1 User name Varchar 128 No Managing Usage Tracking 9-5 Table 9–1 describes the schema. The following list contains more detail about Integer data types, Timestamp columns, and the Query Text column: ■ Integers data types. All data in the output file is in character format. The data in columns 12 through 18 are output as text representations of integer numbers. Therefore, they behave more like Varchar10 columns than integers. For example, if the row count is one million rows, then 1000000 appears in the output file in column 13 Row count. This constitutes 7 bytes of data, even though the data represents a 4-byte internal integer value. In column 12, a Success indicator value of 0 signifies a successful query. All nonzero values indicate failure. The following failure indicators are currently defined: – 1 indicates timeout – 2 indicates row limit violation – 3 indicates unknown error 2 Repository name Varchar 128 No 3 Subject area name Varchar 128 No 4 Node ID Varchar 15 No 5 Start timestamp Char Timestamp 19 No 6 Start date Char yyyy-mm-dd 10 No 7 Start hourMin Char hh:mm 5 No 8 End timestamp Char Timestamp 19 No 9 End date Char yyyy-mm-dd 10 No 10 End hourMin Char hh:mm 5 No 11 Query Text Varchar 1024 No 12 Success indicator Integer 4 No 13 Row count Integer 4 Yes 14 Total time secs Integer 4 Yes 15 Compilation time secs Integer 4 Yes 16 Number of database queries Integer 4 Yes 17 Cumulative db time secs Integer 4 Yes 18 Cumulative db rows Integer 4 Yes 19 Cache indicator Char 1 No 20 Query source Varchar 30 No 21 Presentation Catalog path Varchar 250 No 22 Dashboard name Varchar 150 Yes Table 9–1 Cont. Usage Tracking Output File Format Column Number Column Name Data Type Max Data Size NullableParts
» Oracle Fusion Middleware Online Documentation Library
» What Are the Oracle Business Intelligence System Administration Tasks?
» Getting Started with Managing Oracle Business Intelligence
» A Single Host and Enterprise Install
» A Single Host and Simple Install
» Oracle Business Intelligence on Multiple Hosts
» About Java Components About Java Components and System Components for Oracle Business Intelligence
» What Is the Administration Server?
» Fusion Middleware Control What System Administration Tools Manage Oracle Business Intelligence?
» Oracle WebLogic Server Administration Console
» Oracle Process Manager and Notification Server OPMN Tool
» Oracle Weblogic Scripting Tool WLST
» Oracle BI Administration Tool
» Job Manager What System Administration Tools Manage Oracle Business Intelligence?
» Working with the Sample Application
» Oracle BI Publisher Integration
» Topics of Interest in Other Guides
» System Requirements and Certification
» Why Use Fusion Middleware Control and WebLogic Server Administration Console?
» Logging into Fusion Middleware Control to Manage Oracle Business Intelligence
» Using Fusion Middleware Control to Manage Oracle Business Intelligence System Components
» About the Navigation Tree in Fusion Middleware Control
» Configuring Oracle Business Intelligence
» Using Fusion Middleware Control to Update Oracle Business Intelligence Configuration Settings
» Using the Oracle BI Systems Management API to Update Configuration Settings
» Using a Text Editor to Update Configuration Settings
» Where Are Configuration Files Located?
» About Starting and Stopping Oracle Business Intelligence
» Starting Oracle Business Intelligence on Windows Platforms
» Starting Oracle Business Intelligence on UNIX Platforms
» Using Oracle WebLogic Server Administration Console to Start and Stop Java Components
» Using the OPMN Command Line to Start, Stop, Restart, and View the Status of System Components
» Using a Windows Service to Start and Stop System Components
» Confirming Whether the Administration Server Is Running
» Click Start. Oracle Fusion Middleware Online Documentation Library
» Administration Server Fails to Start When the Database Is Not Running
» Oracle BI Server Fails to Start
» Oracle BI Presentation Services Fails to Start
» Cannot Log In Troubleshooting System Startup
» How Do I Know When to Scale Out Processes?
» What Processes Should I Scale?
» Vertically Scaling Oracle Business Intelligence Horizontally Scaling Oracle Business Intelligence
» Uploading and Sharing the Oracle BI Repository
» Using Fusion Middleware Control to Identify Single Points of Failure
» Achieving High Availability Using an Active-Passive Model
» Using Fusion Middleware Control to Configure Primary and Secondary Instances
» Setting Optional Cluster Controller Parameters
» Setting Optional Presentation Services Parameters
» Setting Optional Oracle BI Presentation Services Plug-in Parameters
» Status Information Viewing and Managing Cluster Information
» Cache Information Viewing and Managing Cluster Information
» Select Action, and then select an option.
» Server Information Viewing and Managing Cluster Information
» Using Fusion Middleware Control to View Common Performance Metrics
» Using Fusion Middleware Control to View All Oracle Business Intelligence Metrics
» Using the Administration Console to View Metrics for Java Components
» About Query Performance Tuning
» Using Fusion Middleware Control to Disallow RPD Updates
» Using Fusion Middleware Control to Set the User Session Log-Off Period
» Using Fusion Middleware Control to Set the Maximum Number of Rows Processed to Render a Table
» Query Cache Architecture About the Oracle BI Server Query Cache
» Advantages of Caching About the Oracle BI Server Query Cache
» Administrative Tasks Costs of Caching
» Keeping the Cache Up To Date
» About the Refresh Interval for XML Data Sources
» Using Fusion Middleware Control to Enable and Disable Query Caching
» Using Fusion Middleware Control to Set Query Cache Parameters
» Manually Editing Additional Query Cache Parameters
» Using Fusion Middleware Control to Set Global Cache Parameters
» Manually Editing Additional Global Cache Parameters
» Disable Caching for the System
» In the Physical Table properties dialog, in the General tab, make one of the
» To set a cache expiration time, specify a Cache persistence time and specify a unit
» Click OK. Caching and Cache Persistence Timing for Specified Physical Tables
» Configure Oracle BI Server Event Polling Tables
» Storing and Purging Cache for SAPBW Data Sources
» Online Mode How Repository Changes Affect the Query Cache
» Offline Mode How Repository Changes Affect the Query Cache
» Switching Between Repositories How Repository Changes Affect the Query Cache
» Changes to Dynamic Repository Variables
» Ensuring Correct Cache Results When Using Row-Level Database Security
» Running a Suite of Queries to Populate the Cache
» Using Agents to Seed the Oracle BI Server Cache
» Displaying Global Cache Information in the Cache Manager
» Select Manage, then Cache to open the Cache Manager dialog.
» Select Cache or Physical mode by selecting the appropriate tab in the left pane.
» Select the cache entries to purge, and then select Edit, then Purge to remove them.
» Polling Table Structure Setting Up Event Polling Tables on the Physical Databases
» Sample Event Polling Table CREATE TABLE Statements
» Making the Event Polling Table Active
» Populating the Oracle BI Server Event Polling Table
» Troubleshooting Problems with Event Polling Tables
» Managing the Oracle BI Presentation Services Cache Settings
» Using Fusion Middleware Control to View Log Information, Error Messages, and Alerts
» Click Lock and Edit Configuration to enable changes to be made.
» Click Apply, then click Activate Changes.
» Return to the Business Intelligence Overview page and click Restart.
» Locate the section in which you must add the Format element, which specifies the
» Include the element and its ancestor elements as appropriate, as shown in the
» What Are Diagnostic Log Files and Where Are They Located?
» What Are Diagnostic Log Configuration Files and Where Are They Located?
» What Are Log File Message Categories and Levels?
» What Messages Are Included in the System Log?
» Setting the Query Logging Level
» Double-click the name of the user for which you want to set the query logging
» Set the logging level by clicking the Up or Down arrows next to the Logging Level
» Click OK. Setting the Query Logging Level for a User
» Running the Log Viewer Utility
» Interpreting the Log Records
» Examples of the Formats of Logged Messages
» Oracle BI Presentation Services Message Structure
» Oracle BI Presentation Services Log Filters
» Diagnosing Issues with Agents
» Setting Up Direct Insertion to Collect Information for Usage Tracking
» Selecting an Output Location
» File Naming Conventions Output File Format
» Performance Considerations Setting Up a Log File to Collect Information for Usage Tracking
» Description of the Usage Tracking Data
» Understanding Modes Why Upload a Repository and Set the Catalog Location?
» Understanding Repository Version Numbers
» Using the System MBeans to Upload the Metadata Repository
» Click OK. Configuring E-Mail and Agents
» Using Fusion Middleware Control to Configure the Connection to the Marketing Content Server
» Configuring to Download Oracle Hyperion Smart View for Office
» Using Fusion Middleware Control to Change Presentation Setting Defaults
» What Are the System Requirements for Map Views?
» Associating Layers with Columns
» Changes to Spatial Metadata Require Restart
» Administration Page Functions Administering Maps
» Administering Maps Using Administration Pages
» Hardware Sizing and Deployment Strategy for Maps Why and Where are Time Zones Used?
» Setting Time Zones Oracle Fusion Middleware Online Documentation Library
» Description of Time Zone Settings
» Example: Configuration File Settings for Specifying the Time Zone
» What Components Are Translated?
» Tasks for Localizing Oracle Business Intelligence Components
» Understanding the Directory Structure for Localizing Presentation Services
» Click Languages. Specifying the Default Language for the Sign-In Page
» Use the Move Up and Move Down buttons to position the desired language at the
» Locate the ServerInstance section, in which you must add the following elements:
» Specifying the Language in the URL
» From the Tools menu, select Export Captions.
» Click Browse to select the location in which to write the output file, then click OK.
» To exclude the Description properties from the export, select Exclude
» Click OK. Step 2: Exporting Text Strings in the Catalog
» Step 1: Understanding the Export Process Step 3: Editing Exported Strings in XML Files
» Click OK. Step 4: Handling Duplicate Exported Text Strings
» The export process not only generates new XML files, but the process also
» Sign into Oracle Business Intelligence and select the appropriate language, such as
» Display the translated content.
» Tip for Arabic and Hebrew in Mozilla Firefox Browsers
» Setting the Current Locale in Catalog Manager
» Setting the Locale on UNIX Systems
» Handling the NLS Locale Not Supported Error Message
» Setting the Japanese Locale on AIX Systems
» Localizing Metadata Names in the Repository
» What is Multilingual Data Support?
» What is Lookup? Supporting Multilingual Data
» What is Double Column Support?
» A Lookup Table for Each Base Table
» A Lookup Table for Each Translated Field
» Creating Logical Lookup Tables
» Designating a Logical Table as a Lookup Table About the LOOKUP Function Syntax
» Creating Logical Lookup Columns
» Creating Physical Lookup Tables and Physical Lookup Columns
» Supporting Multilingual Data in Essbase Through Alias Tables Enabling Lexicographical Sorting
» Defining User-Preferred Currency Options Using a Dynamic Mapping
» Example: Dynamic Mapping to Define User-Preferred Currency Options
» Handling Users of the Catalog
» Handling Heterogeneous Nodes File System Guidelines for Catalogs
» Handling Catalog Files on Various Platforms Known Issues with Catalog Files
» Manually Changing Additional Configuration Settings for the Catalog
» Manually Creating a New Oracle BI Presentation Catalog
» Deploying Catalogs to Production
» Performing a Basic Validation of the Catalog
» Locate the Catalog section in which you must add the elements that are described
» Include the elements and their ancestor element as appropriate, as shown in the
» Save your changes and close the file.
» Guidelines for Working with Catalog Manager
» Tips for Working with Catalog Manager
» Starting Catalog Manager Starting Catalog Manager and Opening Catalogs
» Online Mode Understanding the Two Catalog Modes
» Take Presentation Services on each computer in the cluster out of Maintenance
» Operations Available in Online Mode and Offline Mode
» Opening an Oracle BI Presentation Catalog
» What Does the Catalog Manager Workspace Do?
» What Does the Catalog Manager Workspace Look Like?
» Managing the View of the Catalog Manager Workspace
» Searching for Catalog Objects Using Catalog Manager
» In the source catalog, right-click the source object and select Copy.
» Advanced Options for Pasting Objects
» Renaming Catalog Objects Working with the Properties of Catalog Objects
» Setting Permissions of Catalog Objects
» Previewing Objects from Catalog Manager
» What Happens When Tenants are Provisioned?
» What Options are Available for Provisioning?
» Locate the section in which you must add the EnableMultiTenancy element.
» Viewing and Editing Catalog Objects in XML
» Searching for and Replacing a Simple Catalog Text String
» XML File Format for Searching for and Replacing Text Strings
» Example XML File for Searching for and Replacing Text Strings
» Searching for and Replacing Multiple Catalog Text Strings
» Creating Reports to Display Catalog Data Using Catalog Manager
» Archiving a Folder Using Catalog Manager
» Unarchiving a Folder Using Catalog Manager
» What is a Full-Text Catalog Search?
» Deployment of Oracle Full-Text Catalog Search
» How is Security Handled in the Full-Text Catalog Search?
» Click Administration in the global header.
» On the Administration tab, click Manage Privileges.
» Step 2: Ensuring that Secure Enterprise Search is Available
» Display the Identity Management Setup page using steps such as the following:
» Click Finish. Step 3: Configuring Identity Management for Full-Text Catalog Search
» In the Source Type list, select Oracle Fusion, then click Create.
» If you clicked Create and Customize, then on the Documents tab, add the RTF
» Click Apply. Step 4: Creating the Data Source for Full-Text Catalog Search
» Step 5: Editing the Schedule for Full-Text Catalog Search
» Select Global Settings, then Configure Search Result List in the Out-of-Box
» Enable the replication of the Oracle BI Presentation Catalog.
» Perform a full crawl on the catalog.
» Locate the section in which you must add the Replication element.
» Restart Oracle Business Intelligence.
» Step 8: Configuring Properties for Full-Text Catalog Search Manually
» Step 9: Allowing Users to Access the Full-Text Catalog Search
» Replication Log File Records
» Configuring to Replicate an Oracle BI Presentation Catalog
» Copying Oracle BI Presentation Catalog Files
» mark Using the Oracle BI Presentation Services Replication Agent
» remotecopy Using the Oracle BI Presentation Services Replication Agent
» run Using the Oracle BI Presentation Services Replication Agent
» Structure of the Configuration File
» Elements of the Configuration File
» Editing the instanceconfig.xml File for Replication
» Resuming Replication if Replication Log Files Are Unavailable
» Managing Dashboards Oracle Fusion Middleware Online Documentation Library
» Providing Access to Metadata Dictionary Information
» Supporting Nested Folders, Navigation, and Drill-Down
» Manually Configuring Cube Settings for Pivot Tables and Graphs
» Manually Configuring Settings for Data in Views
» Configuring Fonts for Graphs
» Manually Changing Alternating Bar Color
» Manually Changing Presentation Setting Defaults
» Configuring Links to Dashboard Pages
» Configuring an Alternate Toolbar for Oracle BI Publisher
» Modifying the Table of Contents for PDF Versions of Briefing Books
» Storing JavaScript Files Blocking Analyses in Answers
» Blocking Analyses Based on Criteria
» Blocking Analyses Based on Formula
» Validation Helper Functions Blocking Analyses in Answers
» XML Message Files for View Defaults
» Adding a Default Header or Footer to New Analyses Preventing Auto-Previewing of Results
» Setting Defaults for Analyses in the Compound Layout Changing Dashboards Section Defaults
» Specifying Dashboard Page Defaults Including Headers and Footers
» Write-Back Limitations Configuring for Write Back in Analyses and Dashboards
» Locate the ServerInstance section in which you must add the LightWriteback
» Requirements for the Write-Back Template
» Example: Write-Back Template About the Write-Back Template
» How Does Antivirus Software Affect Agents?
» What Privileges Affect Agents?
» Manually Configuring Presentation Services Settings That Affect Agents
» Manually Changing Additional Scheduler Settings That Affect Agents
» General Scheduler Configuration Settings That Affect Agents
» E-Mail Scheduler Configuration Settings That Affect Agents
» Agent Scheduler Configuration Settings
» Controlling Delivery Options for Agents
» Managing Device Types for Agents
» Monitoring Active Agent Sessions
» Configuring MapViewer to Support Map Views
» Manually Configuring for Map Views
» Inserting Text on a Map Configuring Maps for External Consumption
» What Is the Oracle BI Systems Management API?
» Accessing Oracle BI Systems Management API Methods
» Example: Using a Java Program to Display the Status of Oracle Business Intelligence
» Example: Using WLST Commands to Stop and Start Oracle Business Intelligence
» Example: Using WLST to Edit the E-Mail Sender Display Name Configuration Setting
» Example: Using a Java Program to Edit the E-Mail Sender Display Name Configuration Setting
» Example: Using WLST to Scale Out to Servers
» Example: Using a Java Program to Scale Out to Servers
» Using the Dynamic Monitoring Service for Metrics
» Verify that you are in online mode by viewing the following prompt:
» Descriptions of JMX Admin MBeans and Methods for the Oracle BI Systems Management API
» Step 1: Stop System Component Processes for Oracle BI EE
» Step 2: Invoke OPatch with -rollback Option
» Step 3: Start System Component Processes for Oracle BI EE
» Step 4: Redeploy J2EE Applications
Show more