Logging and Diagnostics for InterSystems Business Intelligence

In addition to the Business Intelligence Logs, Business Intelligence offers a variety of other tools for monitoring and troubleshooting your deployment. This page provides details about these tools.

Review a Table of Cube Build and Synchronization Events

Business Intelligence logs information related to build and synchronization operations for all cubes (both registered and unregistered) as records within the Cube Event table, which you can query via SQL. The table name is %DeepSee_CubeManager.CubeEvent. The CubeEvent field indicates the type of cube event. Possible logical values for this field include the following:

CubeEvent Value	When the Cube Manager Writes This Log Entry
register	Immediately after registering a cube group.
update	Immediately after saving changes to a cube group.
unregister	Immediately after unregistering a cube group.
build	When building a cube. The Cube Manager generates an initial log just before starting the build, and then updates that entry after the build is complete.
synch	When synchronizing a cube. The Cube Manager generates an initial log just before starting the synchronization is started, and then updates that entry after the synchronization is complete.
presynch	Immediately after executing any code specified by the Pre-Synchronize Code option.
postsynch	Immediately after executing any code specified by the Post-Synchronize Code option.
postbuild	Immediately after executing any code specified by the Post-Build Code option.
repair	When you use the Build Dependency List option (which performs an on-demand build of a given cube and any related cubes). The Cube Manager generates an initial log just before starting the build, and then updates that entry after the build is complete.

For information on other fields in this table, see the class reference for %DeepSee.CubeManager.CubeEventOpens in a new tab.

Generate a Diagnostic Report with DeepSeeButtons

DeepSeeButtons is a tool used to generate diagnostic reports about your Business Intelligence environment. You can use this tool while implementing Business Intelligence or later.

The HTML-formatted report provides information on the following aspects of your system:

Setup parameters
Server details
A list of cubes and their properties
For each cube, a list of dimensions and their properties
For each cube, a list of other elements such as pivot variables, named sets, and listing fields
Business Intelligence Logs
The content of the iris.cpf file
The content of the messages.log file

In order to generate this report, you may launch the DeepSeeButtons tool from the terminal by ensuring you are in the %SYS namespace and execute the following code:

Do ^DeepSeeButtons

Follow the subsequent prompts to generate the report. InterSystems recommends that you view the generated HTML in Chrome or Firefox.

Evaluate the Performance of an MDX Query

To evaluate the performance of an MDX query, the %DeepSee.Diagnostic.MDXUtilsOpens in a new tab class provides the %Run() method. Given an MDX query and a target directory for output, this method provides a variety of information about the performance of a query, both before and after caching. For further details, refer to the class reference for %Run()Opens in a new tab.

Review the Activity of Business Intelligence Processes

The %DeepSee.Diagnostic.MonitorOpens in a new tab class provides methods to review the current activity of Business Intelligence processes. In particular, %PrintActivity() allows you to write AppFrameInfo entries for active BI processes to the current output device, and %ExportActivityToFile() allows you to write these entries to a file. For further details, refer to the class reference.

Other Export/Import Options for Business Intelligence

Using the MDX Performance Utility