Diagnostics Configuration Page

The Diagnostics Configuration preferences page is where you specify what MicroStrategy Web information is logged and the text file to which the information is logged.

Accessing the Diagnostics Configuration page

1. Access the MicroStrategy Web Administrator page. (How?)

2. From the pane on the left, select Configuration. The Diagnostic Configuration page opens.

Contents of the Diagnostics Configuration page

You can select from the following logging options within the Diagnostics Configuration page:

• Internal diagnostics setup
• Custom diagnostics setup

Internal Diagnostics Setup

This is the default option and is used to set the type of information to be logged in the log file.

The settings defined here are written to the logger.properties file.

• Level: Select the level at which the information is written in the log file. You can choose from the following levels:

  • OFF: Nothing is written in the log file.

  • Errors: This is the default option. Errors generated by MicroStrategy Web are included in the log file.

  • Warnings: Errors and warnings generated by MicroStrategy Web are included in the log file.

  • Messages: Errors, warnings, and messages generated by MicroStrategy Web are included in the log file.

• Log files directory: This field displays a default path where the log files are saved. You can also specify a different path. The log file is generated in the specified path in the MSTRmmddyyyy.log_num format.

  The naming of the log file is handled by the logger.properties file. For example, the first log file created on 01/02/2008 appears as MSTR01022008.log_1.

• Maximum output file size: The maximum size, in bytes, of the log file. When the maximum file size is reached, a new log file is started.

• Number of file outputs: The maximum number of log files that Web creates.

• Advanced Logger Options: Select from the following options to disable or enable the creation of XML-API logs, as well as configure how and what information is logged.

  • Disabled: This is the default option. When this option is selected, logs are created using only the default settings you specify in the Internal diagnostics setup options. All errors, warnings, or messages are logged to the log file you specified in the Log files directory, but logs are not created for each specific user, date, and package combination.

  • Enable XML-API Logger: When this option is selected, all messages for a particular user for all calls to the API are logged. These messages consist of any classes that are located under the com.microstrategy.webapi package.

    • User name: To specify that the XML-API logger only saves messages for a specified user, enter the user's name in the text field. If you do not specify a user, messages are logged for all users.

    When the Enable XML-API Logger option is selected, you can log only API messages, not messages coming from a specific package or multiple packages. To log information about specific or multiple packages, you must select the Enable logging for multiple/other package(s) option.

  • Enable logging for multiple/other package(s): When this option is selected, you can determine the specific packages for which logs are created. This further refines the logging process because you can more distinctly define which error messages are logged and for which users and packages.

    • Package: To specify certain packages for which to create logs, type the name of the package(s) in the text field. Use a comma to separate the names of multiple packages. For example, you want to log API messages as well as messages for an addons package. In this case, you must list both of these packages by entering the following in the text field: com.microstrategy.webapi, com.microstrategy.web.app.addons

    • User name: To specify that the XML-API logger only saves messages for a specified user, enter the user's name in the text field. If you do not specify a user, messages are logged for all users.

    • Pattern: You can limit the number of logged messages by specifying a pattern. Only messages that match the pattern are logged. For example, you want to log messages that are related only to methods that start with the "getCustomLogin " string. In this case, enter "getCustomLogin* ".

    • Level: You can specify the types of messages that are logged by selecting one of the following options:

      • OFF: This is the default option. Nothing is written in the log file.

      • Errors: Errors are included in the log file.

      • Warnings: Errors and warnings are included in the log file.

      • All: Errors, warnings, and messages are logged.

Custom Diagnostics Setup

This option is typically used to load a logger.properties file provided to you by MicroStrategy Technical Support. The logger.properties file contains the internal diagnostics setup settings above, and is saved by default in the CATALINA_HOME\webapps\MicroStrategy\WEB-INF\logfolder. You can load diagnostics settings contained in the file, get the output, and send it back to Technical Support. When the Technical Support engineer is done, they can reset your log to its original settings. This allows for a very detailed level of logging without you having to write the logger.properties file yourself.

Path to custom diagnostics setup file: Specify the path to the logger.properties file in this field.

Related Topics

How to Determine What and Where Information is Logged