See information about the latest product version
Output formats for message flow accounting and statistics data
When you collect message flow statistics, you can choose the output destination for the data.
If you stop statistics collection from either the web user interface or the WebSphere® Message Broker Explorer, all output formats are turned off. If statistics collection is subsequently restarted by using the mqsichangeflowstats command, the output format is reset to the default value of user trace, unless other formats are specified on the command. However, if statistics collection is restarted by using the WebSphere Message Broker Explorer, the data is collected in XML format; if statistics collection is restarted through the web user interface, data is collected in JSON format.
Statistics data is written to the specified output location in the following circumstances:
- When the archive data interval expires.
- When the snapshot interval expires.
- When the broker shuts down. Any data that has been collected by the broker, but has not yet been written to the specified output destination, is written during shutdown. It might therefore represent data for an incomplete interval.
- When any part of the broker configuration is redeployed. Redeployed configuration data might contain an updated configuration that is not consistent with the existing record structure (for example, a message flow might include an additional node, or an execution group might include a new message flow). Therefore the current data, which might represent an incomplete interval, is written to the output destination. Data collection continues for the redeployed configuration until you change data collection parameters or stop data collection.
- When data collection parameters are modified. If you update the parameters that you have set for data collection, all data that is collected for the message flow (or message flows) is written to the output destination to retain data integrity. Statistics collection is restarted according to the new parameters.
- When an error occurs that terminates data collection. You must restart data collection yourself in this case.
User trace
You can specify that the data that is collected is written to the user trace log. The data is written even when trace is switched off.
If no output destination is specified for accounting and statistics, the default is the user trace log.
The data is written to one of the following locations:
Windows
- If you set the work path by using the -w parameter of the mqsicreatebroker command, the location is workpath\common\log.
- If you have not specified the broker work path, the
location is:
- On Windows:%ALLUSERSPROFILE%\Application
Data\IBM\MQSI\common\log, where %ALLUSERSPROFILE% is
the environment variable that defines the system working directory.
The default directory depends on the operating system.
- On Windows XP and Windows Server 2003: C:\Documents and Settings\All Users\IBM\MQSI\common\log
- On Windows Vista, Windows 7, and Windows Server 2008: C:\ProgramData\IBM\MQSI\common\log
- On Windows:%ALLUSERSPROFILE%\Application
Data\IBM\MQSI\common\log, where %ALLUSERSPROFILE% is
the environment variable that defines the system working directory.
The default directory depends on the operating system.
Linux and UNIX
- /var/mqsi/common/log
z/OS®
- /component_filesystem/log
XML publication
You can specify that the data that is collected is published in XML format and is available to subscribers registered in the broker network that subscribe to the correct topic.
The topic on which the data is published has the following structure:
$SYS/Broker/brokerName/StatisticsAccounting/recordType/executionGroupLabel/messageFlowLabel
- brokerName
- The name of the broker for which statistics are collected.
- recordType
- Set to SnapShot or Archive, depending on the type of data to which you are subscribing. Alternatively, use # to register for both snapshot and archive data if it is being produced. This value is case sensitive and must be entered as SnapShot.
- executionGroupLabel
- The name of the execution group for which statistics are collected.
- messageFlowLabel
- The label on the message flow for which statistics are collected.
Subscribers can include filter expressions to limit the publications that they receive. For example, they can choose to see only snapshot data, or to see data that is collected for a single broker. Subscribers can specify wild cards (+ and #) to receive publications that refer to multiple resources.
- Register the following topic for the subscriber to receive data
for all message flows running on BrokerA:
$SYS/Broker/BrokerA/StatisticsAccounting/#
- Register the following topic for the subscriber to receive only
archive statistics that relate to a message flow Flow1 running
on execution group Execution on broker BrokerA:
$SYS/Broker/BrokerA/StatisticsAccounting/Archive/Execution/Flow1
- Register the following topic for the subscriber to
receive both snapshot and archive data for message flow Flow1 running
on execution group Execution on broker BrokerA
$SYS/Broker/BrokerA/StatisticsAccounting/+/Execution/Flow1
For help with registering your subscriber, see Message display, test and performance utilities SupportPac (IH03).
SMF
On z/OS, you can specify that the data collected is written to SMF. Accounting and statistics data uses SMF type 117 records. SMF supports the collection of data from multiple subsystems, and you might therefore be able to synchronize the information that is recorded from different sources.
To interpret the information that is recorded, use any utility program that processes SMF records.