IBM MQ
Introduction
IBM MQ provides a universal messaging backbone with robust connectivity for flexible and reliable messaging for applications and the integration of existing IT assets using a service-oriented architecture. It works in multiple modes of operations including point-to-point, publish/subscribe, and file transfer. Applications can also publish messages to many subscribers over multicast.
Getting Started
Compatibility
The IBM Websphere MQ O11ySource is compatible with all versions equal to or greater than 9.3.0.0
Data Collection Method
vuSmartMaps collects health and performance data from IBM MQ using VuNet’s vuAppAgent. This data collector collects data based on the source configuration. IBM MQ logs are collected by VuNet's vuLogAgent agent
Prerequisites
Dependent Configuration
To configure this O11ySource, create a 'credential' of type 'User' under the 'Definition' tab.
Inputs for Configuring Data Source
- InstanceName: Name of the instance.
- IBM Websphere MQ Server: Should be a valid IP Address or FQDN. of IBM MQ server.
- Port: The port which connects to queues and channels of IBM MQ Server.
- ChannelName: The name of the channel that the QManager is listening on.
- IBM Websphere MQ Password: Password of IBM MQ server.
- Period (in seconds): How frequently data is gathered. The period should be between 60 seconds \u2013 3000 seconds.
Logs Collection
- IBM Websphere MQ Error Log Path: Enter the IBM Websphere MQ error logfile's entire path.
Firewall Requirement
To collect data from this O11ySource, ensure the following ports are opened:
| Source IP | Destination IP | Destination Port | Protocol | Direction |
|---|---|---|---|---|
| IP address of the IBM MQ server | Data Collector End Point | 9092* | TCP | Inbound |
*Before providing the firewall requirements, please update the port based on the customer environment.
Configuring the Target
vuAppAgent and vuLogAgent should be running in the server where IBM Websphere is configured.
Configuration Steps
Enablethe IBM MQ O11ySource.- Select the Sources tab and press the
+button to add a new IBM MQ host to be monitored. - Set up metrics and log collection configurations. Afterwards, select
Save and Continueto proceed with downloading the agents. - The following packages will be available for download based on the OS:Download <OS> vuAppAgent Installation Binary - Downloads the full vuAppAgent package with required configurations for a fresh installationDownload <OS> vuAppAgent Update Configuration Binary - Downloads the agent configuration package to update an existing vuAppAgent installationDownload <OS> vuLogAgent Installation Binary - Downloads the full vuLogAgent package with required configurations for a fresh installationDownload <OS> vuLogAgent Update Configuration Binary - Downloads the agent configuration package to update an existing vuLogAgent installation
- Download the agent installation or update package, then click
Finishto close the data source window.
Metrics Collected
| Name | Description | Data Type |
|---|---|---|
| MQIACH_HB_INTERVAL | The heart-beat interval, in seconds, for the channel. | UInt16 |
| MQIA_MONITORING_CHANNEL | The monitoring level of the channel (e.g., off, low, medium, high). | UInt8 |
| target | The target resource or system for the channel communication. | String |
| Time | The recorded time of the event or data collection. | String |
| ChannelStatus | The status of the channel (e.g., running, stopped). | UInt8 |
| MQIACH_STOP_REQUESTED | Indicates whether a stop request has been issued for the channel (1 for yes, 0 for no). | UInt8 |
| MQIACH_EXIT_TIME_INDICATOR | The indicators related to the exit processing time. | Array(UInt8) |
| ConnectionName | The name of the connection used for the channel. | String |
| MQIACH_SECURITY_PROTOCOL | The security protocol used by the channel (e.g., SSL/TLS). | UInt8 |
| MQCACH_MCA_JOB_NAME | The job name of the Message Channel Agent (MCA) associated with the channel. | String |
| ChannelStartTime | The time when the channel was started. | String |
| MQCACH_SSL_CIPHER_SPEC | The SSL cipher specification used for the channel. | String |
| BuffersSent | The total number of data buffers sent over the channel. | UInt32 |
| MQIACH_MAX_SHARING_CONVS | The maximum number of sharing conversations allowed for the channel. | UInt8 |
| DisplayName | A display-friendly name for the channel. | String |
| MQIACH_MCA_STATUS | The status of the MCA associated with the channel. | UInt8 |
| MQIACH_SSL_KEY_RESETS | The number of SSL key resets performed on the channel. | UInt8 |
| MQCACH_LOCAL_ADDRESS | The local IP address or hostname used for the channel connection. | String |
| ChanneSubState | The sub-state of the channel (provides more detailed status). | UInt16 |
| MQIACH_BYTES_RCVD / MQIACH_BYTES_RECEIVED | The total number of bytes received over the channel. | UInt32 |
| MQCACH_SSL_SHORT_PEER_NAME | The short name of the SSL peer certificate used for the channel. | String |
| LastMessageDate | The date of the last message processed by the channel. | Date |
| Messages | The total number of messages transmitted through the channel. | UInt32 |
| QmgrName | The name of the queue manager associated with the channel. | String |
| MQIACH_COMPRESSION_TIME | The time spent in compression processing for the channel. | Array(UInt8) |
| MQCACH_SSL_KEY_RESET_TIME | The time when the last SSL key reset occurred. | String |
| Host | The hostname or IP address of the system where the channel is running. | String |
| MQCACH_MCA_USER_ID | The user ID under which the MCA is running. | String |
| MQCACH_REMOTE_VERSION | The version of the remote MQ system. | String |
| MQIACH_HDR_COMPRESSION | The header compression techniques used on the channel. | Array(UInt8) |
| MQCACH_REMOTE_APPL_TAG | The application tag of the remote application using the channel. | String |
| MQCACH_SSL_CERT_ISSUER_NAME | The name of the issuer of the SSL certificate used by the channel. | String |
| ChannelName | The name of the channel. | String |
| MQCACH_SSL_KEY_RESET_DATE | The date when the last SSL key reset occurred. | String |
| StatisticType | The type of statistics collected for the channel. | String |
| MQIACH_CHANNEL_INSTANCE_TYPE | The type of channel instance (e.g., sender, receiver, server, requester). | UInt16 |
| LastMessageTime | The time of the last message processed by the channel. | String |
| BytesSent | The total number of bytes sent over the channel. | UInt32 |
| MQIACH_BUFFERS_RCVD / MQIACH_BUFFERS_RECEIVED | The total number of data buffers received on the channel. | UInt32 |
| CurrentNoOfCoversations | The current number of conversations active on the channel. | UInt8 |
| MQIACH_MSG_COMPRESSION | The message compression techniques used on the channel. | Array(UInt8) |
| MQIACH_COMPRESSION_RATE | The compression rate achieved on the channel. | Array(UInt8) |
| ChannelType | The type of channel (e.g., 1 for sender, 2 for receiver). | UInt8 |
| ChannelStartDate | The date when the channel was started. | Date |
| MQCACH_REMOTE_PRODUCT | The product identifier of the remote MQ system. | String |
| @timestamp | The timestamp when the event was recorded in string format. | String |
| timestamp | The precise timestamp of the event or record, including milliseconds. | DateTime64 |
| target | The target resource or entity for monitoring (e.g., queue manager name or system). | String |
| QmgrStartTime | The time when the queue manager was started. | String |
| ConnectionCount | The total number of active connections to the queue manager. | UInt32 |
| QmgrName | The name of the queue manager being monitored. | String |
| StatisticType | The type of statistics being collected (e.g., connection stats, performance metrics). | String |
| QmgrStartDate | The date when the queue manager was started. | Date |
| DisplayName | A user-friendly display name for the queue manager or monitored entity. | String |
| Host | The hostname or IP address of the system where the queue manager is running. | String |
| Time | The recorded time of the event or data collection. | String |
| QmgrStatus | The operational status of the queue manager (e.g., 1 for running, 0 for stopped). | UInt8 |
| @timestamp | The timestamp when the event was recorded, in string format. | String |
| timestamp | The precise timestamp of the event or record, including milliseconds. | DateTime64 |
| QueueDepthLowThreshold% | The percentage threshold for low queue depth events. | UInt8 |
| LastAlteredDate | The date when the queue was last modified. | String |
| MQCA_CLUS_CHL_NAME | The name of the cluster channel associated with the queue. | String |
| MQCA_Q_DESC | A description of the queue. | String |
| MQIA_DEF_PUT_RESPONSE_TYPE | The default response type for put operations. | Int8 |
| MQIA_STATISTICS_Q | Indicates whether statistics are collected for the queue. | Int8 |
| QueueType | The type of queue (e.g., local, alias, or remote). | UInt8 |
| MQIA_Q_DEPTH_MAX_EVENT | Indicates if queue depth maximum events are enabled. | UInt8 |
| MQIA_MONITORING_Q | Indicates if queue monitoring is enabled. | Int8 |
| MQIA_Q_DEPTH_HIGH_EVENT | Indicates if queue depth high events are enabled. | UInt8 |
| MQIA_HARDEN_GET_BACKOUT | Specifies whether get-backout is hardened for the queue. | UInt8 |
| MQIA_MSG_DELIVERY_SEQUENCE | The sequence in which messages are delivered. | UInt8 |
| MQIA_TRIGGER_MSG_PRIORITY | The priority of messages that can trigger processing. | UInt8 |
| MQIA_SHAREABILITY | Indicates whether the queue is shareable. | UInt8 |
| MQIA_BACKOUT_THRESHOLD | The backout threshold for the queue. | UInt8 |
| QmgrName | The name of the queue manager associated with the queue. | String |
| MQIA_TRIGGER_TYPE | The type of triggering configured for the queue. | UInt8 |
| MQIA_DEF_READ_AHEAD | Indicates the default read-ahead behavior for non-persistent messages. | UInt8 |
| MQIA_NPM_CLASS | The non-persistent message class for the queue. | UInt8 |
| MQIA_RETENTION_INTERVAL | The interval for retaining messages in the queue. | UInt32 |
| StatisticType | The type of statistics collected for the queue. | String |
| MQIA_INHIBIT_GET | Indicates if GET operations are inhibited for the queue. | UInt8 |
| MQIA_ACCOUNTING_Q | Indicates if accounting data is collected for the queue. | Int8 |
| MQIA_TRIGGER_CONTROL | Specifies whether triggering is enabled or disabled for the queue. | UInt8 |
| target | The target resource associated with the queue. | String |
| MQIA_Q_SERVICE_INTERVAL_EVENT | Indicates if service interval events are enabled for the queue. | UInt8 |
| Time | The recorded time of the event or data collection. | String |
| MQIA_PROPERTY_CONTROL | Controls the handling of message properties for the queue. | UInt8 |
| MQCA_CREATION_TIME | The time when the queue was created. | String |
| MQCA_INITIATION_Q_NAME | The name of the initiation queue for triggering. | String |
| MaxQueueDepth | The maximum depth of the queue. | UInt32 |
| MQCA_PROCESS_NAME | The name of the process associated with triggering. | String |
| MQCA_TRIGGER_DATA | Data associated with the triggering process. | String |
| DisplayName | A display-friendly name for the queue. | String |
| QueueName | The name of the queue. | String |
| MQIA_DEF_PRIORITY | The default priority for messages put to the queue. | UInt8 |
| MQIA_DEF_PERSISTENCE | The default persistence setting for messages. | UInt8 |
| MQIA_Q_DEPTH_LOW_EVENT | Indicates if queue depth low events are enabled. | UInt8 |
| MQIA_TRIGGER_DEPTH | The depth of the queue at which a trigger is generated. | UInt8 |
| MQCA_CREATION_DATE | The date when the queue was created. | String |
| MQIA_USAGE | Specifies the usage type of the queue (e.g., normal, transmission). | UInt8 |
| Host | The hostname or IP address of the system where the queue resides. | String |
| MaxMessageLength | The maximum length of messages that can be stored in the queue. | UInt32 |
| MQCA_BACKOUT_REQ_Q_NAME | The name of the queue where messages are backed out. | String |
| MQIA_DEFINITION_TYPE | Indicates whether the queue is predefined or dynamically defined. | UInt8 |
| MQIA_Q_SERVICE_INTERVAL | The service interval for the queue. | UInt32 |
| MQIA_DEF_INPUT_OPEN_OPTION | The default open option for input operations on the queue. | UInt8 |
| MQIA_INHIBIT_PUT | Indicates if PUT operations are inhibited for the queue. | UInt8 |
| QueueDepthHighThreshold% | The percentage threshold for high queue depth events. | UInt8 |
| LastAlteredTime | The time when the queue was last modified. | String |
| MQCA_CUSTOM | Custom attributes or metadata for the queue. | String |
| MQIA_DIST_LISTS | Indicates if distributed lists are enabled for the queue. | UInt8 |
| CurrentQueueDepth | The current depth of the queue. | UInt32 |
| OldestMessageAge | The age of the oldest message in the queue (in seconds). | Int32 |
| OpenOutputCount | The number of output handles currently open on the queue. | UInt32 |
| OpenInputCount | The number of input handles currently open on the queue. | UInt32 |
| UncommittedMessages | The number of uncommitted messages in the queue. | UInt32 |
| LastPutDate | The date of the last PUT operation on the queue. | String |
| LastPutTime | The time of the last PUT operation on the queue. | String |
| LastGetDate | The date of the last GET operation on the queue. | String |
| LastGetTime | The time of the last GET operation on the queue. | String |
| MQCA_CLUSTER_NAME | The name of the cluster associated with the queue. | String |
| MQCA_CLUSTER_NAMELIST | The name list of clusters associated with the queue. | String |
| MQCACF_MEDIA_LOG_EXTENT_NAME | The name of the media log extent for the queue. | String |
| MQIA_CLWL_Q_PRIORITY | The cluster workload priority of the queue. | UInt64 |
| MQIA_CLWL_Q_RANK | The cluster workload rank of the queue. | UInt64 |
| MQIA_CLWL_USEQ | The usage attribute for cluster workload balancing. | Int64 |
| MQIA_DEF_BIND | The default binding type for the queue (e.g., bind not fixed or bind fixed). | UInt64 |
| MQIACF_Q_STATUS_TYPE | The type of queue status information collected. | UInt64 |
| OnQTime | The time messages have been on the queue (in milliseconds). | Array(Int64) |
| MQIA_SCOPE | The scope of the queue (e.g., local or global). | UInt64 |
| @timestamp | The timestamp when the event or data was recorded. | String |
| DeviceType | The type of device associated with the queue. | String |
| timestamp | The exact timestamp when the event or data was recorded, including milliseconds. | DateTime64 |
| target | The target resource or component associated with the logged event. | String |
| file | The name of the file where the event or log entry was recorded. | String |
| host | The hostname or IP address of the system generating the log. | String |
| type | The type or category of the event or log entry (e.g., error, informational). | String |
| instance | The specific instance of the application or service associated with the event. | String |
| errorCode | The error code associated with the event, if applicable. | String |
| errorCodeDetails | A detailed description or additional information about the error code. | String |
| PIDTID | The Process ID (PID) and Thread ID (TID) of the process generating the log entry. | String |
| ProgramName | The name of the program or application generating the event. | String |
| version | The version of the program or application generating the event. | String |
| hostname | The hostname of the system associated with the event, potentially redundant with host. | String |
| Username | The username associated with the event or action. | String |
| AMPM | Indicates whether the time is in AM or PM format. | String |
| ArithInsert | Additional numeric or arithmetic insert values related to the log entry. | String |
| ActionDetails | Detailed description of the action performed or the event. | String |
| ExplainationDetails | An explanation or additional details about the event or action. | String |
| time | The recorded time of the event, typically in a basic string format. | String |
| @timestamp | A timestamp indicating when the event was recorded, usually in ISO 8601 format. | String |
| timestamp | The precise timestamp of the event, including milliseconds for granularity. | DateTime64 |
| message | The full log message or event description. | String |
| qmgr | The name of the queue manager associated with the event. | String |
