Add a counter that records the number of times the connection was not established successfully, with an error.code dimension recording the code of the error reported

Author: github-actions[bot]

ibm-mq-metrics/docs/metrics.md

@@ -799,3 +799,21 @@
 | 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) |
+
+
+
+## Metric `mq.connection.errors`
+
+| Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
+| -------- | --------------- | ----------- | -------------- | --------- |
+| `mq.connection.errors` | Counter | `{errors}` | Number of connection errors | ![Development](https://img.shields.io/badge/-development-blue) |
+
+
+### `mq.connection.errors` Attributes
+
+| Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
+|---|---|---|---|---|---|
+| `error.code` | string | The reason code associated with an error | `2038`; `2543`; `2009` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+| `ibm.mq.queue.manager` | string | The name of the IBM queue manager | `MQ1` | `Required` | ![Development](https://img.shields.io/badge/-development-blue) |
+
+

ibm-mq-metrics/model/attributes.yaml

@@ -73,3 +73,9 @@ groups:
         note: This is duplicated from otel semantic-conventions.
         stability: development
         examples: [ "Wordle", "JMSService" ]
+      - id: error.code
+        type: string
+        brief: >
+          The reason code associated with an error
+        stability: development
+        examples: [ "2038", "2543", "2009" ]

ibm-mq-metrics/model/metrics.yaml

@@ -609,3 +609,15 @@ groups:
     attributes:
       - ref: ibm.mq.queue.manager
         requirement_level: required
+  - id: mq.connection.errors
+    type: metric
+    metric_name: mq.connection.errors
+    stability: development
+    brief: "Number of connection errors"
+    instrument: counter
+    unit: "{errors}"
+    attributes:
+      - ref: ibm.mq.queue.manager
+        requirement_level: required
+      - ref: error.code
+        requirement_level: required

ibm-mq-metrics/src/integrationTest/java/io/opentelemetry/ibm/mq/integration/tests/WMQMonitorIntegrationTest.java

@@ -18,12 +18,15 @@
 import com.ibm.mq.headers.pcf.PCFException;
 import com.ibm.mq.headers.pcf.PCFMessage;
 import com.ibm.mq.headers.pcf.PCFMessageAgent;
+import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.metrics.Meter;
 import io.opentelemetry.ibm.mq.config.QueueManager;
 import io.opentelemetry.ibm.mq.opentelemetry.ConfigWrapper;
 import io.opentelemetry.ibm.mq.opentelemetry.Main;
 import io.opentelemetry.ibm.mq.util.WmqUtil;
+import io.opentelemetry.sdk.metrics.data.LongPointData;
 import io.opentelemetry.sdk.metrics.data.MetricData;
+import io.opentelemetry.sdk.metrics.data.SumData;
 import io.opentelemetry.sdk.testing.junit5.OpenTelemetryExtension;
 import java.io.File;
 import java.net.URISyntaxException;
@@ -281,4 +284,34 @@ void test_otlphttp() throws Exception {
     // reads a value from the heartbeat gauge
     assertThat(metricNames).contains("ibm.mq.heartbeat");
   }
+
+  @Test
+  void test_bad_connection() throws Exception {
+    logger.info("\n\n\n\n\n\nRunning test: test_bad_connection");
+    String configFile = getConfigFile("conf/test-bad-config.yml");
+
+    ConfigWrapper config = ConfigWrapper.parse(configFile);
+    Meter meter = otelTesting.getOpenTelemetry().getMeter("opentelemetry.io/mq");
+    TestWMQMonitor monitor = new TestWMQMonitor(config, meter, service);
+    monitor.runTest();
+
+    List<MetricData> data = otelTesting.getMetrics();
+
+    assertThat(data).isNotEmpty();
+    assertThat(data).hasSize(2);
+
+    SumData<LongPointData> connectionErrors = null;
+    for (MetricData metricData : data) {
+      if ("mq.connection.errors".equals(metricData.getName())) {
+        connectionErrors = (SumData<LongPointData>) metricData.getData();
+      }
+    }
+
+    assertThat(connectionErrors).isNotNull();
+
+    LongPointData metricPoint = connectionErrors.getPoints().iterator().next();
+    String value = metricPoint.getAttributes().get(AttributeKey.stringKey("error.code"));
+
+    assertThat(value).isEqualTo("2538");
+  }
 }