mqsichangeflowstats command

Supported Platforms

Purpose

Use the mqsichangeflowstats command to:
  • Turn on or off accounting and statistics snapshot publication, or archive record output.
  • Specify that the command be applied to a specific flow message flow, or all flows in an execution group, or all execution groups belonging to a broker.
  • Modify the granularity of the data collected in addition to the standard message flow accounting and statistics. This extra data can include thread related data, node related data, node terminal related data, or a mixture of this data.

The options set using this command remain active until modified by a subsequent mqsichangeflowstats command.

Syntax

Windows platforms, Linux, and UNIX systems

z/OS

Synonym cs

Parameters

brokername
(Required -Windows platforms, Linux, and UNIX systems) Specify the label of the broker for which accounting and statistics are to be changed.
-a
(Required) Specify that the command modifies archive accounting and statistics collection.
Note: You must specify either -a or -s. If you do not specify one of these arguments you receive a warning message.
-s
(Required) Specify that the command modifies snapshot accounting and statistics collection.
Note: You must specify either -a or -s. If you do not specify one of these arguments you receive a warning message.
-e ExecutionGroupName
(Required) Specify the name for the execution group, for which accounting and statistics options are to be changed.
Note: You must specify either -e or -g. If you do not specify one of these arguments you receive a warning message.
-f MessageFlow
(Required) Specify the label for the message flow, for which accounting and statistics options are to be changed.
Note: You must specify either -f or -j. If you do not specify one of these arguments you receive a warning message.
-g
(Required) Specifies that the command applies to all execution groups that belong to the broker.
Note: You must specify either -e or -g. If you do not specify one of these arguments you receive a warning message.
-j
(Required) Specifies that the command applies to all message flows that belong to the execution group.
Note:
  1. You must specify either -f or -j. If you do not specify one of these arguments you receive a warning message.
  2. If you set the -g option for all execution groups, you must use -j instead of -f.
-c control
(Optional) Specify the string value that controls the level of the action to be applied to accounting and statistics collection for snapshot or archiving. Possible values are:
  • active - turn on snapshot or archiving
  • inactive - turn off snapshot or archiving.
-t ThreadData
(Optional) Specify a string value to modify the collection of thread statistics data for a message flow Possible values are:
  • none - exclude thread related data from the statistics
  • basic - include thread related data in the statistics
-n NodeData
(Optional) Specify a string value to modify the collection of node statistics data for a message flow. Possible values are:
  • none - exclude node related data in the statistics
  • basic - include node related statistics in the statistics
  • advanced - include node related and terminal related data in the statistics
-r
(Optional) Specify that a reset of archive data is required.
Note: This action is only valid for archive data.
This results in the clearing out of accounting and statistics data accumulated so far for this interval, and restarts collection from this point. All archive data for all flows in the execution group, or groups, is reset.

The archive interval timer is only reset if the -v option (statistics archive interval) of mqsicreatebroker or mqsichangebroker is non zero. That is , the interval timer is only set if the internal interval notification mechanism is being used , and not an external method for example, ENF on z/OS.

-b AccountingOrigin
This parameter has no effect.
-o OutputFormat
(Optional) Specify the output destination for the statistics reports. Possible values are:
  • usertrace - this is the default and writes "bip" messages to usertrace, which can be post processed in the normal way using the mqsireadlog and mqsiformatlog commands
  • xml - the statistics reports are generated as XML documents and published by the broker running the message flow.
    The topic on which the data is published has the following structure:
    $SYS/Broker/<brokerName>/StatisticsAccounting/<recordType>
    /<executionGroupLabel>/<messageFlowLabel>
    where recordType is set to Snapshot or Archive, and broker, execution group, and message flow names are specified according to the subscriber's requirements.
  • smf - (z/OS only). Statistics reports are output as SMF type 117 records.

Authorization

The user Id used to issue the command must have mqbrkrs authority.

Responses

This command returns the following responses:
  • BIP2226 Request to change attribute in message flow node ' ': message flow does not exist
  • BIP8004 Invalid flags and arguments selected
  • BIP8013 Component does not exist
  • BIP8020 Unable to access the database
  • BIP8029 Broker not configured
  • BIP8033 Unable to send XML message
  • BIP8038 Unsupported command option
  • BIP8039 Execution group not available
  • BIP8040 Unable to connect to database

Examples

Turn on snapshot statistics for the message flow "myFlow1" in all execution groups of BrokerA and specify that the data is to be gathered by accounting origin:
mqsichangeflowstats BrokerA -s -g -j -b none   
Turn off the collection of archive statistics for message flow "MyFlow1" in execution group "EGRP2" for BrokerA, and at the same time modify the granularity of data that is to be collected ( when next activated ) to include thread related data.
 mqsichangeflowstats BrokerA -a -e "EGRP2" -f MyFlow1 -c inactive -t basic   
Turn off snapshot data for all message flows in all execution groups for Broker A.
mqsichangeflowstats BrokerA -s -g -j -c inactive  
Related concepts
Message flows overview