Instance and message configurations

Instance

Starting from KINGSTAR 4.5, you can select an instance for the Analysis Console by using the KINGSTAR Control Panel.

On the KINGSTAR Control Panel, follow the steps in Instance configuration to create and configure the instances.

Open a KINGSTAR Control Panel, an Instance Selection window pops-up. Select an instance for the Control Panel. The Instance ID appeared on the title bar of the Control Panel should be the one you selected.
Open the Analysis Console by clicking the Analysis Console on the KINGSTAR Control Panel. The instance ID appeared on the Analysis Console's title bar should be the same as the one selected for the Control Panel on Step 2.

Instance selection through config file

For KINGSTAR version prior to 4.5, instance selection has to be done through the config file.

Instance is a parameter in the Create function that links a program to the KINGSTAR Subsystem. It is a KINGSTAR Runtime instance. In addition to using Create to set its value, you can configure it through KINGSTAR Control Panel. If you have Multiple Master Package, you can use KINGSTAR Analysis Console to record each KINGSTAR Runtime instance's log.

To configure the parameter, browse to C:\Program Files\IntervalZero\KINGSTAR\bin\AnalysisConsole\, find the file AnalysisConsole.exe.config, and open it with a text processing program, such as Notepad or Notepad++.

In the config file, find this line of code:

Copy

<add key="KingStarInstance" value="0"/>

To configure the settings of an instance:

Change its value to 1 or another number. The code will look like this:

Copy

<add key="KingStarInstance" value="1"/>

Click Start > KINGSTAR 4.5 Runtime > KINGSTAR Analysis Console.
A KINGSTAR Analysis Console is created for Instance 1. The title bar shows the instance number.

NOTE: Instance 0's title bar doesn't show the instance number.

You can change the value to other number to record the log of specific KINGSTAR Runtime instance, depending on your needs. Remember to change it back when you don't need instances.

Messages

If you want to change the frequency and the number of the messages displayed on the KINGSTAR Analysis Console, you can configure the parameters in the config file of Analysis Console. Each configuration has a comment to describe its use.

In the config file, find these lines of code to change settings for trace messages:

TraceReaderCycleTimeMillisecond: the smaller the value, the more the messages are processed.
TraceSaverCycleTimeMillisecond: the smaller the value, the more the messages are processed.
TraceBufferExpectedSize: the greater the value, the more the messages displayed.

Copy

<!--Set to a smaller value to process more messages per second (more CPU used). Set to 0 for maximum performance but the "refresh" button will not work-->
<add key="TraceReaderCycleTimeMillisecond" value="50"/>
<!--Set to a smaller value to process more messages per second (more CPU used). Set to 0 for maximum performance-->
<add key="TraceSaverCycleTimeMillisecond" value="50"/>

<!--Memory usage: 0.8 KB per entry. 15.6 MB used if the value is 20000-->
<!--Increasing the size (ex: set to 200000) can make the tool process more messages per second-->
<!--The value determines the maximum number of messages displayed on UI when trace logging is stopped-->
<add key="TraceBufferExpectedSize" value="20000"/>

Find these lines of code to change settings for standard messages:

StandardReaderCycleTimeMillisecond: the smaller the value, the more the messages are processed.
StandardSaverCycleTimeMillisecond: the smaller the value, the more the messages are processed.
StandardLogUiBufferExpectedSize: the greater the value, the more the messages displayed.

Copy

<!--Set to a smaller value to process more messages per second (more CPU used). Do not set to 0-->
<add key="StandardReaderCycleTimeMillisecond" value="100"/>
<!--Set to a smaller value to process more messages per second (more CPU used). Do not set to 0-->
<add key="StandardSaverCycleTimeMillisecond" value="100"/>

<!--Memory usage: 0.8 KB per entry. 7.8 MB used if the value is 10000-->
<!--The value determines the maximum number of standard messages displayed on UI-->
<add key="StandardLogUiBufferExpectedSize" value="10000"/>