KB14511: How to collect logging data to troubleshoot issues with the MicroStrategy Intelligence Server Universal Java components

In some cases, after an apparently successful installation of Strategy Intelligence Server Universal in a supported UNIX environment, the Strategy Java interfaces located in the bin/directory may fail to launch or exhibit other unexpected behavior during operation.
 
One common error that may be encountered is a Java Null Pointer Exception, which will be followed by a lengthy call stack as illustrated in brief below:
 
java.lang.NullPointerException at com.Strategy.workbench.serverconfiguration.
LDAPGUISettings.GetDefaultValue(LDAPGUISettings.java:507)
at com.Strategy.workbench.serverconfiguration.
LDAPGUISettings.DisplayAttributeForLogin(LDAPGUISettings.java:524)
(continued)
The exact call stack may vary in these cases.
 
To troubleshoot such issues, it is necessary to log information from the Java Runtime Environment. This may be done by installing a custom logger.properties file and ensuring that the startup script for the Java component exhibiting the problematic behavior will use the custom file.
 

1. Copy and paste the following text into a text editor on the UNIX machine.
   level=SEVERE
   
   com.Strategy.webapi.Log.level=FINEST
   com.Strategy.webapi.Log.handlers=fileH2
   com.Strategy.webapi.Log.fileH2.level=ALL
   com.Strategy.webapi.Log.fileH2.class=com.Strategy.utils.log.DatedFileHandler
   com.Strategy.webapi.Log.fileH2.formatter=com.Strategy.utils.log.ExtendedFormatter
   com.Strategy.webapi.Log.fileH2.pattern=/XMLAPILog%systemdate%.log
   
   com.Strategy.web.objects.admin.serverconfig.Log.level=FINEST
   com.Strategy.web.objects.admin.serverconfig.Log.handlers=fileH2
   com.Strategy.web.objects.admin.serverconfig.Log.fileH2.level=ALL
   com.Strategy.web.objects.admin.serverconfig.Log.fileH2.class=com.Strategy.utils.log.DatedFileHandler
   com.Strategy.web.objects.admin.serverconfig.Log.fileH2.formatter=com.Strategy.utils.log.ExtendedFormatter
   com.Strategy.web.objects.admin.serverconfig.Log.fileH2.pattern=/SCAPILog%systemdate%.log
   
   com.Strategy.web.objects.Log.level=FINEST
   com.Strategy.web.objects.Log.handlers=fileH2
   com.Strategy.web.objects.Log.fileH2.level=ALL
   com.Strategy.web.objects.Log.fileH2.class=com.Strategy.utils.log.DatedFileHandler
   com.Strategy.web.objects.Log.fileH2.formatter=com.Strategy.utils.log.ExtendedFormatter
   com.Strategy.web.objects.Log.fileH2.pattern=/ObjectsLog%systemdate%.log
   
2. There are three 'pattern' properties specified in this file. For each, a complete path to the Strategy home directory should be substituted where indicated.
   For example, the last line in the first section reads as follows.
    
   com.Strategy.webapi.Log.fileH2.pattern=/XMLAPILog%systemdate%.log
   
3. If Strategy Intelligence Server Universal was installed into the home directory /var/opt/mstr, then this line and the others like it should be modified to read:
    
   com.Strategy.webapi.Log.fileH2.pattern=/var/opt/mstr/XMLAPILog%systemdate%.log
   
4. Repeat for the other two log file patterns.
    
   
5. Save this file with the name logger.properties into the Strategy home directory (/var/opt/mstr/logger.properties in this example).
6. Navigate to the Strategy bin/ directory.
7. Locate the script for the component that is to be launched. For each component, two files will appear in the directory: a symbolic link with the name of the component and the script file itself with the version number as a suffix. Look for the file with the version number.
   Commonly used components are:
    
   
• mstrcontrolcenter
• mstrtestodbc
• mstrcfgwiz
• mstrdiag
• mstrsvcmgr
8. Make a backup of the script in another location.
9. Open the script in a text editor. The last line contains the command to launch the Java runtime environment and initiate the Strategy interface. To this line, add the Strategy home directory as illustrated:
   Before:
    
   exec java -classpath "${MSTR_CLASS_PATH:?}" com.Strategy.workbench.framework.Framework "$@"
   
10. After:
     
    exec java -classpath "${MSTR_CLASS_PATH:?}:/var/opt/mstr" com.Strategy.workbench.framework.Framework "$@"
    
11. Be sure to substitute the complete path for the actual environment. This is necessary for the Java runtime environment to locate the logger.properties file.
     
    
12. Launch the desired Strategy component. The log files should then be created in the Strategy home directory.

To disable Java logging, replace the modified script with its backup.
 
WARNING:
Manually executing or editing portions of Strategy shell scripts incorrectly may cause serious, system-wide problems that may make your Intelligence Server installation unusable. Since these are user-initiated changes, they are not covered by any Strategy warranty. Users are strongly encouraged to back up scripts prior to any alteration.