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

mqsichangeflowstats command - Windows, Linux and UNIX systems

Use the mqsichangeflowstats command on Windows, Linux and UNIX systems to control the accumulation of statistics about message flow operation.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-mqsichangeflowstats-- BrokerName --+- -a +------------------->
                                      '- -s '   

                                                        (1)   
>--+- -e -IntegrationServerName--+- -f -MessageFlow-+-+--------->
   |                             '- -j--------------' |       
   '- -g - -j ----------------------------------------'       

>--+-----------------------+--+--------------+------------------>
   '- -b -AccountingOrigin-'  '- -c -Control-'   

>--+----------------------+--+---------------+------------------>
   '- -k -applicationName-'  '- -n -NodeData-'   

>--+-------------------+--+-----+--+-----------------+---------->
   '- -o -OutputFormat-'  '- -r '  '- -t -ThreadData-'   

>--+------------------+----------------------------------------><
   '- -y -libraryName-'   

Notes:
  1. See the parameter descriptions for information on valid combinations of the e, f, g, and j parameters.

Parameters

BrokerName
(Required) 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.

You must specify either -a or -s. If you do not specify one of these arguments you receive a warning message.

-b AccountingOrigin
(Optional) Specifies that the environment tree path Broker.Accounting.Origin is used to partition the collected statistics into distinct outputs. Possible values are:
  • none - do not partition statistics according to accounting origin data
  • basic - partition statistics according to accounting origin data
-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.
-e IntegrationServerName
(Required) Specify the name for the integration server, for which accounting and statistics options are to be changed.

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.

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 integration servers that belong to the broker.

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 integration server.

You must specify either -f or -j. If you do not specify one of these arguments you receive a warning message.

Note: If you set the -g option for all integration servers, you must use -j instead of -f.
-k applicationName
(Optional) This parameter specifies the name of the application that contains the message flow for which statistics are being collected.

When you set this parameter, you must also set either the -f (message flow) parameter, or the -j (all message flows) parameter. To collect statistics for a named message flow in a specific application, set the -k and -f parameters. To collect statistics for all message flows in an application, set the -k and -j parameters.

You can use this parameter with the -y (library name) parameter to specify that the message flow is contained in a library referenced by the application.

-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
-o OutputFormat
(Optional) Specify the output destination for the statistics reports. You can specify multiple output destinations by using comma-separated values. 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
    /integrationServerLabel/messageFlowLabel
    where recordType is set to Snapshot or Archive, and broker, integration server, and message flow names are specified according to the subscriber's requirements.
  • json - the statistics reports are generated in JSON format, which enables the statistical information to be viewed in the web user interface. If statistics collection is turned on in the web user interface, the output format is changed to json. The topic on which the data is published has the following structure:
    $SYS/Broker/<brokerName>/Statistics/JSON/SnapShot/isName/applications/MyApplication
    /libraries/MyLibrary/messageflows/MyFlowName
-r
(Optional) This parameter applies only to archive data and specifies that archive data is to be reset.

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 integration server, 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 set only if the internal interval notification mechanism is being used, and not an external method.

-s
(Required) Specify that the command modifies snapshot accounting and statistics collection.

You must specify either -a or -s. If you do not specify one of these arguments you receive a warning message.

-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
-y libraryName
(Optional) This parameter specifies the name of the library that contains the message flow for which statistics are being collected.

When you set this parameter, you must also set either the -f (message flow) parameter, or the -j (all message flows) parameter. To collect statistics for a named message flow in a specific library, set the -k and -f parameters. To collect statistics for all message flows in a library, set the -k and -j parameters.

Examples

Turn on snapshot statistics for the message flow "myFlow1" in all integration servers of BrokerA and specify that the statistics are not to be partitioned according to accounting origin data:
mqsichangeflowstats BrokerA -s -g -j -b none -c active  
Turn on the collection of snapshot statistics data for all message flows in all integration servers for Broker A, and emit the data in XML and JSON formats :
mqsichangeflowstats BrokerA -s -g -j -c active -o xml,json  
Turn off the collection of archive statistics for message flow "MyFlow1" in integration server "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 integration servers for Broker A.
mqsichangeflowstats BrokerA -s -g -j -c inactive  

an28420_.htm | Last updated Friday, 21 July 2017