WebSphere Message Broker, Version 8.0.0.7 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

mqsichangeflowstats command - z/OS

Use the mqsichangeflowstats command on z/OS® to control the accumulation of statistics about message flow operation.

Syntax

z/OS command - BIPCHMS

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

                                                     (1)   
>--+- -e -ExecutionGroupName--+- -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.

z/OS console command

Synonym: cs

Read syntax diagramSkip visual syntax diagram
>>-+-changeflowstats-+--+-a=yes-+------------------------------->
   '- cs ------------'  '-s=yes-'   

                                               (1)   
>--+-e=ExecutionGroupName--+-f=MessageFlow-+-+------------------>
   |                       '-j=yes---------' |       
   '-g=yes--j=yes----------------------------'       

>--+-----------+--+--------------+--+------------+--+-------+--->
   '-c=Control-'  '-t=ThreadData-'  '-n=NodeData-'  '-r=yes-'   

>--+--------------------+--+----------------+------------------><
   '-b=AccountingOrigin-'  '-o=OutputFormat-'   

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.

This parameter is implied on the console form of the command.

-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 ExecutionGroupName
(Required) Specify the name for the execution group, 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 execution groups 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 execution group.

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 execution groups, 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. 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 - statistics reports are output as SMF type 117 records.
-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 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 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

Using the command BIPCHMS:
  • Turn on snapshot statistics for the message flow "myFlow1" in all execution groups and specify that the statistics are not to be partitioned according to accounting origin data:
    mqsichangeflowstats BrokerA -s -g -j -b none   
  • Turn off the collection of archive statistics for message flow "MyFlow1" in execution group "EGRP2" , 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   
The following example uses the console form of the command. Turn on archive accounting for all the message flows in all the execution groups that belong to the broker and output the report as SMF records.
F VCP2BRK,CS A=YES,G=YES,J=YES,C=ACTIVE,O=SMF
Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2016Copyright IBM Corporation 1999, 2016.

        
        Last updated:
        
        Last updated: 2016-05-23 14:47:22


Reference topicReference topic | Version 8.0.0.7 | an28430_