PERFORM STARTMON

Use the PERFORM STARTMON statement to initiate monitoring of IBM MQ objects, to specify the sampling interval for collecting IBM MQ data, and to specify whether historical data is collected.

The PERFORM STARTMON statement is required.

Syntax

PERFORM STARTMON
       SAMPINT(sample-interval)
       HISTORY (YES|NO)
       [ACTIVEONLY(YES|NO)]
       [ROWLIM(limit)]
       [SVRCONN(YES|NO)]
       [QSGCHKINTERVAL(sss)]
       [GRPNAME(KMQQSG|gggggggg)
       [STAGGERSAMPLE(YES|NO)]

Parameters

SAMPINT(sample-interval)

How often, in seconds, IBM MQ Monitoring Agent samples your queue managers for performance data. The default value is 300. The minimum is 10 seconds. The SAMPINT setting does not affect the amount of historical data that is produced.

If your site is monitoring a large number of queues or channels, you might experience a degradation in performance. If this occurs, increase the SAMPINT value to improve performance.

If your site is monitoring queue-sharing groups on z/OSĀ® systems, the sample interval must be the same for all the agents that monitor queue managers in queue-sharing groups.

You can modify the effective sampling interval for a specific queue manager or a group of queue managers with the ICYCLE parameter of the SET MANAGER or the SET GROUP statement. See ICYCLE in SET MANAGER and ICYCLE in SET GROUP.

HISTORY(YES|NO)
Defines whether historical data is maintained for attribute groups whose data is sampled by the agent. Set it to YES for the agent to maintain and provide data to configured historical collections for sampled attribute groups. (For information about using the historical data collection function, see Collecting historical data. For information about sampled and on-demand attribute groups, see Sampled and on-demand tables.)
ACTIVEONLY(YES|NO)
This optional parameter indicates whether to monitor only active queue managers.

YES: Only queue managers that are running when the agent is started, or that become active while the agent is running, are monitored by the agent and have a managed system created for them so that situations and workspaces can refer to them. YES is highly recommended when you define the same subsystem name list among multiple LPARs, since the discovers queue managers to monitor via the subsystem list. Without YES for this parameter, the agent will create managed systems for queue managers that never become active on an LPAR.

NO: All defined queue managers, active or not, are monitored by the agent and have a managed system created for them so that situations and workspaces can refer to them.

In PARMGEN, the value of NO is set by default for this parameter. In Configuration Manager, the value of YES is set by default.

ROWLIM(limit)
This optional parameter specifies the maximum number of messages that are processed and returned by the agent when reading messages from a queue for report requests. The default value is 0 (zero), which means that the maximum number of messages is not limited.
SVRCONN(YES|NO)
This optional parameter indicates whether to collect server connection channel statistics that are displayed in the Channel Performance workspaces (and the short and long-term Channel Performance History workspaces). The default value is YES.
QSGCHKINTERVAL(sss)
This parameter applies only to z/OS systems

This optional parameter specifies how often, in seconds, IBM MQ Monitoring Agent performs queue-sharing group monitoring activities. The default value is 300, which is a 5-minute interval. The minimum is 60 seconds. This value can be set to 0 to turn off queue-sharing group monitoring activities. If you turn this processing off, you must recycle the agent to turn this processing back on.

GRPNAME(KMQQSG|gggggggg)
This parameter applies only to z/OS systems

Use this optional parameter to specify an alternative sysplex XCF group name, gggggggg (1 - 8 characters), for the coexistence of multiple collection agents. The default value is KMQQSG. Typically, this parameter is not specified. By using this parameter that is intended for testing purposes, multiple agents can coexist while being tested.

Exception: Do not specify an XCF group name that is in use by other system components because unexpected consequences might occur.
STAGGERSAMPLE(YES|NO)
Specifies whether queue manager sample collection is done all at once or at staggered intervals.

YES: The sample collection for different queue managers is started at different times during the interval. When the agent is monitoring several queue managers, the value YES can help avoid a spike in CPU utilization at each sample interval.

NO: The sample collection for all queue managers is started at the same time.

The default value is NO.

Example

To start monitoring with a sampling interval of 120 seconds, and to explicitly specify that historical data and server connection channel statistics are to be collected, you can specify the following statement:

PERFORM STARTMON SAMPINT(120) HISTORY(YES) SVRCONN(YES)