KB11199: Useful diagnostic tracing for troubleshooting issues with the report cache and history list features in MicroStrategy Intelligence Server

Introduction
When troubleshooting issues with the report caching and the history list features, diagnostic tracing can provide useful information. This document describes diagnostic tracing options commonly used to troubleshoot these issues.
 
Diagnostic tracing for report caches
The creation and deletion of report caches can be traced using Report Server / Cache Trace:
 
When a new report cache is created, entries similar to the following will be logged:
 

Cache Pool Table: Cache with ID 49F4B67044B06776288612B4CA063D55 is added to bucket 17
Cache Lookup Table: Cache with ID 49F4B67044B06776288612B4CA063D55 is added to bucket 4
Cache Create/Update. Report Revenue Forecast 2003, Cache 49F4B67044B06776288612B4CA063D55

 
When a report cache is backed up to disk, entries similar to the following will be logged:
 

CDSSCachedReport::hSaveToFile starts writing into file D:\MicroStrategy\Intelligence Server\Caches\ServerSRVR1_PD8A682024AE33B375801CBB5C8602A8A\Cache49F4B67044B06776288612B4CA063D55.che
CDSSCachedReport::hSaveToFile completes writing into file D:\MicroStrategy\Intelligence Server\Caches\ServerSRVR1_PD8A682024AE33B375801CBB5C8602A8A\Cache49F4B67044B06776288612B4CA063D55.che
CDSSCachedReport::hSaveToFile starts writing into file D:\MicroStrategy\Intelligence Server\Caches\ServerSRVR1_PD8A682024AE33B375801CBB5C8602A8A\Cache49F4B67044B06776288612B4CA063D55_Info.che
CDSSCachedReport::hSaveToFile completes writing into file D:\MicroStrategy\Intelligence Server\Caches\ServerSRVR1_PD8A682024AE33B375801CBB5C8602A8A\Cache49F4B67044B06776288612B4CA063D55_Info.che

 
When a report cache is hit, entries similar to the following will be logged:
 

Cache Hit. Report Revenue Forecast 2003, Cache 49F4B67044B06776288612B4CA063D55.
 Found in cache: ReportInstance(Job=150 Name="Revenue Forecast 2003" ExecFlags=0x200001c0(OSrcCch UptOSrcCch RunSync LclOly ) ExecActn=0x200001c0(RslvCB OSrcCch ) )

 
When a report cache is loaded into memory, an entry similar to the following will be logged:
 

Cache Load. Report Revenue Forecast 2003, Cache 49F4B67044B06776288612B4CA063D55.

 
When a report cache is unloaded from memory, an entry similar to the following will be logged:
 

Cache Unload. Report Revenue Forecast 2003, Cache 49F4B67044B06776288612B4CA063D55.

 
When a report cache is invalidated, an entry similar to the following will be logged:
 

Cache ID = 49F4B67044B06776288612B4CA063D55, Name = Revenue Forecast 2003 is invalidated

 
When a report cache is deleted, entries similar to the following will be logged:
 

Cache Delete. Report Revenue Forecast 2003, Cache 49F4B67044B06776288612B4CA063D55.
 Cache Pool Table: Cache with ID 49F4B67044B06776288612B4CA063D55 is removed from bucket 17
 Cache Lookup Table: Cache with ID 49F4B67044B06776288612B4CA063D55 is removed from bucket 4

 
Diagnostic tracing for history lists
The creation and deletion of history list messages can be traced using Kernel / User Trace:
 
When a new history list message is created, entries similar to the following will be logged:
 

MsiUserInBox::AddMsg(): msg 31493E844EB6C6FE0A70729ED794FDE5 is added into inbox
 CDSSServerMessage::AddInBoxRefCount: AddInBoxRefCount to result cache 49F4B67044B06776288612B4CA063D55 for msg 31493E844EB6C6FE0A70729ED794FDE5
 CDSSServerMessage::AddInBoxRefCount: msg 31493E844EB6C6FE0A70729ED794FDE5 now references to result cache 49F4B67044B06776288612B4CA063D55

 
Note: The report cache that the history list message references is also logged. The referenced report cache ID can be cross-referenced in the Report Server/Cache Trace log.
 
When a history list message is deleted, an entry similar to the following will be logged:
 

CDSSServerMessage::DropResultID(): release result cache 49F4B67044B06776288612B4CA063D55 for msg 31493E844EB6C6FE0A70729ED794FDE5

 
When a user logs in and the user's history list messages are loaded into memory, entries similar to the following will be logged:
 

MsiUserInBox::AddMsg(): msg 0130840F4B185AA66D9759A8A19D1ACC is added into inbox
MsiUserInBox::AddMsg(): msg 31493E844EB6C6FE0A70729ED794FDE5 is added into inbox
MsiSessionManager::AddUserSession: session 98D5CFED4049F1758EEB45832819321F for user Administrator is added into session table.
MsiSessionManager::LoginUser: Total time to log in user:60 ms.

 
When a user logs out, entries similar to the following will be logged:
 

User Administrator logs out from project 0 in session 98D5CFED4049F1758EEB45832819321F
User Administrator logs out from project -1 in session 98D5CFED4049F1758EEB45832819321F
User Administrator's session 98D5CFED4049F1758EEB45832819321F is removed from session table.