add client db pool metrics

Author: SylvainJuge

instrumentation/jmx-metrics/library/src/main/resources/jmx/rules/wildfly.yaml

@@ -45,12 +45,12 @@ rules:
         metric: request.duration.sum
         sourceUnit: ns
         unit: s
-        desc: The total amount of time spent processing requests.
+        desc: The total amount of time spent processing requests
       # wildfly.error.count
       errorCount:
         metric: error.count
         unit: "{request}"
-        desc: The number of requests that have resulted in a 5xx response.
+        desc: The number of requests that have resulted in a 5xx response
 
   # wildly.network.io
   - bean: jboss.as:subsystem=undertow,server=*,http-listener=*
@@ -71,24 +71,33 @@ rules:
         metricAttribute:
           network.io.direction: const(receive)
 
-#  - bean: jboss.as:subsystem=datasources,data-source=*,statistics=pool
-#    unit: "1"
-#    metricAttribute:
-#      data_source: param(data-source)
-#    mapping:
-#      ActiveCount:
-#        metric: wildfly.db.client.connections.usage
-#        metricAttribute:
-#          state: const(used)
-#        desc: The number of open jdbc connections
-#      IdleCount:
-#        metric: wildfly.db.client.connections.usage
-#        metricAttribute:
-#          state: const(idle)
-#        desc: The number of open jdbc connections
-#      WaitCount:
-#        metric: wildfly.db.client.connections.WaitCount
-#        type: counter
+  - bean: jboss.as:subsystem=datasources,data-source=*,statistics=pool
+    prefix: wildfly.db.client.connection.
+    metricAttribute:
+      db.client.connection.pool.name: param(data-source)
+    mapping:
+      # wildfly.db.client.connection.count
+      ActiveCount:
+        metric: &metric count
+        type: updowncounter
+        unit: "{connection}"
+        desc: &desc The number of open physical database connections
+        metricAttribute:
+          db.client.connection.state: const(used)
+      IdleCount:
+        metric: *metric
+        type: updowncounter
+        unit: "{connection}"
+        desc: *desc
+        metricAttribute:
+          db.client.connection.state: const(idle)
+      # wildfly.db.client.connection.wait.count
+      WaitCount:
+        metric: wait.count
+        type: counter
+        # In this context, 'request' means 'connection request'
+        unit: "{request}"
+        desc: The number of connection requests that had to wait to obtain it
 
 #  - bean: jboss.as:subsystem=transactions
 #    type: counter

instrumentation/jmx-metrics/library/src/test/java/io/opentelemetry/instrumentation/jmx/rules/WildflyTest.java

@@ -21,10 +21,14 @@
 
 public class WildflyTest extends TargetSystemTest {
 
-  private static final int WILDFLY_SERVICE_PORT = 8080;
-
   @ParameterizedTest
-  @ValueSource(strings = {"quay.io/wildfly/wildfly:32.0.1.Final-jdk11"})
+  @ValueSource(
+      strings = {
+        // keep testing on old and deprecated version for compatibility
+        "jboss/wildfly:8.2.1.Final",
+        // recent/latest to be maintained as newer versions are released
+        "quay.io/wildfly/wildfly:36.0.1.Final-jdk21"
+      })
   public void testWildflyMetrics(String dockerImage) {
     List<String> yamlFiles = Collections.singletonList("wildfly.yaml");
 
@@ -50,13 +54,17 @@ public void testWildflyMetrics(String dockerImage) {
     verifyMetrics(createMetricsVerifier());
   }
 
+  private static final int WILDFLY_SERVICE_PORT = 8080;
+
   private static MetricsVerifier createMetricsVerifier() {
     AttributeMatcher deploymentAttribute = attribute("wildfly.deployment", "testapp.war");
     AttributeMatcher serverAttribute = attribute("wildfly.server", "default-server");
     AttributeMatcher listenerAttribute = attribute("wildfly.listener", "default");
     AttributeMatcherGroup serverListenerAttributes =
         attributeGroup(serverAttribute, listenerAttribute);
 
+    AttributeMatcher dataSourceAttribute = attribute("db.client.connection.pool.name", "ExampleDS");
+
     return MetricsVerifier.create()
         // session metrics
         .add(
@@ -132,6 +140,28 @@ private static MetricsVerifier createMetricsVerifier() {
                         attributeGroup(
                             attribute("network.io.direction", "transmit"),
                             serverAttribute,
-                            listenerAttribute)));
+                            listenerAttribute)))
+        // database connection pool metrics
+        .add(
+            "wildfly.db.client.connection.count",
+            metric ->
+                metric
+                    .isUpDownCounter()
+                    .hasDescription("The number of open physical database connections")
+                    .hasUnit("{connection}")
+                    .hasDataPointsWithAttributes(
+                        attributeGroup(
+                            dataSourceAttribute, attribute("db.client.connection.state", "used")),
+                        attributeGroup(
+                            dataSourceAttribute, attribute("db.client.connection.state", "idle"))))
+        .add(
+            "wildfly.db.client.connection.wait.count",
+            metric ->
+                metric
+                    .isCounter()
+                    .hasDescription(
+                        "The number of connection requests that had to wait to obtain it")
+                    .hasUnit("{request}")
+                    .hasDataPointsWithOneAttribute(dataSourceAttribute));
   }
 }