WebSphere MQ Channels Test

This test connects to a WebSphere MQ server, auto-discovers the channels that have been configured for this server, and monitors the status of each of these channels.

Target of the test : A WebSphere MQ server

Agent deploying the test : An internal agent

Outputs of the test : One set of results for every channel configured for the WebSphere MQ server.

Configurable parameters for the test
Parameter	Description
Test period	How often should the test be executed.
Host	The host for which the test is to be configured.
Port	The port number at which the specified host listens.
User	If you want to login as a specific MQ user to execute this test, then specify a valid user name in the User text box. The test will fail if an invalid user name is specified here. If no such authentication is required, then this parameter can be set to 'none'. If the user belongs to an Active Directory group, then, specify the user name in the following format: <username>@<domain name>. For example, if the user belongs to eginnovations/john, then, your specification should be: john@eginnovations.com.
Password	If a specific User is entered, then the password of that user has to be specified in the Password text box.
Confirm Password	Confirm the password by retyping it in the Confirm Password text box.
ServerConnChannel	The name of the server connection channel for the WebSphere MQ server. The default value is "SYSTEM.DEF.SVRCONN". If you prefer not to use this default server connection channel for monitoring purposes, then you can create a custom channel in the WebSphere MQ server and use it for monitoring. The steps for achieving this have been detailed in Creating a Custom Channel topic.
SSL Cipher Spec	This parameter is applicable only if SSL-enabled channel is used for communication to the target MQ server, if not, set this parameter to none. A cipher suite is a set of cryptographic algorithms that are used before a client application and server exchange information over an SSL/TLS connection. It consist of sets of instructions on how to secure a network through SSL (Secure Sockets Layer) or TLS (Transport Layer Security). In this text box, provide the cipher suite that is allowed for SSL/TLS connection to the target server. By default, this parameter is set to none. To know if SSL-enabled channel is used for communication, refer to Enabling One-Way SSL Communication on the Channel Enabling One-Way SSL Communication on the Channel topic.
Two Way SSL	This parameter is applicable only if SSL-enabled channel is used for communication to the target MQ server, if not, set this flag to No. If two-way SSL authentication is used then set this flag to Yes. Set this flag to No if one-wy SSL communication is used.
Truststore	This parameter is applicable only if SSL-enabled channel is used for communication to the target MQ server, if not, set this parameter to none. Truststore is used to store certificates from Certified Authorities (CA) that verify and authenticate the certificate presented by the server in an SSL connection. Therefore, the eG agent should have access to the truststore where the certificates are stored to authenticate and connect with the target server and collect metrics. For this, first extract the certificates from the server into the following default location /opt/egurkha/jre/lib/security/egmqsslstore.jks. To know how to create and extract the certificate into the truststore, refer to Configuring the eG Agent to Monitor the Queue Manager. Then, provide the truststore file name in this text box. For example: egmqsslstore.jks. However, if you are using a different location to store the certificate then, provide the full path to this file in this text box. By default, none is specified against this text box.
Truststore Password	This parameter is applicable only if SSL-enabled channel is used for communication to the target MQ server, if not, set this parameter to none. If a Truststore File name or file path is provided, then, in this text box, provide the password that is used to obtain the associated certificate details from the Truststore File.
Confirm Password	This parameter is applicable only if SSL-enabled channel is used for communication to the target MQ server, if not, set this parameter to none. Confirm the password by retyping it in this text box.
Keystore	This parameter is applicable only if two-way SSL authentication is used, if not, set this parameter to none. Keystore contains the private keys for the certificates that the client can provide to the server upon request. eG agent requires access to the keystore where client certificate is stored to send that to the server so that the server validates the certificate against the one contained in its trustore. For this purpose, first create the client certificate in the following default location /opt/egurkha/jre/lib/security/egmqsslstore.jks. To know how to create the certificate, refer to Configuring the eG Agent to Monitor the Queue Manager. Then, provide the keystore file name in this text box. For example:egmqsslstore.jks. However, if you are using a different location to store the certificate then, provide the full path to this file in this text box. By default, none is specified against this text box. If you are using one-way SSL authentication, this parameter is set to none.
Keystore Password	This parameter is applicable only if two-way SSL authentication is used, if not, set this parameter to none. If a Keystore File name or file path is provided, then, in this text box, provide the password that is used to obtain the associated certificate details from the Keystore File.
Confirm Password	This parameter is applicable only if two-way SSL authentication is used, if not, set this parameter to none. Confirm the password by retyping it in this text box.
IgnoreSystemChannels	If SYSTEM channels are to be monitored, then set this flag to No. If not, set the flag to Yes.
IncludeChannels	Specify a comma-separated list of channel names or channel name patterns to be monitored. For example, your specification can be: .EG.,CLNT.JPM.,.CSI.SVRCONN. In this case, the test will monitor only those channels with names that embed the string “.EG.”, names that start with “CLNT.JPM”, and names that end with “.CSI.SVRCONN”. Note: If a SYSTEM channel or a pattern that matches a SYSTEM channel is configured in the include channels text box, then this test will monitor such SYSTEM channels, even if the IgnoreSystemChannels flag is set to Yes.
MQVersion	Specify the version the WebSphere MQ server that is being monitored. For instance, 6 or 7.
ShowInactiveChannels	Indicate whether the inactive channels are to be monitored or not using this flag. If you prefer to monitor the inactive channels, then set this flag to Yes. If not, set this flag to No. By default, this flag is set to No.
ExcludeChannels	Specify the comma-separated list of inactive channels that are to be excluded for monitoring in the ExcludeChannels text box. By default, the value of this parameter is none.
Detailed Diagnosis	To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option. The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled: The eG manager license should allow the detailed diagnosis capability Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.

Measurements made by the test

Measurement

Description

Measurement Unit

Interpretation

Channel status

Indicates the current status of this channel.

The table below indicates the values that this measure can report and their corresponding numeric equivalents:

Measure Value	Numeric Value
Running	0
Requesting	1
Binding	2
Starting	3
Initializing	4
Inactive	5
Paused	6
Retrying	7
Stopping	8
Stopped	9

Note:

By default, this measure reports the above-mentioned Measure Values while indicating the current status of each channel. However, in the graph of this measure, the status of the channels will be represented using the corresponding numeric equivalents as mentioned in the table above.

MQ channel availability

Reports the current availability of this channel.

Percent

A value of 100% signifies that the channel is available for clients to connect to. A value of 0% indicates channel unavailability.

Current messages

The number of messages being currently handled by this channel.

Number

A continuous increase of this value signifies that the receiver is not able to cope up with the incoming traffic.

Messages handled

The number of messages that transmitted through the channel during the last measurement period

Number

Buffers received

The number of buffers of data received over this channel during the last measurement period.

Number

This metric indicates the workload over a channel.

Buffers sent

Indicates the number of buffers of data transmitted over this channel during the last measurement period.

Number

This metric indicates the workload over a channel.

Data received

Indicates the rate at which data is received over this channel during the last measurement period

KB/Sec

Data transmitted

Indicates the rate at which data is transmitted over this channel during the last measurement period

KB/Sec

Time since last message

Reflects the time that has elapsed since the last message was transmitted over this channel.

Secs

If an unusually long time has elapsed since when the last message was transmitted, it could reflect an error in the application (e.g., a hung application that is no longer transmitting messages over the channel).

Note:

To enable the eG agent to monitor the IBM MQ server effectively, start the command server for each queue manager that you want the eG agent to monitor. A command server is mandatory for all administration involving PCFs, the MQAI, and also for remote administration. The eG agent’s MQ library is a PCF. So, the command server needs to be started.