EducationSoftwareStrategy.com
StrategyCommunity

Knowledge Base

Product

Community

Knowledge Base

TopicsBrowse ArticlesDeveloper Zone

Product

Download SoftwareProduct DocumentationSecurity Hub

Education

Tutorial VideosSolution GalleryEducation courses

Community

GuidelinesGrandmastersEvents
x_social-icon_white.svglinkedin_social-icon_white.svg
Strategy logoCommunity

© Strategy Inc. All Rights Reserved.

LegalTerms of UsePrivacy Policy
  1. Home
  2. Topics

KB16605: How to enable/disable performance counter logging for MicroStrategy server instances from the command line using MSTRCTL command in MicroStrategy Intelligence Server


Community Admin

• Strategy


How to enable/disable performance counter logging for MicroStrategy server instances from the command line using MSTRCTL command in MicroStrategy Intelligence Server.

The MSTRCTL utility can be used to enable performance counter logging for Strategy server instances from the command line. This utility is described in the following Strategy Knowledge Base technical note: 
KB10941 (KB5300-75x-0567): What is the MSTRCTL command and how is it used in Strategy Intelligence Server 9.x and 10.x? 
The process for enabling diagnostics logging using the MSTRCTL utility is described in the following Strategy Knowledge Base technical note: 
KB15868 (KB5303-81x-2506): How to modify diagnostics logging for Strategy components from the command line in Windows and Unix/Linux environments 
The following steps will enable logging for the 'RSS(MB)' and 'Size(MB)' performance counters.
 
On the Strategy Intelligence Server 9.x and 10.x machine: 

  1. Run the command 'mstrctl -s IntelligenceServer gsic'. This will output the current diagnostics and performance monitoring configuration in XML format. For the Strategy Intelligence Server 9.x the output of this command will appear as below:
    <?xml version="1.0"?>
    <configuration n="CastorServer">
    <metadata>
    <login>testsa</login>
    <odbc dsn="MYSERV"/>
    <table_prefix></table_prefix>
    <temp_table_prefix></temp_table_prefix>
    </metadata>
    <svrd n="aix"/>
    <tcp_port_number>35000</tcp_port_number>
    <processor_affinity_mask is_supported="1">0</processor_affinity_mask>
    <performance_monitor_enabled>1</performance_monitor_enabled>
    <performance_counters log_destination="DSSPerformanceMonitor" pru="0" frequency="30" persist_perf_counter="0" log_statistics="1" stats_frequency="1">
    <cat n="Memory">
    <performance_counter n="Free paging space(MB)" persist="0" persist_to_stats="0"/>
    <performance_counter n="Free real memory(MB)" persist="0" persist_to_stats="0"/>
    <performance_counter n="Page in(MB)" persist="0" persist_to_stats="0"/>
    <performance_counter n="Page out(MB)" persist="0" persist_to_stats="0"/>
    <performance_counter n="Pinned memory(MB)" persist="0" persist_to_stats="0"/>
    <performance_counter n="Reserved paging space(MB)" persist="0" persist_to_stats="0"/>
    <performance_counter n="Total paging space(MB)" persist="0" persist_to_stats="0"/>
    <performance_counter n="Total real memory(MB)" persist="0" persist_to_stats="0"/>
    <performance_counter n="Total virtual memory(MB)" persist="0" persist_to_stats="0"/>
    <performance_counter n="Used real memory(MB)" persist="0" persist_to_stats="0"/>
    </cat>
    .
    .
    </configuration>
  2. Run the command 'mstrctl -s IntelligenceServer ssic' to set a new configuration for the Strategy Intelligence Server performance configuration. This command will accept XML input specifying the new configuration to be set.
  3. For the Strategy Intelligence Server 9.x the following command is an example of the input that can be used to turn on the logging of the Process - RSS (MB) and Size (MB) performance counters to the statistics database with a 5 minute frequency:
    <configuration n="CastorServer">
    <performance_counters log_destination="DSSPerformanceMonitor" pru="0" frequency="30" persist_perf_counter="0" log_statistics="1" stats_frequency="5">
    <cat n="Process">
    <performance_counter n="RSS(MB)" persist="0" persist_to_stats="1"/>
    <performance_counter n="Size(MB)" persist="0" persist_to_stats="1"/>
    </cat>
    </performance_counters>
    </configuration>
  4. The user needs to key in the 'Ctrl+d' sequence on Unix/Linux and 'Ctrl+Z' in Microsoft Windows platforms to stop input and write changes to the server configuration. The XML tag explanations are:
    configuration n="CastorServer"
    - configure the CastorServer (Intelligence Server default) server instance
     
  5. log_destination="DSSPerformanceMonitor"
    - log counters to a CSV file named DSSPerformanceMonitor{PID} where {PID} is the IntelligenceServer process Id. 
     
  6. pru="0"
    - Do not use Machine Default configuration for logging, if pru="1" the Machine Default configuration is used even if a CastorServer configuration is set 
     
  7. frequency="1"
    - frequency with which the file counters are updated to the log file in seconds  
     
  8. persist_perf_counter="1"
    - needs to be "1" to continue logging after an Intelligence Server restart 
     
  9. log_statistics="1"
    - needs to be "1" to enable performance counter logging to the statistics database
     
  10. stats_frequency="5"
    - frequency with which the performance counters are logged to the statistcs database in minutes 
     
  11. cat n="Process"
    - specify the "Process" performance counter category 
     
  12. performance_counter n="RSS(MB)" persist="1"
    - enable logging of the RSS(MB) performance counter
     
  13. persist_to_stats="1"/
    - enable logging of the specific performance counter to the statistics database
     
  14. NOTE: Valid XML close tags (for example: </configuration>) are required to be entered in the command.
     
  15. Users can confirm changes using 'mstrctl -s IntelligenceServer gsic' command:
    <?xml version="1.0"?>
    <configuration n="CastorServer">
    .
    .
    .
    <performance_counters log_destination="DSSPerformanceMonitor" pru="0" frequency="1" persist_perf_counter="1">
    .
    .
    .
    <cat n="Process">
    <performance_counter n="% CPU time" persist="0"/>
    <performance_counter n="RSS(MB)" persist="1"/>
    <performance_counter n="Size(MB)" persist="1"/>
    </cat>
    .
    .
    .
    </configuration>
  16. Users may need to restart the Strategy Intelligence Server instance to start the logging of the selected counters.

NOTE: MSTRCTL writes modifications to the MSIReg.reg file. A restart is required to force the server to read the new values from MSIReg.reg.
 
Once restarted, the Strategy Intelligence Server should be logging the selected counters to the DSSPerformanceMonitor file.
 
To disable logging, users should follow the same steps above, changing the line for the selected counters from
<performance_counter n=<counter_name> persist="1"/>
To:
<performance_counter n=<counter_name> persist="0"/>
Users must restart the server instance for changes to take affect.
 


Comment

0 comments

Details

Knowledge Article

Published:

May 29, 2017

Last Updated:

May 29, 2017