AIX IBM MQ
AIX IBM MQ input collects Queue Manager, queue, channel, listener, and advanced objects through dspmq and runmqsc.
Configuration¶
[inputs]
# Global switch for middleware inputs.
enabled = true
[[inputs.ibm_mq]]
# Instance name, reported as the `instance` tag.
name = "QM1"
# Whether to enable this IBM MQ instance collection.
enabled = true
# Collection interval.
interval = "60s"
# Optional file loaded before collection to set instance environment variables.
env_file = ""
# Whether to collect advanced objects such as cluster, topic, and subscription.
collect_advanced = false
# Optional custom metric command. Each output line should be `key=value`.
deep_metrics_command = ""
# Queue Manager name.
queue_manager = "QM1"
# Queue filter rules.
queue_include = []
queue_exclude = ["SYSTEM.*"]
dead_letter_queue = "SYSTEM.DEAD.LETTER.QUEUE"
# IBM MQ command paths.
dspmq = "dspmq"
runmqsc = "runmqsc"
Command Dependencies¶
| Command | Description |
|---|---|
dspmq -m <QM> |
Collect Queue Manager status. |
runmqsc <QM> |
Collect QMSTATUS, QLOCAL, CHSTATUS, and LSSTATUS. |
runmqsc <QM> advanced commands |
Collect CLUSQMGR, TOPIC, and SUB when collect_advanced = true. |
deep_metrics_command |
Custom command that outputs key=value lines for custom metrics. |
Metrics¶
All metrics append host, input=ibm_mq, and instance=<name> tags.
ibm_mq_qmgr¶
| Tags & Fields | Description |
|---|---|
| queue_manager ( tag) |
Queue Manager name. |
| status ( tag) |
Queue Manager state. |
| up | Whether the Queue Manager is Running. Type: int | (gauge) |
ibm_mq_queue¶
| Tags & Fields | Description |
|---|---|
| queue_manager ( tag) |
Queue Manager name. |
| queue ( tag) |
Queue name. |
| curdepth | Current queue depth. Type: int | (gauge) Unit: count |
| open_input | Input open count. Type: int | (gauge) Unit: count |
| open_output | Output open count. Type: int | (gauge) Unit: count |
| maxdepth | Maximum queue depth. Type: int | (gauge) Unit: count |
| dead_letter_depth | Dead-letter queue depth. Type: int | (gauge) Unit: count |
ibm_mq_channel¶
| Tags & Fields | Description |
|---|---|
| channel ( tag) |
Channel name. |
| status ( tag) |
Channel status. |
| substate ( tag) |
Channel substate. |
| running | Whether the channel is RUNNING. Type: int | (gauge) |
| current_sharing_conversations | Current sharing conversation count. Type: int | (gauge) Unit: count |
| bytes_sent | Bytes sent. Type: int | (count) Unit: byte |
| bytes_received | Bytes received. Type: int | (count) Unit: byte |
| messages | Message count. Type: int | (count) Unit: count |
ibm_mq_listener¶
| Tags & Fields | Description |
|---|---|
| listener ( tag) |
Listener name. |
| status ( tag) |
Listener state. |
| running | Whether the listener is RUNNING. Type: int | (gauge) |
ibm_mq_cluster_qmgr¶
| Tags & Fields | Description |
|---|---|
| queue_manager ( tag) |
Queue Manager name. |
| cluster_qmgr ( tag) |
Cluster Queue Manager name. |
| status ( tag) |
Cluster Queue Manager status. |
| channel ( tag) |
Channel associated with the Cluster Queue Manager. |
| running | Whether the Cluster Queue Manager is RUNNING. Type: int | (gauge) |
ibm_mq_topic¶
| Tags & Fields | Description |
|---|---|
| queue_manager ( tag) |
Queue Manager name. |
| topic ( tag) |
Topic name. |
| publishers | Number of publishers. Type: int | (gauge) Unit: count |
| subscribers | Number of subscribers. Type: int | (gauge) Unit: count |
ibm_mq_subscription_summary¶
| Tags & Fields | Description |
|---|---|
| queue_manager ( tag) |
Queue Manager name. |
| subscriptions | Total number of subscriptions. Type: int | (gauge) Unit: count |
| durable_subscriptions | Number of durable subscriptions. Type: int | (gauge) Unit: count |
| admin_subscriptions | Number of admin subscriptions. Type: int | (gauge) Unit: count |
Custom Metrics¶
Custom metric fields are determined by deep_metrics_command output. Fields listed in the table are used as tags; numeric values in other key=value pairs are reported as int/float | (gauge) fields, and non-numeric values are reported as tags. If no numeric field exists, count=1 is added with unit count.
| Measurement | Tags | Description |
|---|---|---|
ibm_mq_authority |
object, object_type, principal |
Custom authority metrics. |
ibm_mq_event |
event_type, reason, object |
Custom event metrics. |
ibm_mq_cluster |
cluster, status |
Custom cluster metrics. |
ibm_mq_deep_metric |
metric, unit |
Generic IBM MQ custom metrics. |