+ All Categories
Home > Documents > Cartridge for IBM WebSphere MQ Server Installation...

Cartridge for IBM WebSphere MQ Server Installation...

Date post: 14-Mar-2018
Category:
Upload: lenga
View: 224 times
Download: 2 times
Share this document with a friend
33
5.5.5 Foglight ® Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide
Transcript
Page 1: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

5.5.5Foglight®Cartridge for IBM WebSphere MQ ServerInstallation and Configuration Guide

Page 2: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

© 2012 Quest Software, Inc. ALL RIGHTS RESERVED.

This guide contains proprietary information protected by copyright. The software described in this guide is furnished under a software license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of the applicable agreement. No part of this guide may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording for any purpose other than the purchaser’s personal use without the written permission of Quest Software, Inc.

The information in this document is provided in connection with Quest products. No license, express or implied, by estoppel or otherwise, to any intellectual property right is granted by this document or in connection with the sale of Quest products. EXCEPT AS SET FORTH IN QUEST'S TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT, QUEST ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL QUEST BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF QUEST HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest makes no representations or warranties with respect to the accuracy or completeness of the contents of this document and reserves the right to make changes to specifications and product descriptions at any time without notice. Quest does not make any commitment to update the information contained in this document.

If you have any questions regarding your potential use of this material, contact: Quest Software World Headquarters LEGAL Dept 5 Polaris Way Aliso Viejo, CA 92656 www.quest.com email: [email protected]

Refer to our Web site for regional and international office information.

Trademarks

Quest, Quest Software, the Quest Software logo, Foglight, IntelliProfile, PerformaSure, Spotlight, StealthCollect, TOAD, Tag and Follow, Vintela Single Sign-on for Java, and vFoglight are trademarks and registered trademarks of Quest Software, Inc in the United States of America and other countries. For a complete list of Quest Software’s trademarks, please see http://www.quest.com/legal/trademark-information.aspx. Other trademarks and registered trademarks are property of their respective owners.

Third Party Contributions

Foglight contains some third party components. For a complete list, see the License Credits page in Foglight online help.

Installation and Configuration Guide February 2012 Version 5.5.5.9

Page 3: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Table of Contents

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 3

Introduction to this Guide..................................................................................................................................................4

About Quest Software, Inc. ............................................................................................................................................................. 4Contacting Quest Software ..................................................................................................................................................... 4Contacting Quest Support ....................................................................................................................................................... 5

Installing the Foglight Cartridge for IBM WebSphere MQ Server ..................................................................................6

Configuring the Queue Manager for Monitoring .............................................................................................................................. 7Event Configuration................................................................................................................................................................. 7Queue Statistics Configuration................................................................................................................................................ 8Online Monitoring Level........................................................................................................................................................... 8Authorization for MQ Objects .................................................................................................................................................. 8

Installing and Enabling the Cartridge for IBM WebSphere MQ Server ......................................................................................... 10Deploying the MQ Agent Package to Monitored Hosts ................................................................................................................. 10Creating MQ Agent Instances ....................................................................................................................................................... 11Upgrading the Cartridge for IBM WebSphere MQ Server ............................................................................................................. 12

Setting MQ Agent Properties...........................................................................................................................................13

Setting the Identity Properties ............................................................................................................................................... 15Setting the Connection Properties ........................................................................................................................................ 15Setting the SSL Properties ................................................................................................................................................... 17Setting the Discovery Properties ........................................................................................................................................... 18Setting the Monitor Lists Properties ..................................................................................................................................... 19Setting the Event Properties.................................................................................................................................................. 22Setting the Statistics Events Properties ................................................................................................................................ 28Setting the Listener Monitoring Property ............................................................................................................................... 28Setting the Advanced (Batch) Properties .............................................................................................................................. 29Setting the Data Collection Scheduler Property .................................................................................................................... 29

Activating MQ Agent Instances and Starting Data Collection ....................................................................................................... 30

Index ..................................................................................................................................................................................31

Page 4: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Introduction to this Guide

Welcome to the Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide. This guide is intended for any user who wants to install and configure the Cartridge for IBM WebSphere MQ Server. It contains information on how to enable your IBM WebSphere MQ system for Foglight monitoring, describes the process of installing the cartridge and enabling its data collection, and contains instructions for configuring the MQAgent, used by the cartridge to monitor the entire distributed-messaging environment.

About Quest Software, Inc.Quest Software (Nasdaq: QSFT) simplifies and reduces the cost of managing IT for more than 100,000 customers worldwide. Our innovative solutions make solving the toughest IT management problems easier, enabling customers to save time and money across physical, virtual and cloud environments. For more information about Quest solutions for administration and automation, data protection, development and optimization, identity and access management, migration and consolidation, and performance monitoring, go to www.quest.com.

Contacting Quest Software

Refer to our Web site for regional and international office information.

Email [email protected]

Mail Quest Software, Inc. World Headquarters 5 Polaris Way Aliso Viejo, CA 92656 USA

Web site www.quest.com

Page 5: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 5Introduction to this Guide

Contacting Quest SupportQuest Support is available to customers who have a trial version of a Quest product or who have purchased a Quest product and have a valid maintenance contract. Quest Support provides unlimited 24x7 access to our support portal. Visit our support portal at http://www.quest.com/support.

From our support portal, you can do the following:

• Retrieve thousands of solutions from our Knowledge Base

• Download the latest releases and service packs

• Create, update, and review Support cases

View the Global Support Guide for a detailed explanation of support programs, online services, contact information, policies, and procedures. The guide is available at: http://www.quest.com/support.

Page 6: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

1

Installing the Foglight Cartridge for IBM WebSphere MQ Server

The Foglight Cartridge for IBM WebSphere MQ Server provides an effective monitoring solution for the distributed IBM WebSphere MQ infrastructure. The solution enables systems managers to better manage the delivery of services by alerting them to messaging infrastructure problems before end users are affected, ensuring consistent application performance at established service levels. The Cartridge for IBM WebSphere MQ Server monitors the health of the messaging system by tracking MQ objects, such as queue managers, queues, channels, and processes.

There are two methods for monitoring WebSphere MQ Servers using the MQ Agent included in the Cartridge for IBM WebSphere MQ Server: remote and local (bindings mode). Remote monitoring is the recommended method, and involves deploying both a Foglight Agent Manager and an MQ Agent to each WebSphere MQ Queue Manager that you want to monitor. Bindings mode monitoring is only supported in limited situations. For details, see the Foglight Cartridge for IBM WebSphere MQ Server Release Notes.

The agent may be enabled for local monitoring if remote monitoring is not a suitable option. The following table summarizes the differences between local monitoring, when the agent collects data in bindings mode, and remote monitoring.

Installing the Cartridge for IBM WebSphere MQ Server is a multi-step process. First, you must configure the queue manager for monitoring. Next, install the Cartridge for IBM WebSphere MQ Server on the Foglight Management Server and deploy the MQ Agent package. Then you create MQ Agent instances and configure their properties. Finally, you activate the agents, and start their data collection. For details, see the following sections:

• “Configuring the Queue Manager for Monitoring” on page 7

• “Installing and Enabling the Cartridge for IBM WebSphere MQ Server” on page 10

• “Deploying the MQ Agent Package to Monitored Hosts” on page 10

• “Creating MQ Agent Instances” on page 11

Remote monitoring Local moniotring (Bindings mode)

• Results in fewer monitored objects which increases the performance

• Can report non-availability when the target server is down

• No network communication involved• No listeners or channels are required• Less security configuration involved and more secure

Page 7: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 7Chapter 1—Installing the Foglight Cartridge for IBM WebSphere MQ Server

• “Setting MQ Agent Properties” on page 13

• “Activating MQ Agent Instances and Starting Data Collection” on page 30

Configuring the Queue Manager for MonitoringThis section contains information on the values you need to set on your IBM WebSphere MQ Server to enable the Cartridge for IBM WebSphere MQ Server to collect data from that environment.

Note For instructions on how to set these values, consult your IBM WebSphere MQ Server documentation. Generic examples are provided in the following sections, but these examples should not be considered recommendations for configuration.

Configuration of each queue manager involves setting the values for the following:

• Event Configuration

• Queue Statistics Configuration

• Online Monitoring Level

• Authorization for MQ Objects

• System Objects

• User-Defined (Application) Objects

Event ConfigurationTo maximize the data available to the MQ Agent, enable the following events on the monitored queue manager:

• Authority

• Inhibit

• Local

• Channel

• Start stop

• Performance

• Channel auto definition

• SSL

These values can be set using the MQ Explorer, the MQSeries commands (MQSC), or the Programmable Command Format (PCF) commands.

For example:

To set the event configuration using MQSC:

alt qmgr AUTHOREV(ENABLED) CHADEV(ENABLED) CHLEV(ENABLED) INHIBTEV(ENABLED) PERFMEV(ENABLED) LOCALEV(ENABLED) SSLEV(ENABLED) REMOTEEV(ENABLED)

Page 8: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 8Chapter 1—Installing the Foglight Cartridge for IBM WebSphere MQ Server

Queue Statistics ConfigurationQueue statistics for the monitored queue manager must be enabled.

To enable the statistics configuration using MQSC:

alt qmgr STATQ(ON|OFF)

Note The queue statistics collection should be at least as frequent as the statistics collection configured for the monitoring agent.

For example:

To set the statistics interval to the default of 1800 seconds using MQSC:

alt qmgr STATINT(1800)

Values in the range 1 through 604 800 are valid.

Online Monitoring LevelThe oldest message age metric of a queue depends on its online monitoring settings. In MQ Explorer, in queue properties, the Statistics section contains the Queue Monitoring setting. It can be set to different levels of reporting, including OFF, LOW, MEDIUM, HIGH, and others. Setting this value to LOW or a higher value enables the MQ Agent to report the oldest message age.

Alternatively, you can also inherit the queue manager’s monitoring level by setting the Queue Monitoring value to QMGR, when that value is set to LOW, MEDIUM, or HIGH (found in the Online Monitoring section, Queue Monitoring value).

To set the online monitoring level using MQSC:

alt qmgr MONQ(LOW|MEDIUM|HIGH)

When queue monitoring is disabled for a queue, the MQ Agent generates an alarm, triggered by the Queue Monitoring rule. For more information about this rule, see the User and Reference Guide.

Authorization for MQ ObjectsThe MQ Agent connects to the monitored queue manager as a particular user (defined in your configuration).

IBM WebSphere MQ uses the Message Channel Agent (MCA) User account to authorize users. This is always a user account on the local OS. IBM WebSphere MQ supports group-based authorization and this user account can be included in one of the user groups on the local OS.

In remote data collection mode, the MQ Agent runs under the MCA user ID, specified in the server connection channel in the WebSphere MQ system. If the MCA user ID is left blank, the MQ Agent uses the mqm user account, which grants access permissions to all MQ Agent instances connected through that channel.

In bindings mode, the MQ Agent runs under the MCA user ID that starts the Agent Manager process.

Page 9: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 9Chapter 1—Installing the Foglight Cartridge for IBM WebSphere MQ Server

Appropriate access authorization is required for this user and can be configured either through MQ Explorer or using command-line utility, setmqaut. The simplest configuration method is to connect as an mqm user (or a member of the mqm group). In this case, no specific changes to permissions are required.

To set the authority settings:

Refer to the IBM documentation for the Websphere MQ Server version you are using. For example, for MQ 6: http://publib.boulder.ibm.com/infocenter/wmqv6/v6r0/index.jsp?topic=/com.ibm.mq.amqzag.doc/fa13160_.htm

System Objects

The following table lists the objects monitored by the MQ Agent instances and the required permissions associated with these objects:

User-Defined (Application) Objects

For user-defined objects (such as application queues) the following permissions are required:

Object Ideal Permissions Minimal Permissions

SYSTEM.ADMIN.CHANNEL.EVENT Browse, Get, Inquire Browse, Inquire

SYSTEM.ADMIN.COMMAND.QUEUE Put, Inquire Put, Inquire

SYSTEM.ADMIN.PERFM.EVENT Browse, Get, Inquire Browse, Inquire

SYSTEM.ADMIN.QMGR.EVENT Browse, Get, Inquire Browse, Inquire

SYSTEM.ADMIN.STATISTICS.QUEUE Browse, Get, Inquire Browse, Inquire

SYSTEM.CHANNEL.INITQ Inquire Inquire

SYSTEM.CLUSTER.COMMAND.QUEUE Display, Inquire Display, Inquire

SYSTEM.CLUSTER.REPOSITORY.QUEUE Display, Inquire Display, Inquire

SYSTEM.CLUSTER.TRANSMIT.QUEUE Display, Inquire Display, Inquire

SYSTEM.DEFAULT.MODEL.QUEUE Display, Get Display, Get

Object Ideal Permissions Minimal Permissions

Any listener Display Display

Dead-letter queue Inquire Inquire

Queue manager Connect, Inquire, Display Connect, Inquire, Display

User-defined channel Display Display

Page 10: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 10Chapter 1—Installing the Foglight Cartridge for IBM WebSphere MQ Server

Installing and Enabling the Cartridge for IBM WebSphere MQ ServerThe installation process is common to all Foglight cartridges. You must first install the cartridge *.car file and then deploy one or more MQ Agents before using the Cartridge for IBM WebSphere MQ Server.

Note If you are uprading from a previous version of the Cartridge for IBM WebSphere MQ Server, see “Upgrading the Cartridge for IBM WebSphere MQ Server” on page 12.

The Cartridge for IBM WebSphere MQ Server is distributed in a .car file, MQ-<version>.car. Installing the cartridge file on the Management Server adds the capabilities for monitoring IBM WebSphere MQ Server systems to your Foglight environment. Next, the cartridge must be enabled. Enabling the cartridge causes its components to be available for use by Foglight. When the cartridge is installed and enabled, all of its components become part of the Management Server.

For instructions for installing and enabling the cartridge, see “Installing Foglight cartridges” in the Foglight Administration and Configuration Help.

To view the Cartridge for IBM WebSphere MQ Server:

• On the navigation panel, under Dashboards, click Administration > Cartridges > Cartridge Inventory.

After installing and enabling the cartridge, you must deploy the MQ Agent package to each host that you want to monitor.

Note When considering a group of IBM WebSphere MQ Servers that you want to monitor, even if the servers host clustered queues, you must configure a separate MQ Agent instance for each server. For more information, see Deploying the MQ Agent Package to Monitored Hosts.

Deploying the MQ Agent Package to Monitored HostsThe MQ Agent collects data from monitored hosts. After installing and enabling the cartridge on the Management Server, you must deploy the MQ Agent package to each host that you want to monitor.

The MQ Agent uses the Foglight Agent Manager to communicate with the Foglight Management Server. Each monitored host must have an Agent Manager installed before the MQ Agent package can be deployed to that host. For more information about installing the Agent Manager on monitored hosts, see the Foglight Agent Manager Installation Guide.

User-defined queue Display Display

Object Ideal Permissions Minimal Permissions

Page 11: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 11Chapter 1—Installing the Foglight Cartridge for IBM WebSphere MQ Server

The following procedure describes the process of deploying the MQ Agent package using the Agent Status dashboard in the Foglight browser interface. This dashboard is useful for deploying the agent package one host at a time. Alternatively, to deploy the MQ Agent package to multiple hosts, you can use the Agent Hosts dashboard. For more information, see the Foglight Administration and Configuration Guide.

You can also deploy agent packages through the fglcmd command-line interface. For information about the available fglcmd commands, see the Command-Line Reference Guide.

To deploy the MQ Agent package:

1 On the navigation panel, under Dashboards, click Administration > Agents > Agent Status.

2 On the Agent Status dashboard, click Deploy Agent Package (in the lower-left corner).

The Deploy Agent Package dialog box opens.

Note An Agent Manager must be installed and running on the host in order for you to deploy an agent package to that host.

3 In the Deploy Agent Package dialog box, select the host that you want the MQ Agent to monitor in the Host list.

4 From the Package list, select MQ.gar.

5 Click Deploy.

The Deploy Agent Package dialog box refreshes. A green check mark in the Status column indicates a successful deployment.

If agent deployment is not successful, see the online help for the Agent Status dashboard for troubleshooting information.

6 Click OK to close the Deploy Agent Package dialog box.

From here, you can proceed to create one or more MQ Agent instances. For more information, see “Creating MQ Agent Instances” on page 11.

Creating MQ Agent InstancesThe Cartridge for IBM WebSphere MQ Server uses the MQ Agent to collect information from monitored hosts. Creating an MQ Agent instance creates the agent process.

The following procedure describes the process of creating MQ Agent instances using the Agent Status dashboard in the Foglight browser interface. This dashboard is useful for creating agent instances one host at a time. Alternatively, for creating MQ Agent instances on multiple hosts, you can use the Agent Hosts dashboard. For more information, see the Administration and Configuration Guide.

Another way to create agent instances is using the fglcmd command-line interface. For more information about the available fglcmd commands, see the Command-Line Reference Guide.

Page 12: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 12Chapter 1—Installing the Foglight Cartridge for IBM WebSphere MQ Server

To create an MQ Agent instance:

1 On the navigation panel, under Dashboards, click Administration > Agents > Agent Status.

2 On the Agent Status dashboard, click Create Agent (in the lower-left corner).

3 In the Create Agent dialog box, click Host and select the host that you want to monitor.

The Agent Type list refreshes. If you have deployed the MQ Agent package to that host, the MQAgent appears in the list.

4 In the Agent Type list, select MQAgent.

5 In the Instance Name box, type a name for the MQ Agent instance.

Tip Each MQ queue manager that you want to monitor must have its own agent instance, so consider using queue manager names in agent instance names to emphasis that relationship. For example: MQAgent_QueueManager_on_HostName.

6 Click Create.

The Create Agent dialog box closes and the Create Agent Results dialog box opens, showing the status of the agent creation. A green check mark in the Status column indicates that the agent was created successfully.

7 Click OK to close the Create Agent Results dialog box.

The Agent Status dashboard refreshes, and the newly-created MQ Agent instance appears in the list.

Next, edit the MQ Agent properties. For more information, see Chapter 2, “Setting MQ Agent Properties”.

Upgrading the Cartridge for IBM WebSphere MQ ServerIf you have been using version 5.5.5 or later of the Cartridge for IBM WebSphere MQ Server, you can upgrade to the latest version instead of performing a completely new installation.

To upgrade the Cartridge for IBM WebSphere MQ Server, you must first deactivate any existing agents, and then install version 5.5.6 of the cartridge as you would a new Cartridge for IBM WebSphere MQ Server. Do not delete the older version of the .car file.

To upgrade the Cartridge for IBM WebSphere MQ Server

1 On the Agent Status page, deactivate all existing MQ Agent instances.

2 Install and enable the new cartridge.

3 Deploy the new MQ Agent package to each monitored host.

4 Activate the MQ Agent instances and start data collection.

For detailed information on upgrade compatibility, see the Cartridge for IBM WebSphere MQ Server Release Notes.

Page 13: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

2

Setting MQ Agent Properties

The MQ Agent provides an effective monitoring solution for the distributed IBM WebSphere MQ infrastructure. It collects data from the distributed IBM WebSphere MQ infrastructure and sends it to Foglight. The agent keeps track of MQ objects such as queue managers, queues, channels and listeners. This solution uses a messaging infrastructure to alert you before end-users are affected.

When an agent connects to Foglight, it is provided with sets of properties that it uses to configure its correct running state. Each agent is provided with a combination of two types of properties: agent properties and shareable properties.

Default versions of these properties are installed with the Cartridge for IBM WebSphere MQ Server. However, you can edit the default shareable and agent properties, configure agent properties that apply only to a specific agent instance, and create edited clones of shareable properties that are used by a subset of agents of a certain type.

For more information about working with agent properties, see the Foglight Administration and Configuration Guide.

Each queue manager that you want to monitor requires its own MQ Agent instance.

Caution A technical limitation currently restricts the number of monitored queues for each Agent Manager to 1000. Ensure that this limit is adhered to when monitoring multiple queue managers from the same Foglight Agent Manager.

The configuration of agent properties described in this section include:

• “Setting the Identity Properties” on page 15

• “Setting the Connection Properties” on page 15

• “Setting the SSL Properties” on page 17

• “Setting the Discovery Properties” on page 18

• “Setting the Monitor Lists Properties” on page 19

• “Setting the Event Properties” on page 22

• “Setting the Statistics Events Properties” on page 28

• “Setting the Listener Monitoring Property” on page 28

• “Setting the Advanced (Batch) Properties” on page 29

• “Setting the Data Collection Scheduler Property” on page 29

Page 14: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 14Chapter 2—Setting MQ Agent Properties

Modify the properties for each MQ Agent instance. An MQ Agent instance can have a combination of global and private properties. Global properties apply to all instances of the agent type while private properties apply only to specific agent instances.

To modify agent properties:

1 On the navigation panel, under Dashboards, click Administration > Agents > Agent Status.

2 On the Agent Status dashboard, select the instance of the MQ Agent whose properties you want to modify and click Edit Properties.

Caution Another way of editing MQ Agent properties is through the Agent Properties dashboard. However, keep in mind that the properties you specify on this dashboard apply to all instances of the MQ Agent type. To ensure that you are editing properties for a particular agent instance, without overwriting any properties for other MQ Agent instances, use the Agent Status dashboard instead of the Agent Properties dashboard.

3 Click Modify the private properties for this agent.

A list of agent properties appears in the display area.

Page 15: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 15Chapter 2—Setting MQ Agent Properties

Setting the Identity PropertiesUse the Identity properties to assign an identity to the monitored queue manager.

To set the connection profile:

Note This procedure continues from “To modify agent properties:” on page 14.

1 Locate the Identity properties.

2 In the Queue Manager Name box, type the name of the queue manager instance that you want to monitor.

Queue manager names can be located by doing any of the following:

• Running the IBM WebSphere MQ dspmq program on the monitored host.

• Using the IBM WebSphere MQ runmqsc program.

• Using the IBM WebSphere MQ Explorer.

Contact your IBM WebSphere MQ administrator if you are unsure of the queue manager name.

Caution Leaving this property blank causes the MQ Agent to fail and log a warning message. Ensure that the queue manager name you enter here is valid. The name is case sensitive.

3 In the MQ Group Name box, type the name of the queue manager group that you want to monitor.

The MQ group name can be used to group related queue managers together in the dashboards. You can assign any name to the queue manager for this purpose (for example, Payroll).

4 Click Save.

5 To specify the type of connection, see Setting the Connection Properties.

Otherwise, click Back to Agent Status and activate the MQ Agent, as described in “Activating MQ Agent Instances and Starting Data Collection” on page 30.

Setting the Connection Properties Use the Connection MQ Agent properties to specify the type of connection.

The MQ Agent can connect to a queue manager either as a remote client or in Bindings mode. It is possible to have the agent running on the same host as your MQ system, and to operate as a remote client.

To set the connection properties:

Note This procedure continues from “To modify agent properties:” on page 14.

1 Locate the Connection properties.

Page 16: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 16Chapter 2—Setting MQ Agent Properties

2 Select the applicable Remote Connection option: True or False.

• Select True if you want to instruct the MQ Agent to remotely monitor the queue manager client. This is the default mode.

or

• Select False if you want to instruct the MQ Agent to locally monitor the queue manager using a bindings (local) connection.

Caution Support for the Bindings mode is limited. Consult the Release Notes to confirm that your platform is supported before using this feature.

If you choose the bindings mode, the path to the IBM MQ Java libraries must be defined in an environment variable before starting the Agent Manager, as specified in the following table:

For additional information about connecting the queue manager in bindings mode, see your IBM MQ documentation or visit http://publib.boulder.ibm.com/infocenter/wmqv7/v7r0/index.jsp?topic=/com.ibm.mq.csqzaw.doc/jm10340_.htm.

3 For Remote monitoring only: Configure the MQ Agent to allow the creation of remote connections.

a In the Host Name box, type the fully qualified name or IP address of the host machine on which the remote queue manager is running.

Platform Variable Path

AIX LIBPATH 64-bit libraries:/usr/mqm/java/lib64 32-bit libraries:/usr/mqm/java/lib

HP-UX LD_LIBRARY_PATH 64-bit libraries:/opt/mqm/java/lib6432-bit libraries:/opt/mqm/java/lib

Linux (POWER, x86-64 and zSeries s390x platforms)

Solaris (x86-64 and Sparc platforms)

Linux (x86 and zSeries platforms)

LD_LIBRARY_PATH /opt/mqm/java/lib

Windows PATH 64-bit libraries:install_dir\java\lib6432-bit libraries:install_dir\java\lib

Caution When using Bindings mode on a 64-bit Windows monitored system, modify the PATH system variable to first point to the 64-bit libraries (install_dir\java\lib64), and then to the 32-bit libraries (install_dir\java\lib).

Page 17: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 17Chapter 2—Setting MQ Agent Properties

b In the Server Channel box, type the name of the server connection channel on the remote queue manager.

c In the Port Number box, type the listener port number of the remote queue manager.

4 Click Save at the bottom of the window to save the entries.

5 To set the Secure Sockets Layer (SSL) agent properties, see Setting the SSL Properties.

Otherwise, click Back to Agent Status and activate the MQ Agent, as described in “Activating MQ Agent Instances and Starting Data Collection” on page 30.

Setting the SSL Properties If you want to enable the transmission of secure data over an insecure network, use the Secure Sockets Layer (SSL) set of agent properties

The MQ Agent supports connection to an MQ Server over a server connection channel enabled with SSL. Once the appropriate keys have been created and exchanged, the MQ Agent must be configured using the agent properties.

Important Prior to SSL agent property configuration, the MQ system parameter “Authentication of parties initiating connections” must be set to Optional.

To set the Secure Sockets Layer properties:

Note This procedure continues from “To modify agent properties:” on page 14.

1 Locate the SSL properties.

2 Select a cipher suite from the Cipher Spec list.

Note After changing the cipher suite for an MQ Agent, it may be necessary to restart the Agent Manager for that MQ Agent.

Cipher Spec Connection Possible if SFIPS (No)

Connection Possible if SFIPS (Yes)

DES_SHA_EXPORT Yes No

NONE N/A N/A

NULL_MD5 Yes No

NULL_SHA Yes No

RC4_MD5_EXPORT Yes No

RC4_MD5_US Yes No

RC4_SHA_US Yes No

Page 18: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 18Chapter 2—Setting MQ Agent Properties

3 In the trustStore Location box, type the path to the MQ Agent's trust store.

The path must include the name of the file itself. For example: C:\Documents and Settings\foglight\.keystore

Caution Only one trust store location may be used for all MQ Agent instances running under a single Agent Manager.

Important If you select a cipher spec from the Cipher Spec list, this value is mandatory.

4 In the trustStore Password box, type the password for accessing the agent's trust store.

Important If you select a cipher spec from the Cipher Spec list, this value is mandatory.

5 Click Save.

6 To enable or disable monitoring of auto-discovered queues and channels, see Setting the Discovery Properties.

Otherwise, click Back to Agent Status and activate the MQ Agent, as described in “Activating MQ Agent Instances and Starting Data Collection” on page 30.

Setting the Discovery PropertiesUse the Discovery Settings agent properties to enable the MQ Agent to automatically discover and monitor user-defined queues and channels for a queue manager.

A useful approach during an initial configuration is to enable auto-discovery, but disable the monitoring of discovered properties for queues and channels. When the agent starts, you can then manually edit the queue and channel lists, to enable the monitoring of only those queues and channels that are of interest to you.

After the installation, consider re-enabling the monitoring of discovered properties, so that the MQ Agent starts automatically monitoring any new queues that become available.

To set the Discovery Settings properties:

Note This procedure continues from “To modify agent properties:” on page 14.

1 Locate the Discovery Settings properties.

2 Select the applicable Auto-discovery option: True or False. Auto-discovery is a scheduled collection which occurs by default once an hour.

Select True if you want the MQ Agent to automatically populate the queue and channel lists. Otherwise, select False.

TLS_RSA_WITH_AES_256_CBC_SHA (MQ 7.0.1.6+)

No Yes

TRIPLE_DES_SHA_US Yes No

Cipher Spec Connection Possible if SFIPS (No)

Connection Possible if SFIPS (Yes)

Page 19: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 19Chapter 2—Setting MQ Agent Properties

3 Select the applicable Monitor Discovered Queues option: True or False.

Note This setting can be adjusted for each queue in the queue list at a later time. Setting it to False prevents the agent from monitoring discovered queues. A discovered queue that is not being monitored can later be added to the list of monitored queues, as described in “Setting the Monitor Lists Properties” on page 19

Select True if you want the MQ Agent to immediately start monitoring all auto-discovered queues. Otherwise, select False .

4 Select the applicable Monitor Discovered Channels option: True or False.

Note This setting can be adjusted for each channel in the channel list at a later time. Setting it to False prevents the agent from monitoring discovered channels. A discovered channel that is not being monitored can later be added to the list of monitored channels, as described in “Setting the Monitor Lists Properties” on page 19.

Select True if you want the MQ Agent to immediately start monitoring all auto-discovered channels. Otherwise, select False.

5 Select the applicable Monitor MQ System Objects option: True or False.

Select True if you want the MQ dashboards to display the metrics associated with system queues and channels (that is, SYSTEM.*). Otherwise, select False .

It is possible to manually add a subset of these objects to the queue or channel lists when only specific SYSTEM objects are useful. To do that, you can add entries to the queue list, each containing a desired SYSTEM object, for example, SYSTEM.ADMIN.PERFM.EVENT. For information about editing queue lists, see “Setting the Monitor Lists Properties” on page 19.

6 Click Save.

7 To set the items in the Queue and Channel lists, see Setting the Monitor Lists Properties.

Otherwise, click Back to Agent Status and activate the MQ Agent, as described in “Activating MQ Agent Instances and Starting Data Collection” on page 30.

Setting the Monitor Lists Properties These secondary agent properties maintain a list of which queues and channels are to be monitored for a particular queue manager. Monitoring of each item in a list can be enabled or disabled.

Caution It is essential that each agent have its own queue and channel lists. Ensure that you clone a new list when you are first configuring your agent.

To set the monitor lists properties:

Note This procedure continues from “To modify agent properties:” on page 14.

1 Locate the Monitor Lists properties.

2 Clone the defaultQueueList list.

a From the Queue List, select defaultQueueList.

Caution This is a default, empty queue list. Selecting other, pre-populated queue lists (if available) and cloning them (as described in step b) results in their list entries being copied to the

Page 20: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 20Chapter 2—Setting MQ Agent Properties

destination list and requires their removal. For the same reason, you should not clone any queue lists populated by the auto-discovery process, unless the second list is expected to have the same queue names as the first list.

b Click the Clone button to the right of Queue List to create a clone of the selected defaultQueueList.

In the dialog box that opens, type a name for the cloned list.

Caution Failing to clone the defaultQueueList causes it to be populated with entries that are carried over to the subsequent queue lists created by cloning this default list, and requires you to remove them manually from each cloned instance.

3 Update the newly-cloned list.

You can add alias queues, and cluster queues on the monitored queue manager.

When auto-discovery is enabled, the MQ Agent needs some time to update the queue and channel lists. Changing the auto-discovery or editing these lists during the update is not recommended. Instead, you can make these changes either on deactivated MQ Agent instances, or on running agent instances that have a discovery collection frequency of five minutes or higher.

a Click the Edit button to the right of Queue List.

b In the dialog box that opens, click Add Row to add an entry.

For each row, define the following values:

Note If auto-discovery is enabled, the queue and channel lists are automatically populated.

Queue Name: Type the name of this queue.

Monitor: Select the check box to enable the monitoring of the queue, or clear the check box to disable monitoring.

c Save your changes to the queue list by clicking Save Changes in the dialog box.

The dialog box closes.

4 Repeat step 2 and step 3 to create as many queue lists as necessary.

Note You must add a queue list for each MQ Agent instance.

5 Clone the defaultChannelList list.

a From the Channel List, select defaultChannelList.

Caution This is a default, empty channel list. Selecting other, pre-populated channel lists (if available) and cloning them (as described in step b) results in their list entries being copied to the destination list and requires their removal. For the same reason, you should not clone any channel lists populated by the auto-discovery process, unless the second list is expected to have the same channel names as the first list.

b Click the Clone button to the right of Channel List to create a clone of the defaultChannelList.

In the dialog box that opens, type a name for the cloned list.

Caution Failing to clone the defaultChannelList causes it to be populated with entries that are carried over to the subsequent channel lists created by cloning this default list, and requires you to remove them manually from each cloned instance.

6 Update the newly-cloned list.

Page 21: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 21Chapter 2—Setting MQ Agent Properties

When auto-discovery is enabled, the MQ Agent needs some time to update the queue and channel lists. Changing the auto-discovery or editing these lists during the update is not recommended. Instead, you can make these changes either on deactivated MQ Agent instances, or on running agent instances that have a discovery collection frequency of five minutes or higher.

a Click the Edit button to the right of Channel List.

b In the dialog box that opens, click Add Row to add an entry.

For each row, define the following values:

Note If auto-discovery is enabled, the queue and channel lists are automatically populated.

Channel Name: Type the name of this channel.

Monitor: Select the check box to enable the monitoring of the channel, or clear the check box to disable monitoring.

c Save your changes to the channel list by clicking Save Changes in the dialog box.

The dialog box closes.

7 Repeat step 5 and step 6 to create as many channel lists as necessary.

Note You must add a channel list for each MQ Agent instance.

8 Ensure that temporary objects are ignored during monitoring.

In the Exclude Objects Regex box, type a regular expression that selects temporary objects.

Use this property to specify a regular expression that selects temporary objects. The MQ Agent ignores any queue or channel objects whose names match the regular expression during auto-discovery.

In the regular expression “\.”, the backslash “\” is the escape character, and the period “.” matches any single character. Additionally, “.*” matches any strings, while the pipe character “|” is a separator.

The expression should follow the syntax for Java regular expressions. For more information about this syntax, see the Foglight Command-Line Reference Guide. The default expression, AMQ\..*|MQMON\..*|CSQ\..*, matches any objects whose names start with AMQ., MQMON., or CSQ..

For example:

To expand the expression to select objects whose names start with TEMP., edit the expression as follows:

AMQ\..*|MQMON\..*|CSQ\..*|TEMP\..*

To monitor only objects whose names start with QUEST (that is, to exclude all objects not beginning with QUEST):

a Deactivate the MQ Agent.

b Set the Exclude Objects Regex value to: ^(?!QUEST).* and save your changes.

c Clear the queue and the channel list.

d Start the MQ Agent.

9 In the display area, click Save.

Page 22: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 22Chapter 2—Setting MQ Agent Properties

10 To set the performance, channel, queue manager, and configuration events, see Setting the Event Properties.

Otherwise, click Back to Agent Status and activate the MQ Agent, as described in “Activating MQ Agent Instances and Starting Data Collection” on page 30.

Setting the Event PropertiesUse the Event Settings agent properties for an MQ Agent to configure the monitoring of the following event types:

• Performance Events

• Channel Events

• Queue Manager Events

Performance Events

To set performance event properties:

Note This procedure continues from “To modify agent properties:” on page 14.

1 Locate the Event Settings properties.

2 Select the Performance Events option: True or False.

Select True if you want the MQ Agent to monitor performance events. Otherwise, select False.

3 Select the Consume Performance Event Message option: True or False.

Note This agent property requires a get permission on this queue. This permission is set on the IBM WebSphere MQ Server.

• Select True if you want the MQ Agent to remove performance events from the SYSTEM.ADMIN.PERFM.EVENT queue as they are read.

or

• Select False if you want the MQ Agent to retain performance events in the SYSTEM.ADMIN.PERFM.EVENT queue as they are read.

When this option is set to False, the MQ Agent does not consume any events in event queues. With no other means to remove event messages from the event queues, the event queues become full, and the corresponding event collection does not work.

4 Click Performance Event List, and select the performance event list that you want to use.

5 Optional — Clone the selected performance event list.

a Click the Clone button to the right of Performance Event List.

b In the dialog box that opens, type a name for the cloned list.

6 Update the performance event list.

a Click the Edit button to the right of Performance Event List.

Page 23: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 23Chapter 2—Setting MQ Agent Properties

A dialog box opens, listing the available performance events, and indicating if they are enabled. The MQ Agent includes the following performance events:

b In the dialog box, click Add Row to add an entry.

For each row, define the following values:

Performance Event: Type the name of the performance event.

Monitor: Select the check box to enable the monitoring of this event, or clear the check box to disable monitoring.

c Click Save Changes in the dialog box. The dialog box closes.

7 In the display area, click Save.

Channel Events

To set channel event properties:

Note This procedure continues from “To modify agent properties:” on page 14.

1 Locate the Event Settings properties.

2 Select the Channel Events option: True or False.

• Select True if you want the MQ Agent to monitor channel events. Otherwise, select False.

3 Select the Consume Channel Event Message option: True or False.

Note This agent property requires a get permission on this queue. This permission is set on the IBM WebSphere MQ Server.

• Select True if you want the MQ Agent to remove channel events from the SYSTEM.ADMIN.CHANNEL.EVENT queue as they are read.

or

• Select False if you want the MQ Agent to retain channel events in the SYSTEM.ADMIN.CHANNEL.EVENT queue as they are read.

Performance Event Description

Queue Depth High The queue depth is incremented to or above the specified limit.

Queue Depth Low The queue depth is decremented to or below the specified limit.

Queue Depth Full The queue contains the maximum number of messages.

Queue Service Interval High

No successful get operations or MQPUT calls have been detected within an interval greater than the specified limit.

Queue Service Interval OK A successful get operation has been detected within an interval less than or equal to the specified limit.

Page 24: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 24Chapter 2—Setting MQ Agent Properties

When this option is set to False, the MQ Agent does not consume any events in event queues. With no other means to remove event messages from the event queues, the event queues become full, and the corresponding event collection does not work.

4 Click Channel Event List, and select the channel event list that you want to use.

5 Optional — Clone the selected channel event list.

a Click the Clone button to the right of Channel Event List.

b In the dialog box that opens, type a name for the cloned list.

6 Update the newly-selected channel event list.

a Click the Edit button to the right of Channel Event List.

A dialog box opens, listing the available channel events, and indicating if they are enabled. The MQ Agent includes the following channel events:

b In the dialog box, click Add Row to add an entry.

For each row, define the following values:

Channel Event Description

Bridge Started (z/OS only) The IMS bridge is started.

Bridge Stopped (z/OS only) The IMS bridge is stopped.

Channel Activated A channel that is waiting to become active, and for which a Channel Not Activated event is generated, can become active, because an active slot has been released by another channel.

Channel Auto Definition Error The automatic definition of a channel failed.

Channel Auto Definition OK The automatic definition of a channel is successful.

Channel Conversion Error A channel is unable to carry out data conversion.

Channel Not Activated A channel is required to become active, either because it is starting, or because it is about to make another attempt to establish connection with its partner. However, the limit on the number of active channels is reached, which prevents the channel from becoming activated.

Channel SSL Error A channel using Secure Sockets Layer (SSL) or Transport Layer Security (TLS) fails to establish a connection.

Channel Started Either an operator issued a Start Channel command, or a channel is successfully established.

Channel Stopped A channel is stopped.

Channel Stopped By User A channel is stopped when a user issues a STOP CHL command.

Page 25: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 25Chapter 2—Setting MQ Agent Properties

Channel Event: Type the name of the channel event.

Monitor: Select the check box to enable the monitoring of this event, or clear the check box to disable monitoring.

c Click Save Changes in the dialog box.

The dialog box closes.

7 In the display area, click Save.

Queue Manager Events

To set queue manager event properties:

Note This procedure continues from “To modify agent properties:” on page 14.

1 Locate the Event Settings properties.

2 Select the Queue Manager Events option: True or False.

• Select True if you want the MQ Agent to monitor queue manager events. Otherwise, select False.

3 Select the Consume Queue Manager Event Message option: True or False.

Note This agent property requires a get permission on this queue. This permission is set on the IBM WebSphere MQ Server.

• Select True if you want the MQ Agent to remove events from the SYSTEM.ADMIN.QMGR.EVENT queue as they are read.

or

• Select False if you want the MQ Agent to retain queue manager events in the SYSTEM.ADMIN.QMGR.EVENT queue as they are read.

When this option is set to False, the MQ Agent does not consume any events in event queues. With no other means to remove event messages from the event queues, the event queues become full, and the corresponding event collection does not work.

4 Select the queue manager event list that you want to use from the Queue Manager Event List.

5 Optional — Clone the selected queue manager event list.

a Click the Clone button to the right of Queue Manager Event List.

b In the dialog box that opens, type a name for the cloned list.

6 Update the cloned list.

a Click the Edit button to the right of Queue Manager Event List.

Page 26: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 26Chapter 2—Setting MQ Agent Properties

A dialog box opens, listing the available queue manager events, and indicating if they are enabled. The MQ Agent includes the following queue manager events:

Queue Manager Event Description

Alias Base Queue Type Error The specified alias queue is not a local queue, or in a local definition of a remote queue.

Default Transmission Queue Type Error

The specified remote queue cannot be found on the destination queue manager, so the local queue manager attempted to use the default transmission queue. However, although there is a queue defined by the DefXmitQName queue-manager attribute, it is not a local queue.

Default Transmission Queue Usage Error

The specified remote queue cannot be found on the destination queue manager, so the local queue manager attempted to use the default transmission queue. However, the queue defined by the DefXmitQName queue-manager attribute does not have a Usage attribute of MQUS_TRANSMISSION.

Get Inhibited MQGET calls are currently inhibited for the queue.

Not Authorized Indicates unauthorized access to application resources, such as an application trying to open a queue for which it does not have the required authority, or a command being issued from a user ID that does not have the required authority.

Put Inhibited MQPUT and MQPUT1 calls are currently inhibited for the queue.

Queue Manager Active A queue manager became active.

Queue Manager Not Active A queue manager was requested to stop.

Queue Type Error The ObjectQMgrName field specifies the local definition of a remote queue (in order to specify a queue-manager alias). In that local definition, the RemoteQMgrName attribute is the name of the local queue manager. However, the ObjectName field specifies the name of a model queue on the local queue manager.

Remote Queue Name Error A local definition of a remote queue (or an alias to one) was specified, but the RemoteQName attribute in the remote queue definition is blank, or the ObjectQMgrName field in the object descriptor is not blank and does not contain the name of the local queue manager, but the ObjectName field is blank.

Transmission Queue Type Error

The ObjectName or ObjectQMgrName field in the object descriptor specifies the name of a local definition of a remote queue but either XmitQName is not blank and specifies a remote queue, or it is blank and RemoteQMgrName specifies a remote queue.

Page 27: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 27Chapter 2—Setting MQ Agent Properties

b In the dialog box, click Add Row to add an entry.

For each row, define the following values:

Queue Manager Event: Type the name of the queue manager event.

Monitor: Select the check box to enable the monitoring of this event, or clear the check box to disable monitoring.

c Click Save Changes in the dialog box. The dialog box closes.

7 In the display area, click Save.

8 To set the agent manager statistic event options, see Setting the Statistics Events Properties.

Otherwise, click Back to Agent Status and activate the MQ Agent, as described in “Activating MQ Agent Instances and Starting Data Collection” on page 30.

Transmission Queue Usage Error

A message is to be sent to a remote queue manager, but one of the following occurred:• ObjectQMgrName specifies the name of a local queue, but it

does not have a Usage attribute of MQUS_TRANSMISSION.• ObjectName or ObjectQMgrName in the object descriptor

specifies the name of a local definition of a remote queue and either XmitQName is not blank but specifies a queue that does not have a Usage attribute of MQUS_TRANSMISSION, or XmitQName is blank and RemoteQMgrName specifies a queue that does not have a Usage attribute of MQUS_TRANSMISSION.

• The queue name is resolved through a cell directory, and the remote queue manager name obtained from the cell directory is the name of a local queue, but it does not have a Usage attribute of MQUS_TRANSMISSION.

Unknown Alias Base Queue The BaseObjectName in the specified alias queue is not recognized as a queue or topic name.

Unknown Default Transmission Queue

The specified remote queue cannot be found on the destination queue manager, so the local queue manager attempted to use the default transmission queue. However, the queue defined by the DefXmitQName queue-manager attribute is not the name of a locally-defined queue.

Unknown Object Name The ObjectName in the object descriptor is not recognized as the specified object type.

Unknown Remote Queue Manager

Placing a message on a remote queue failed due to an unresolved queue name.

Unknown Transmission Queue

Placing a message on a remote queue failed due to an unresolved queue name. The XmitQName attribute of the definition is not blank and not the name of a locally-defined queue.

Queue Manager Event Description

Page 28: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 28Chapter 2—Setting MQ Agent Properties

Setting the Statistics Events PropertiesUse the Statistics Events agent property to set the statistics events and reset the queue.

To set the statistics events property:

Note This procedure continues from “To modify agent properties:” on page 14.

1 Locate the Statistics Events property.

2 Select the Consume Statistics Event Message option: True or False.

Note This agent property requires a get permission on this queue. This permission is set on the IBM WebSphere MQ Server.

• Select True if you want the MQ Agent to remove statistics events from the SYSTEM.ADMIN.STATISTICS.EVENT queue as they are read.

or

• Select False if you want the MQ Agent to retain statistics events in the SYSTEM.ADMIN.STATISTICS.EVENT queue as they are read.

When this option is set to False, the MQ Agent does not consume any statistic messages in event queues. With no other means to remove event messages from the event queues, the event queues become full, and the corresponding event collection does not work.

3 Click Save.

4 To set the agent monitoring of listeners, see Setting the Listener Monitoring Property.

Otherwise, click Back to Agent Status and activate the MQ Agent, as described in “Activating MQ Agent Instances and Starting Data Collection” on page 30.

Setting the Listener Monitoring PropertyUse the Miscellaneous agent properties to set the monitoring of the listeners.

Important The MQ Agent can discover and monitor listener processes. However, no dashboards are currently available to view this data.

To set miscellaneous properties:

Note This procedure continues from “To modify agent properties:” on page 14.

1 Locate the Miscellaneous property.

2 Select the Monitor Listeners option: True or False.

• Select True to enable the monitoring of the listeners. Otherwise, select False.

3 Click Save.

4 To set the batch query size and frequency, see Setting the Advanced (Batch) Properties.

Otherwise, return to the Agent Status page and activate the MQ Agent, as described in “Activating MQ Agent Instances and Starting Data Collection” on page 30.

Page 29: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 29Chapter 2—Setting MQ Agent Properties

Setting the Advanced (Batch) PropertiesUse the Advanced Settings agent properties to specify the rate at which the MQ Agent polls the MQ Server, and the size of the batch it reads.

To set the advanced (batch) settings properties:

Note This procedure continues from “To modify agent properties:” on page 14.

1 Locate the Advanced Settings properties.

2 In the Batch Inquiry Delay Interval (milliseconds) box, type a value for the amount of time the MQ Agent should wait between successive queries of the MQ Server. The default value is 300 milliseconds (five minutes).

3 In the Batch Inquiry Size (Queues, Channels) box, type a value for the number of objects to query at one time. The default is ten.

4 Click Save.

5 To set the sample frequency for data collection, see Setting the Data Collection Scheduler Property.

Otherwise, click Back to Agent Status and activate the MQ Agent, as described in “Activating MQ Agent Instances and Starting Data Collection” on page 30.

Setting the Data Collection Scheduler PropertyUse the Data Collection Scheduler agent property to adjust how frequently certain collections are performed.

To set data collection scheduler property:

Note This procedure continues from “To modify agent properties:” on page 14.

1 Locate the Data Collection Scheduler properties.

2 Select the collection configuration list that you want to use from the Collector Config list.

3 Update the selected collection configuration list.

When auto-discovery is enabled, the MQ Agent needs some time to update the queue and channel lists. Changing the auto-discovery or editing these lists during the update is not recommended. Instead, you can make these changes either on deactivated MQ Agent instances, or on running agent instances that have a discovery collection frequency of five minutes or more.

a Click the Edit button to the right of Collector Config. A dialog box opens.

b Edit the entries in the list, as required.

To edit a value in the table, double-click the table cell, and type the required value. Each row must have the following values defined:

Page 30: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 30Chapter 2—Setting MQ Agent Properties

Collector Name. Contains the name of the collector. Collector names are predefined by the MQ Agent and should not be changed.

Caution Changing the collector name can lead to unpredictable results.

Default Collection Interval. Type the length of the default collection interval.

Caution This interval should coincide with the statistics interval defined on the queue manager that your agent is monitoring, set on the IBM WebSphere MQ Server.

Time Unit. Type the time unit for measuring the default collection interval: milliseconds, seconds, minutes, hours, or days.

Fast-Mode Collection Interval, Fast-Mode Time Unit, and Fast-Mode Max Count. These values are related to the operation in fast mode that is currently not supported by the cartridge. Therefore, leave these fields blank.

c Click Save Changes in the dialog box. The dialog box closes.

4 In the display area, click Save.

Click Back to Agent Status and activate the MQ Agent, as described in “Activating MQ Agent Instances and Starting Data Collection” on page 30.

Activating MQ Agent Instances and Starting Data CollectionActivating an MQ Agent instance starts the agent process on the monitored host. Starting the data collection for an agent instance means that the agent starts collecting data from the monitored host and sending it to Foglight.

The following procedure describes the process of activating MQ Agent instances and starting their data collection using the Agent Status dashboard in the Foglight browser interface. Another way to activate the agent is through the fglcmd command-line interface. For more information about the available fglcmd commands, see the Command-Line Reference Guide.

To activate and start data collection for an MQ Agent instance:

1 On the Agent Status dashboard, select the inactive agent instance, and click Activate.

The Agent Operation dialog box opens, showing the status of the activation process. A green check mark in the Status column indicates a successful activation.

Tip If agent activation is not successful, there are several ways you can troubleshoot the failure. For example, review the MQ Agent logs, which contain messages about typical configuration problems. For more information, see the online help for the Agent Status dashboard.

2 In the Agent Operation dialog box, click OK.

The Agent Operation dialog box closes and the Agent Status dashboard refreshes. The

Activated and Collecting Data icons in the MQ Agent row indicate that the agent activation was successful.

Page 31: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 31

Index

Aabout installing and configuring 6activating MQAgent instances 30Administration module 11, 12Agent Hosts dashboard 11Agent Operation dialog box 30agent properties

channel events 23connection 15data collection 29discovery 18event settings 22identity 15listeners 28miscellaneous 28monitor lists 19performance events 22queue manager events 25SSL 17statistics events 28

Agent Status dashboard 11, 12, 30Agent Operation dialog box 30Create Agent dialog box 12Create Agent Results dialog box 12Deploy Agent Package dialog box 11

Agent Status node in navigation panel 11, 12Agents dashboards

Agent Hosts 11Agent Status 11, 12, 30

Agent Operation dialog box 30Create Agent dialog box 12Create Agent Results dialog box 12Deploy Agent Package dialog box 11

Agents node in navigation panel 11, 12application objects 9

Bbindings mode 6

Ccartridge 10Cartridge for IBM Websphere MQ Server

about 6configuring 6installing 6

channel eventsMQAgent properties 23

configuringauthorization 8cartridge 6Cartridge for IBM WebSphere MQ 10events 7monitored events 7MQ Object authorization 8MQAgent properties 13online monitoring 8queue manager 7, 8, 9queue managers for monitoring 7queue statistics 8

connectionMQAgent properties 15

Create Agent dialog box 12Create Agent Results dialog box 12creating MQAgent instances 11

Ddashboards

Agent Hosts 11Agent Status 11, 12, 30

Agent Operation dialog box 30Create Agent dialog box 12Create Agent Results dialog box 12Deploy Agent Package dialog box 11

data collectionMQAgent properties 29

Deploy Agent Package dialog box 11deploying MQAgent packages to monitored hosts 10deployment 6

Page 32: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 32Index

dialog boxesAgent Operation 30Create Agent 12Create Agent Results 12Deploy Agent Package 11

discoveryMQAgent properties 18

Eenabling

events 7enabling cartridge 10event settings

MQAgent properties 22events

authority 7channel 7channel auto definition 7inhibit 7local 7performance 7SSL 7start stop 7

exclude objects regex 21

Hhow to

activateMQAgent instances 30

createMQAgent instances 12

deployMQAgent packages 11

start data collectionfor MQAgent instances 30

Iidentity

MQAgent properties 15installing 6, 10installing and configuring

about 6installing and configuring the Cartridge for IBM WebSphere

MQactivating MQAgent instances 30configuring MQAgent properties 13

configuring queue managers for monitoring 7creating MQAgent instances 11deploying MQAgent packages to monitored hosts 10starting MQAgent data collection 30

Llisteners

MQAgent properties 28local monitoring 6

MMCA, see Message Channel Agent 8message age metric 8Message Channel Agent (MCA) 8miscellaneous

MQAgent properties 28modules in navigation panel

Administration 11, 12monitor lists

MQAgent properties 19monitoring

local 6remote 6system objects 9

MQ Object authorizationauthorization 8

MQAgentagent properties

channel events 23connection 15data collection 29discovery 18event settings 22identity 15listeners 28miscellaneous 28monitor lists 19performance events 22queue manager events 25SSL 17statistics events 28

Nnodes in navigation panel

Agent Status 11, 12Agents 11, 12

Page 33: Cartridge for IBM WebSphere MQ Server Installation Guidesupport-public.cfm.quest.com/00-717bd57e-14e6-4fb3-a5ad-c9aefb2c… · The information in this document is provided in connection

Foglight Cartridge for IBM WebSphere MQ Server Installation and Configuration Guide 33Index

Oobjects

exclude 21oldest message age metric 8online monitoring 8

Pperformance events

MQAgent properties 22permissions 9

Qqueue

application 9manager, configuring 8monitoring 8properties 8statistics 8

queue manager eventsMQAgent properties 25

Rregex 21remote monitoring 6rule

queue monitoring 8

Ssetmqaut 8SSL

MQAgent properties 17starting

Foglight Agent Manager 8starting MQAgent data collection 30statistics 8statistics events

MQAgent properties 28statistics interval 8support 5system objects 9

Ttechnical support 5

Uuser-defined objects 9


Recommended