[ibm-mq] Add expired message metric for IBM MQ queues (#2809)

breedx-splk · web-flow · commit 7c18a2fa6e9b · 2026-05-06T10:53:39.000Z
diff --git a/ibm-mq-metrics/config.yml b/ibm-mq-metrics/config.yml
@@ -142,6 +142,8 @@ metrics:
     enabled: true
   "ibm.mq.queue.depth.low.event":  # The number of low queue events
     enabled: true
+  "ibm.mq.expired.messages":  # Number of expired messages
+    enabled: true
   "ibm.mq.uncommitted.messages":  # Number of uncommitted messages
     enabled: true
   "ibm.mq.oldest.msg.age":  # Queue message oldest age
@@ -212,4 +214,4 @@ sslConnection:
 
 # Configure the OTLP exporter using system properties keys following the specification https://opentelemetry.io/docs/languages/java/configuration/
 otlpExporter:
-  otel.exporter.otlp.endpoint: http://localhost:4318
+  otel.exporter.otlp.endpoint: http://localhost:4318
diff --git a/ibm-mq-metrics/docs/metrics.md b/ibm-mq-metrics/docs/metrics.md
@@ -300,6 +300,25 @@
 
 
 
+## Metric `ibm.mq.expired.messages`
+
+| Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
+| -------- | --------------- | ----------- | -------------- | --------- |
+| `ibm.mq.expired.messages` | Gauge | `{message}` | Number of expired messages | ![Development](https://img.shields.io/badge/-development-blue) |
+
+
+### `ibm.mq.expired.messages` Attributes
+
+| Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
+|---|---|---|---|---|---|
+| `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `ibm.mq.queue.type` | string | The queue type | `local-normal` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `messaging.destination.name` | string | The system-specific name of the messaging operation. [8] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+
+**[8] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
+
+
+
 ## Metric `ibm.mq.uncommitted.messages`
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
@@ -313,9 +332,9 @@
 |---|---|---|---|---|---|
 | `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | `ibm.mq.queue.type` | string | The queue type | `local-normal` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `messaging.destination.name` | string | The system-specific name of the messaging operation. [8] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `messaging.destination.name` | string | The system-specific name of the messaging operation. [9] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 
-**[8] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
+**[9] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
 
 
 
@@ -332,9 +351,9 @@
 |---|---|---|---|---|---|
 | `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | `ibm.mq.queue.type` | string | The queue type | `local-normal` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `messaging.destination.name` | string | The system-specific name of the messaging operation. [9] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `messaging.destination.name` | string | The system-specific name of the messaging operation. [10] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 
-**[9] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
+**[10] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
 
 
 
@@ -351,9 +370,9 @@
 |---|---|---|---|---|---|
 | `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | `ibm.mq.queue.type` | string | The queue type | `local-normal` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `messaging.destination.name` | string | The system-specific name of the messaging operation. [10] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `messaging.destination.name` | string | The system-specific name of the messaging operation. [11] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 
-**[10] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
+**[11] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
 
 
 
@@ -370,9 +389,9 @@
 |---|---|---|---|---|---|
 | `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | `ibm.mq.queue.type` | string | The queue type | `local-normal` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `messaging.destination.name` | string | The system-specific name of the messaging operation. [11] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `messaging.destination.name` | string | The system-specific name of the messaging operation. [12] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 
-**[11] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
+**[12] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
 
 
 
@@ -389,9 +408,9 @@
 |---|---|---|---|---|---|
 | `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | `ibm.mq.queue.type` | string | The queue type | `local-normal` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `messaging.destination.name` | string | The system-specific name of the messaging operation. [12] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `messaging.destination.name` | string | The system-specific name of the messaging operation. [13] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 
-**[12] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
+**[13] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
 
 
 
@@ -408,9 +427,9 @@
 |---|---|---|---|---|---|
 | `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | `ibm.mq.queue.type` | string | The queue type | `local-normal` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `messaging.destination.name` | string | The system-specific name of the messaging operation. [13] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `messaging.destination.name` | string | The system-specific name of the messaging operation. [14] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 
-**[13] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
+**[14] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
 
 
 
@@ -427,9 +446,9 @@
 |---|---|---|---|---|---|
 | `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | `ibm.mq.queue.type` | string | The queue type | `local-normal` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `messaging.destination.name` | string | The system-specific name of the messaging operation. [14] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `messaging.destination.name` | string | The system-specific name of the messaging operation. [15] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 
-**[14] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
+**[15] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
 
 
 
@@ -446,9 +465,9 @@
 |---|---|---|---|---|---|
 | `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | `ibm.mq.queue.type` | string | The queue type | `local-normal` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `messaging.destination.name` | string | The system-specific name of the messaging operation. [15] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `messaging.destination.name` | string | The system-specific name of the messaging operation. [16] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 
-**[15] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
+**[16] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
 
 
 
@@ -465,9 +484,9 @@
 |---|---|---|---|---|---|
 | `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | `ibm.mq.queue.type` | string | The queue type | `local-normal` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `messaging.destination.name` | string | The system-specific name of the messaging operation. [16] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `messaging.destination.name` | string | The system-specific name of the messaging operation. [17] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 
-**[16] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
+**[17] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
 
 
 
@@ -529,9 +548,9 @@
 |---|---|---|---|---|---|
 | `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | `ibm.mq.queue.type` | string | The queue type | `local-normal` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `messaging.destination.name` | string | The system-specific name of the messaging operation. [17] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `messaging.destination.name` | string | The system-specific name of the messaging operation. [18] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 
-**[17] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
+**[18] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
 
 
 
@@ -548,9 +567,9 @@
 |---|---|---|---|---|---|
 | `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | `ibm.mq.queue.type` | string | The queue type | `local-normal` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `messaging.destination.name` | string | The system-specific name of the messaging operation. [18] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `messaging.destination.name` | string | The system-specific name of the messaging operation. [19] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 
-**[18] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
+**[19] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
 
 
 
@@ -567,9 +586,9 @@
 |---|---|---|---|---|---|
 | `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 | `ibm.mq.queue.type` | string | The queue type | `local-normal` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `messaging.destination.name` | string | The system-specific name of the messaging operation. [19] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `messaging.destination.name` | string | The system-specific name of the messaging operation. [20] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 
-**[19] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
+**[20] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
 
 
 
@@ -726,9 +745,9 @@
 | Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
 |---|---|---|---|---|---|
 | `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `messaging.destination.name` | string | The system-specific name of the messaging operation. [20] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `messaging.destination.name` | string | The system-specific name of the messaging operation. [21] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 
-**[20] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
+**[21] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
 
 
 
@@ -744,9 +763,9 @@
 | Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
 |---|---|---|---|---|---|
 | `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `messaging.destination.name` | string | The system-specific name of the messaging operation. [21] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `messaging.destination.name` | string | The system-specific name of the messaging operation. [22] | `dev/` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 
-**[21] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
+**[22] `messaging.destination.name`:** This is duplicated from otel semantic-conventions.
 
 
 
@@ -778,12 +797,12 @@
 | Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
 |---|---|---|---|---|---|
 | `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `service.name` | string | Logical name of the service. [22] | `Wordle`; `JMSService` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
-| `user.name` | string | Short name or login/username of the user. [23] | `foo`; `root` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `service.name` | string | Logical name of the service. [23] | `Wordle`; `JMSService` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `user.name` | string | Short name or login/username of the user. [24] | `foo`; `root` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
 
-**[22] `service.name`:** This is duplicated from otel semantic-conventions.
+**[23] `service.name`:** This is duplicated from otel semantic-conventions.
 
-**[23] `user.name`:** This is duplicated from otel semantic-conventions.
+**[24] `user.name`:** This is duplicated from otel semantic-conventions.
 
 
 
diff --git a/ibm-mq-metrics/model/metrics.yaml b/ibm-mq-metrics/model/metrics.yaml
@@ -249,6 +249,20 @@ groups:
         requirement_level: required
       - ref: messaging.destination.name
         requirement_level: required
+  - id: ibm.mq.expired.messages
+    type: metric
+    metric_name: ibm.mq.expired.messages
+    stability: development
+    brief: "Number of expired messages"
+    instrument: gauge
+    unit: "{message}"
+    attributes:
+      - ref: ibm.mq.queue.manager
+        requirement_level: required
+      - ref: messaging.destination.name
+        requirement_level: required
+      - ref: ibm.mq.queue.type
+        requirement_level: required
   - id: ibm.mq.uncommitted.messages
     type: metric
     metric_name: ibm.mq.uncommitted.messages
diff --git a/ibm-mq-metrics/src/integrationTest/resources/conf/test-config.yml b/ibm-mq-metrics/src/integrationTest/resources/conf/test-config.yml
@@ -122,6 +122,8 @@ metrics:
     enabled: true
   "ibm.mq.queue.depth.low.event":  # The number of low queue events
     enabled: true
+  "ibm.mq.expired.messages":  # Number of expired messages
+    enabled: true
   "ibm.mq.uncommitted.messages":  # Number of uncommitted messages
     enabled: true
   "ibm.mq.oldest.msg.age":  # Queue message oldest age
diff --git a/ibm-mq-metrics/src/integrationTest/resources/conf/test-queuemgr-config.yml b/ibm-mq-metrics/src/integrationTest/resources/conf/test-queuemgr-config.yml
@@ -94,6 +94,8 @@ metrics:
     enabled: true
   "ibm.mq.queue.depth.low.event":  # The number of low queue events
     enabled: true
+  "ibm.mq.expired.messages":  # Number of expired messages
+    enabled: true
   "ibm.mq.uncommitted.messages":  # Number of uncommitted messages
     enabled: true
   "ibm.mq.oldest.msg.age":  # Queue message oldest age
diff --git a/ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/metrics/Metrics.java b/ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/metrics/Metrics.java
@@ -159,6 +159,15 @@ public static LongCounter createIbmMqQueueDepthLowEvent(Meter meter) {
         .build();
   }
 
+  public static LongGauge createIbmMqExpiredMessages(Meter meter) {
+    return meter
+        .gaugeBuilder("ibm.mq.expired.messages")
+        .ofLongs()
+        .setUnit("{message}")
+        .setDescription("Number of expired messages")
+        .build();
+  }
+
   public static LongGauge createIbmMqUncommittedMessages(Meter meter) {
     return meter
         .gaugeBuilder("ibm.mq.uncommitted.messages")
diff --git a/ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/metrics/MetricsConfig.java b/ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/metrics/MetricsConfig.java
@@ -83,6 +83,10 @@ public boolean isIbmMqQueueDepthLowEventEnabled() {
     return isEnabled("ibm.mq.queue.depth.low.event");
   }
 
+  public boolean isIbmMqExpiredMessagesEnabled() {
+    return isEnabled("ibm.mq.expired.messages");
+  }
+
   public boolean isIbmMqUncommittedMessagesEnabled() {
     return isEnabled("ibm.mq.uncommitted.messages");
   }
diff --git a/ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/metricscollector/InquireQStatusCmdCollector.java b/ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/metricscollector/InquireQStatusCmdCollector.java
@@ -39,6 +39,7 @@ final class InquireQStatusCmdCollector implements Consumer<MetricsCollectorConte
         CMQCFC.MQIACF_CUR_MAX_FILE_SIZE,
         CMQCFC.MQIACF_OLDEST_MSG_AGE,
         CMQCFC.MQIACF_UNCOMMITTED_MSGS,
+        CMQCFC.MQIACF_EXPIRY_Q_COUNT,
         CMQCFC.MQIACF_Q_TIME_INDICATOR,
         CMQC.MQIA_CURRENT_Q_DEPTH,
       };
diff --git a/ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/metricscollector/QueueCollectionBuddy.java b/ibm-mq-metrics/src/main/java/io/opentelemetry/ibm/mq/metricscollector/QueueCollectionBuddy.java
@@ -108,6 +108,11 @@ private static AllowedGauge createAllowedGauge(
         createAllowedGauge(
             Metrics.createIbmMqUncommittedMessages(meter),
             MetricsConfig::isIbmMqUncommittedMessagesEnabled));
+    gauges.put(
+        CMQCFC.MQIACF_EXPIRY_Q_COUNT,
+        createAllowedGauge(
+            Metrics.createIbmMqExpiredMessages(meter),
+            MetricsConfig::isIbmMqExpiredMessagesEnabled));
     gauges.put(
         CMQC.MQIA_MSG_DEQ_COUNT,
         createAllowedGauge(
diff --git a/ibm-mq-metrics/src/test/java/io/opentelemetry/ibm/mq/metricscollector/QueueCollectionBuddyTest.java b/ibm-mq-metrics/src/test/java/io/opentelemetry/ibm/mq/metricscollector/QueueCollectionBuddyTest.java
diff --git a/ibm-mq-metrics/src/test/resources/conf/config.yml b/ibm-mq-metrics/src/test/resources/conf/config.yml

Original file line number	Diff line number	Diff line change
`@@ -83,6 +83,10 @@ public boolean isIbmMqQueueDepthLowEventEnabled() {`
`83`	`83`	`return isEnabled("ibm.mq.queue.depth.low.event");`
`84`	`84`	`}`
`85`	`85`
	`86`	`+ public boolean isIbmMqExpiredMessagesEnabled() {`
	`87`	`+ return isEnabled("ibm.mq.expired.messages");`
	`88`	`+ }`
	`89`	`+`
`86`	`90`	`public boolean isIbmMqUncommittedMessagesEnabled() {`
`87`	`91`	`return isEnabled("ibm.mq.uncommitted.messages");`
`88`	`92`	`}`