Add HTTP response to HttpServerMetricsTagsContributor.Context

This is useful for creating tags based on HTTP response headers for example Closes: #45717
quarkusio · Jan 21, 2025 · 3d761aa · 3d761aa
1 parent 625a0e2
commit 3d761aa
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 6 deletions.
diff --git a/...runtime/src/main/java/io/quarkus/micrometer/runtime/HttpServerMetricsTagsContributor.java b/...runtime/src/main/java/io/quarkus/micrometer/runtime/HttpServerMetricsTagsContributor.java
@@ -3,6 +3,7 @@
 import io.micrometer.core.instrument.Tags;
 import io.micrometer.core.instrument.config.MeterFilter;
 import io.vertx.core.http.HttpServerRequest;
+import io.vertx.core.spi.observability.HttpResponse;
 
 /**
  * Allows code to add additional Micrometer {@link Tags} to the metrics collected for completed HTTP server requests.
@@ -20,5 +21,7 @@ public interface HttpServerMetricsTagsContributor {
 
     interface Context {
         HttpServerRequest request();
+
+        HttpResponse response();
     }
 }
diff --git a/...time/src/main/java/io/quarkus/micrometer/runtime/binder/vertx/VertxHttpServerMetrics.java b/...time/src/main/java/io/quarkus/micrometer/runtime/binder/vertx/VertxHttpServerMetrics.java
@@ -205,7 +205,7 @@ public void responseEnd(HttpRequestMetric requestMetric, HttpResponse response,
                     VertxMetricsTags.outcome(response),
                     HttpCommonTags.status(response.statusCode()));
             if (!httpServerMetricsTagsContributors.isEmpty()) {
-                HttpServerMetricsTagsContributor.Context context = new DefaultContext(requestMetric.request());
+                HttpServerMetricsTagsContributor.Context context = new DefaultContext(requestMetric.request(), response);
                 for (int i = 0; i < httpServerMetricsTagsContributors.size(); i++) {
                     try {
                         Tags additionalTags = httpServerMetricsTagsContributors.get(i).contribute(context);
@@ -258,6 +258,7 @@ public void disconnected(LongTaskTimer.Sample websocketMetric) {
         }
     }
 
-    private record DefaultContext(HttpServerRequest request) implements HttpServerMetricsTagsContributor.Context {
+    private record DefaultContext(HttpServerRequest request,
+            HttpResponse response) implements HttpServerMetricsTagsContributor.Context {
     }
 }
diff --git a/integration-tests/micrometer-prometheus/src/main/java/io/quarkus/ResponseHeaderTag.java b/integration-tests/micrometer-prometheus/src/main/java/io/quarkus/ResponseHeaderTag.java
@@ -0,0 +1,20 @@
+package io.quarkus;
+
+import jakarta.inject.Singleton;
+
+import io.micrometer.core.instrument.Tags;
+import io.quarkus.micrometer.runtime.HttpServerMetricsTagsContributor;
+
+@Singleton
+public class ResponseHeaderTag implements HttpServerMetricsTagsContributor {
+
+    @Override
+    public Tags contribute(Context context) {
+        var headerValue = context.response().headers().get("foo-response");
+        String value = "UNSET";
+        if ((headerValue != null) && !headerValue.isEmpty()) {
+            value = headerValue;
+        }
+        return Tags.of("foo-response", value);
+    }
+}
diff --git a/...icrometer-prometheus/src/main/java/io/quarkus/it/micrometer/prometheus/FruitResource.java b/...icrometer-prometheus/src/main/java/io/quarkus/it/micrometer/prometheus/FruitResource.java
@@ -6,6 +6,8 @@
 import jakarta.ws.rs.GET;
 import jakarta.ws.rs.Path;
 
+import org.jboss.resteasy.reactive.RestResponse;
+
 import io.quarkus.hibernate.orm.panache.PanacheQuery;
 import io.smallrye.common.annotation.Blocking;
 
@@ -26,9 +28,13 @@ public void trigger() {
 
     @GET
     @Path("all")
-    public void retrieveAll() {
+    public RestResponse<Object> retrieveAll() {
         PanacheQuery<Fruit> query = Fruit.find(
                 "select name from Fruit");
         List<Fruit> all = query.list();
+
+        return RestResponse.ResponseBuilder.noContent()
+                .header("foo-response", "value")
+                .build();
     }
 }
diff --git a/...heus/src/test/java/io/quarkus/it/micrometer/prometheus/PrometheusMetricsRegistryTest.java b/...heus/src/test/java/io/quarkus/it/micrometer/prometheus/PrometheusMetricsRegistryTest.java
@@ -134,14 +134,15 @@ void testPrometheusScrapeEndpointTextPlain() {
                 .body(containsString("outcome=\"SUCCESS\""))
                 .body(containsString("dummy=\"value\""))
                 .body(containsString("foo=\"bar\""))
+                .body(containsString("foo_response=\"value\""))
                 .body(containsString("uri=\"/message/match/{id}/{sub}\""))
                 .body(containsString("uri=\"/message/match/{other}\""))
 
                 .body(containsString(
-                        "http_server_requests_seconds_count{dummy=\"value\",env=\"test\",env2=\"test\",foo=\"UNSET\",method=\"GET\",outcome=\"SUCCESS\",registry=\"prometheus\",status=\"200\",uri=\"/template/path/{value}\""))
+                        "http_server_requests_seconds_count{dummy=\"value\",env=\"test\",env2=\"test\",foo=\"UNSET\",foo_response=\"UNSET\",method=\"GET\",outcome=\"SUCCESS\",registry=\"prometheus\",status=\"200\",uri=\"/template/path/{value}\""))
 
                 .body(containsString(
-                        "http_server_requests_seconds_count{dummy=\"value\",env=\"test\",env2=\"test\",foo=\"UNSET\",method=\"GET\",outcome=\"SUCCESS\",registry=\"prometheus\",status=\"200\",uri=\"/root/{rootParam}/sub/{subParam}\""))
+                        "http_server_requests_seconds_count{dummy=\"value\",env=\"test\",env2=\"test\",foo=\"UNSET\",foo_response=\"UNSET\",method=\"GET\",outcome=\"SUCCESS\",registry=\"prometheus\",status=\"200\",uri=\"/root/{rootParam}/sub/{subParam}\""))
 
                 // Verify Hibernate Metrics
                 .body(containsString(
@@ -233,7 +234,7 @@ void testPrometheusScrapeEndpointOpenMetrics() {
                 .body(containsString("uri=\"/message/match/{other}\""))
 
                 .body(containsString(
-                        "http_server_requests_seconds_count{dummy=\"value\",env=\"test\",env2=\"test\",foo=\"UNSET\",method=\"GET\",outcome=\"SUCCESS\",registry=\"prometheus\",status=\"200\",uri=\"/template/path/{value}\""))
+                        "http_server_requests_seconds_count{dummy=\"value\",env=\"test\",env2=\"test\",foo=\"UNSET\",foo_response=\"UNSET\",method=\"GET\",outcome=\"SUCCESS\",registry=\"prometheus\",status=\"200\",uri=\"/template/path/{value}\""))
 
                 // Verify Hibernate Metrics
                 .body(containsString(