MicroStrategy ONE

Monitoring Result Caches

You use the Cache Monitor in Developer to monitor result caches. When result caching is enabled and a user executes a report or document, a cache entry is listed in the Cache Monitor.

You can also use the Diagnostics Configuration Tool for diagnostic tracing of result caches (see Diagnostics and Performance Logging Tool), and Command Manager to automatically update information about result caches (see Command Manager).

A cache's hit count is the number of times the cache is used. When a report is executed (which creates a job) and the results of that report are retrieved from a cache instead of from the data warehouse, Intelligence Server increments the cache's hit count. This can happen when a user runs a report or when the report is run on a schedule for the user. This does not include the case of a user retrieving a report from the History List (which does not create a job). Even if that report is cached, it does not increase its hit count.

To View All Report or Document Caches for a Project in the Cache Monitor

  1. In Developer, log in to a project source. You must log in as a user with the Monitor Caches privilege.
  2. Expand Administration, then expand System Monitors, then expand Caches, and then select Reports or Documents.
  3. Select the project for which you want to view the caches and click OK.
  4. To view additional details about a cache, double-click that cache.
  5. To view additional details about all caches, from the View menu select Details.
  6. To change the columns shown in the Details view, right-click in the Cache Monitor and select View Options. Select the columns you want to see and click OK.
  7. To view caches from a different project, right-click in the Cache Monitor and select Filter.
  8. Select the project for which you want to view caches and click OK.
  9. To display History and XML caches in the Report Cache Monitor, right-click in the Cache Monitor and select Filter. Select Show caches for History List messages or Show XML caches and click OK.

You can perform any of the following options after you select one or more caches and right-click:

  • Delete: Removes the cache from both memory and disk
  • Invalidate: Marks the cache as unusable, but leaves a reference to it in users' History Lists (if any)
  • Load from disk: Loads into memory a cache that was previously unloaded to disk
  • Unload to disk: Removes the cache from memory and stores it on disk

For detailed information about these actions, see Managing Result Caches.

Cache Statuses

A result cache's status is displayed in the Report Cache Monitor using one or more of the following letters:

Status

Stands for

Description

R

  

The cache is valid and ready to be used.

P

  

The cache is currently being updated.

I

  

The cache has been invalidated, either manually or by a change to one of the objects used in the cache. It is no longer used, and will be deleted by Intelligence Server. For information about invalid caches, see Managing Result Caches.

E

  

The cache has been invalidated because its lifetime has elapsed. For information about expired caches, see Managing Result Caches.

L

  

The cache is loaded into Intelligence Server memory.

U

  

The cache file has been updated.

D

  

The cache has been updated in Intelligence Server memory since the last time it was saved to disk.

F

  

The cache has been unloaded, and exists as a file on disk instead of in Intelligence Server memory. For information about loading and unloading caches, see Managing Result Caches.

Cache Types

Result caches can be of the following types:

Type

Description

Matching

The cache is valid and available for use.

All document caches are Matching caches.

History

The cache referenced in at least one History List message.

Matching-History

The cache is valid and available for use, and also referenced in at least one History List message.

XML

(Web only) The cache exists as an XML file and is referenced by the matching cache. When the corresponding Matching cache is deleted, the XML cache is deleted.

For more information about each type of cache, see Types of Result Caches.

Diagnostics and Performance Logging Tool

The Intelligence Server logs are often useful when troubleshooting issues with report caching in a MicroStrategy system. You can view these logs and configure what information is logged using the Diagnostics and Performance Logging Tool. For more information, see Configure What is Logged.

To Enable Diagnostic Tracing of Result Caches

  1. Open the MicroStrategy Diagnostics and Performance Logging Tool. (From the Windows Start menu, point to All Programs, then MicroStrategy Tools, and then select Diagnostics Configuration.)
  2. In the Select Configuration drop-down list, select CastorServer Instance.
  3. Clear the Use Machine Default Diagnostics Configuration check box.
  4. In the Report Server component, in the Cache Trace dispatcher, click the File Log (currently set to <None>) and select <New>.
  5. Enter the following information in the editor:
    • Select Log Destination: <New>
    • File Name: cacheTrace
    • Max File Size: 5000
    • File Type: Diagnostics
  6. Click Save, and then click Close.
  7. In the Report Server component, in the Cache Trace dispatcher, click the File Log (currently set to <None>) and select cacheTrace.

Command Manager

You can also use the following Command Manager scripts to monitor result caches:

  • LIST [ALL] REPORT CACHES [FOR PROJECT "<project_name>"] lists all report caches on Intelligence Server for a project.
  • LIST [ALL] PROPERTIES FOR REPORT CACHE "<cache_name>" IN PROJECT "<project_name>" lists information about a report cache.

By default, these scripts are at C:\Program Files (x86)\MicroStrategy\Command Manager\Outlines\Cache_Outlines.

For more information about Command Manager, see Automating Administrative Tasks with Command Manager, or the Command Manager Help (from within Command Manager, press F1).