IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

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.

You can select one or more of the following destinations, by using the mqsichangeflowstats command: If no format is specified, accounting and statistics data is sent to the user trace log by default. For more information about specifying an output format, see mqsichangeflowstats command.

If you start the collection of message flow statistics data by using the IBM® Integration Explorer, the statistics are emitted in XML format in addition to any other formats that are being emitted. If you start the collection of message flow statistics data by using the web user interface, the statistics are emitted in JSON format in addition to any other formats that are already being emitted. As a result, if statistics collection is started through both the IBM Integration Explorer and the web user interface, data is emitted in both XML and JSON formats. If the output format was previously not specified and therefore defaulted to the user trace, the newly specified format replaces the default, and the data is no longer emitted to the user trace. However, if user trace has been explicitly specified, any additional formats that are selected subsequently are emitted in addition to the user trace.

If you use the mqsichangeflowstats command to explicitly specify the required output formats, the formats specified by the command replace the formats that are currently being emitted for the message flow (they are not added to them).

If you stop statistics collection from either the web user interface or the IBM Integration 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 IBM Integration 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:

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. If one or more output formats are subsequently specified, the specified formats replace the default, and the data is no longer emitted to the user trace. However, if user trace has been explicitly specified, any additional formats that are selected subsequently are emitted in addition to the user trace.

The data is written to one of the following locations:

Windows platformWindows
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:C:\ProgramData\IBM\MQSI\Common\log.
Linux platformUNIX platformLinux and UNIX
/var/mqsi/common/log
z/OS platformz/OS®
/component_filesystem/log

JSON publication

You can specify that the data that is collected is published in JSON format, which is available for viewing in the web user interface. If statistics collection is started through the web user interface, statistics data is emitted in JSON format in addition to any other formats that are already being emitted.

The topic on which the data is published has the following structure:
$SYS/Broker/brokerName/Statistics/JSON/SnapShot/integrationServerName/applications/applicationName
/libraries/libraryName/messageflows/messageFlowName
The variables correspond to the following values:
brokerName
The name of the broker for which statistics are collected
integrationServerName
The name of the integration server for which statistics are collected
applicationName
The name of the application for which statistics are collected
libraryName
The name of the library for which statistics are collected
messageFlowName
The name of the message flow for which statistics are collected

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. If statistics collection is started through the IBM Integration Explorer, statistics data is emitted in XML format in addition to any other formats that are already being emitted.

The topic on which the data is published has the following structure:

$SYS/Broker/brokerName/StatisticsAccounting/recordType/integrationServerLabel/messageFlowLabel
The variables correspond to the following values:
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.
integrationServerLabel
The name of the integration server 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.

The following examples show the topic with which a subscriber registers to receive different sorts of data:
  • 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 integration server 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 integration server 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.


ac19106_.htm | Last updated Friday, 21 July 2017