Overview
Setup
Metrics
Alerts IBM MQ Plugin: ibm.d.plugin
Module: mq
Overview Monitors IBM MQ queue managers, queues, channels, and topics
using the PCF (Programmable Command Format) protocol.
By default the collector tracks the critical system queues SYSTEM.DEAD.LETTER.QUEUE,
SYSTEM.ADMIN.COMMAND.QUEUE, and SYSTEM.ADMIN.STATISTICS.QUEUE. All other queues are
opt-in via the include_queues list, with exclude_queues removing noisy patterns such as
SYSTEM.* or AMQ.*. Include patterns take precedence over excludes so you can safely
monitor individual system queues while dropping the broader wildcard.
Per-queue charts are bounded by max_queues (default 50). When more queues are discovered,
the collector exports the busiest ones individually, rolls the remainder into an
aggregated __other__ dimension, and logs a throttled warning listing the overflowed
groups. Parallel queue-group charts summarise depth, traffic, and backlog per naming
prefix (first two dot-separated segments, collapsing all SYSTEM.* queues together), so
high-level visibility is never lost even when detailed charts are trimmed.
The collector connects to IBM MQ and collects metrics via its monitoring interface.
This collector is supported on all platforms.
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
Default Behavior Auto-Detection This integration doesn’t support auto-detection.
Limits The default configuration for this integration does not impose any limits on data collection.
The default configuration for this integration is not expected to impose a significant performance impact on the system.
Setup Prerequisites Enable monitoring interface Ensure the IBM MQ monitoring interface is accessible.
Configuration Options Configuration options for the mq collector.
Option Description Default Required update_every Data collection frequency. 1 no endpoint Connection endpoint. dummy://localhost no
via File The configuration file name for this integration is ibm.d/mq.conf.
You can edit the configuration file using the edit-configconfig directory .
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config ibm.d/mq.conf
Examples Basic Basic configuration example.
jobs :
- name : local
endpoint : dummy://localhost
Metrics Metrics grouped by scope .
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
Per channel These metrics refer to channel instances.
Labels:
Label Description channel Channel identifier type Type identifier
Metrics:
Metric Dimensions Unit mq.channel.status inactive, binding, starting, running, stopping, retrying, stopped, requesting, paused, disconnected, initializing, switching status mq.channel.messages messages messages/s mq.channel.bytes bytes bytes/s mq.channel.batches batches batches/s mq.channel.batch_size batch_size messages mq.channel.batch_interval batch_interval milliseconds mq.channel.intervals disc_interval, hb_interval, keep_alive_interval seconds mq.channel.short_retry_count short_retry retries mq.channel.long_retry_interval long_retry seconds mq.channel.max_msg_length max_msg_length bytes mq.channel.sharing_conversations sharing_conversations conversations mq.channel.network_priority network_priority priority mq.channel.buffer_counts sent, received buffers mq.channel.current_messages current messages mq.channel.xmitq_time xmitq_time milliseconds mq.channel.mca_status mca_status status mq.channel.indoubt_status indoubt_status status mq.channel.ssl_key_resets ssl_key_resets resets mq.channel.npm_speed npm_speed speed mq.channel.current_sharing_convs current_sharing conversations
Per channelstatistics These metrics refer to channelstatistics instances.
Labels:
Label Description channel Channel identifier type Type identifier
Metrics:
Metric Dimensions Unit mq.channel_stats.messages messages messages/s mq.channel_stats.bytes bytes bytes/s mq.channel_stats.batches full_batches, incomplete_batches batches/s mq.channel_stats.batch_size avg_batch_size messages mq.channel_stats.put_retries put_retries retries/s
Per listener These metrics refer to listener instances.
Labels:
Label Description listener Listener identifier port Port identifier ip_address Ip_address identifier
Metrics:
Metric Dimensions Unit mq.listener.status stopped, starting, running, stopping, retrying status mq.listener.backlog backlog connections mq.listener.uptime uptime seconds
Per mqistatistics These metrics refer to mqistatistics instances.
Labels:
Label Description queue_manager Queue_manager identifier
Metrics:
Metric Dimensions Unit mq.mqi_stats.opens opens_total, opens_failed operations/s mq.mqi_stats.closes closes_total, closes_failed operations/s mq.mqi_stats.inqs inqs_total, inqs_failed operations/s mq.mqi_stats.sets sets_total, sets_failed operations/s
Per queue These metrics refer to queue instances.
Labels:
Label Description queue Queue identifier type Type identifier
Metrics:
Metric Dimensions Unit mq.queue.depth current, max messages mq.queue.depth_percentage percentage percentage mq.queue.messages enqueued, dequeued messages/s mq.queue.connections input, output connections mq.queue.high_depth high_depth messages mq.queue.uncommitted_msgs uncommitted messages mq.queue.file_size current, max bytes mq.queue.last_activity since_last_get, since_last_put seconds mq.queue.oldest_msg_age oldest_msg_age seconds mq.queue.time_indicators short_period, long_period microseconds mq.queue.service_interval service_interval milliseconds mq.queue.inhibit_status inhibit_get, inhibit_put status mq.queue.priority def_priority priority mq.queue.message_persistence persistent, non_persistent boolean mq.queue.retention_interval retention_interval hours mq.queue.triggers trigger_depth, trigger_type messages mq.queue.backout_threshold backout_threshold retries mq.queue.max_msg_length max_msg_length bytes mq.queue.scope queue_manager, cell boolean mq.queue.usage normal, transmission boolean mq.queue.msg_delivery_sequence priority, fifo boolean mq.queue.harden_get_backout enabled, disabled boolean
Per queuegroup These metrics refer to queuegroup instances.
Labels:
Label Description group Group identifier
Metrics:
Metric Dimensions Unit mq.queue_group.depth current, max messages mq.queue_group.depth_percentage percentage percentage mq.queue_group.messages enqueued, dequeued messages/s mq.queue_group.connections input, output connections mq.queue_group.uncommitted_msgs uncommitted messages mq.queue_group.file_size current, max bytes mq.queue_group.oldest_msg_age oldest_msg_age seconds
Per IBM MQ instance These metrics refer to the entire monitored instance.
This scope has no labels.
Metrics:
Metric Dimensions Unit mq.qmgr.status status status mq.qmgr.connection_count connections connections mq.qmgr.uptime uptime seconds mq.queues.overview monitored, excluded, invisible, failed queues mq.channels.overview monitored, excluded, invisible, failed channels mq.topics.overview monitored, excluded, invisible, failed topics mq.listeners.overview monitored, excluded, invisible, failed listeners
Per IBM MQ instance These metrics refer to the entire monitored instance.
This scope has no labels.
Metrics:
Metric Dimensions Unit mq.qmgr.cpu_usage user, system percentage mq.qmgr.memory_usage total bytes mq.qmgr.ram_usage total bytes mq.qmgr.log_utilization used percentage mq.qmgr.log_file_size size bytes mq.qmgr.log_write_rate rate bytes/s
Per queuestatistics These metrics refer to queuestatistics instances.
Labels:
Label Description queue Queue identifier type Type identifier
Metrics:
Metric Dimensions Unit mq.queue_stats.depth_min_max min_depth, max_depth messages mq.queue_stats.avg_queue_time non_persistent, persistent microseconds mq.queue_stats.time_indicators short_period, long_period microseconds mq.queue_stats.operations puts_non_persistent, puts_persistent, gets_non_persistent, gets_persistent, put1s, browses operations/s mq.queue_stats.bytes put_bytes_non_persistent, put_bytes_persistent, get_bytes_non_persistent, get_bytes_persistent, browse_bytes bytes/s mq.queue_stats.failures puts_failed, put1s_failed, gets_failed, browses_failed failures/s mq.queue_stats.message_lifecycle expired, purged, not_queued messages/s
Per subscription These metrics refer to subscription instances.
Labels:
Label Description subscription Subscription identifier topic Topic identifier
Metrics:
Metric Dimensions Unit mq.subscription.messages pending messages mq.subscription.last_message_age age seconds
Per topic These metrics refer to topic instances.
Labels:
Label Description topic Topic identifier
Metrics:
Metric Dimensions Unit mq.topic.publishers publishers publishers mq.topic.subscribers subscribers subscribers mq.topic.messages messages messages/s mq.topic.time_since_last_message time_since_last_msg seconds
Alerts There are no alerts configured by default for this integration.
