Merge pull request #45744 from geoand/#45717

geoand · web-flow · commit 77a710bcf2e3 · 2025-01-21T14:32:24.000+02:00
Add HTTP response to HttpServerMetricsTagsContributor.Context
diff --git a/docs/src/main/asciidoc/telemetry-micrometer.adoc b/docs/src/main/asciidoc/telemetry-micrometer.adoc
@@ -588,7 +588,9 @@ link:https://micrometer.io/docs/concepts[official documentation].
 
 === Use `HttpServerMetricsTagsContributor` for server HTTP requests
 
-By providing CDI beans that implement `io.quarkus.micrometer.runtime.HttpServerMetricsTagsContributor`, user code can contribute arbitrary tags based on the details of HTTP request
+By providing CDI beans that implement `io.quarkus.micrometer.runtime.HttpServerMetricsTagsContributor`, user code can contribute arbitrary tags based on the details of HTTP request and responses.
+
+CAUTION: When creating tags using this interface, it's important to limit the cardinality of the values, otherwise there is a risk of severely degrading the metrics system's capacity.
 
 === Use `HttpClientMetricsTagsContributor` for client HTTP requests
 
diff --git a/extensions/micrometer/runtime/src/main/java/io/quarkus/micrometer/runtime/HttpClientMetricsTagsContributor.java b/extensions/micrometer/runtime/src/main/java/io/quarkus/micrometer/runtime/HttpClientMetricsTagsContributor.java
@@ -3,6 +3,7 @@
 import io.micrometer.core.instrument.Tags;
 import io.micrometer.core.instrument.config.MeterFilter;
 import io.vertx.core.spi.observability.HttpRequest;
+import io.vertx.core.spi.observability.HttpResponse;
 
 /**
  * Allows code to add additional Micrometer {@link Tags} to the metrics collected for completed HTTP client requests.
@@ -20,5 +21,7 @@ public interface HttpClientMetricsTagsContributor {
 
     interface Context {
         HttpRequest request();
+
+        HttpResponse response();
     }
 }
diff --git a/extensions/micrometer/runtime/src/main/java/io/quarkus/micrometer/runtime/HttpServerMetricsTagsContributor.java b/extensions/micrometer/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/extensions/micrometer/runtime/src/main/java/io/quarkus/micrometer/runtime/binder/vertx/VertxHttpClientMetrics.java b/extensions/micrometer/runtime/src/main/java/io/quarkus/micrometer/runtime/binder/vertx/VertxHttpClientMetrics.java
@@ -172,7 +172,7 @@ public void responseEnd(RequestTracker tracker, long bytesRead) {
                         .and(HttpCommonTags.status(tracker.response.statusCode()))
                         .and(HttpCommonTags.outcome(tracker.response.statusCode()));
                 if (!httpClientMetricsTagsContributors.isEmpty()) {
-                    HttpClientMetricsTagsContributor.Context context = new DefaultContext(tracker.request);
+                    HttpClientMetricsTagsContributor.Context context = new DefaultContext(tracker.request, tracker.response);
                     for (int i = 0; i < httpClientMetricsTagsContributors.size(); i++) {
                         try {
                             Tags additionalTags = httpClientMetricsTagsContributors.get(i).contribute(context);
@@ -254,6 +254,7 @@ public String getNormalizedUriPath(Map<Pattern, String> serverMatchPatterns, Lis
         }
     }
 
-    private record DefaultContext(HttpRequest request) implements HttpClientMetricsTagsContributor.Context {
+    private record DefaultContext(HttpRequest request,
+            HttpResponse response) implements HttpClientMetricsTagsContributor.Context {
     }
 }
diff --git a/extensions/micrometer/runtime/src/main/java/io/quarkus/micrometer/runtime/binder/vertx/VertxHttpServerMetrics.java b/extensions/micrometer/runtime/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/integration-tests/micrometer-prometheus/src/main/java/io/quarkus/it/micrometer/prometheus/FruitResource.java b/integration-tests/micrometer-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/integration-tests/micrometer-prometheus/src/test/java/io/quarkus/it/micrometer/prometheus/ExemplarTest.java b/integration-tests/micrometer-prometheus/src/test/java/io/quarkus/it/micrometer/prometheus/ExemplarTest.java
@@ -24,7 +24,7 @@ void testExemplar() {
         when().get("/example/prime/7919").then().statusCode(200);
 
         String metricMatch = "http_server_requests_seconds_count{dummy=\"value\",env=\"test\"," +
-                "env2=\"test\",foo=\"UNSET\",method=\"GET\",outcome=\"SUCCESS\"," +
+                "env2=\"test\",foo=\"UNSET\",foo_response=\"UNSET\",method=\"GET\",outcome=\"SUCCESS\"," +
                 "registry=\"prometheus\",status=\"200\",uri=\"/example/prime/{number}\"} 2.0 # {span_id=\"";
 
         await().atMost(5, SECONDS).untilAsserted(() -> {
diff --git a/integration-tests/micrometer-prometheus/src/test/java/io/quarkus/it/micrometer/prometheus/PrometheusMetricsRegistryTest.java b/integration-tests/micrometer-prometheus/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(

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`import io.micrometer.core.instrument.Tags;`
`4`	`4`	`import io.micrometer.core.instrument.config.MeterFilter;`
`5`	`5`	`import io.vertx.core.spi.observability.HttpRequest;`
	`6`	`+import io.vertx.core.spi.observability.HttpResponse;`
`6`	`7`
`7`	`8`	`/**`
`8`	`9`	`* Allows code to add additional Micrometer {@link Tags} to the metrics collected for completed HTTP client requests.`
`@@ -20,5 +21,7 @@ public interface HttpClientMetricsTagsContributor {`
`20`	`21`
`21`	`22`	`interface Context {`
`22`	`23`	`HttpRequest request();`
	`24`	`+`
	`25`	`+ HttpResponse response();`
`23`	`26`	`}`
`24`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -172,7 +172,7 @@ public void responseEnd(RequestTracker tracker, long bytesRead) {`
`172`	`172`	`.and(HttpCommonTags.status(tracker.response.statusCode()))`
`173`	`173`	`.and(HttpCommonTags.outcome(tracker.response.statusCode()));`
`174`	`174`	`if (!httpClientMetricsTagsContributors.isEmpty()) {`
`175`		`- HttpClientMetricsTagsContributor.Context context = new DefaultContext(tracker.request);`
	`175`	`+ HttpClientMetricsTagsContributor.Context context = new DefaultContext(tracker.request, tracker.response);`
`176`	`176`	`for (int i = 0; i < httpClientMetricsTagsContributors.size(); i++) {`
`177`	`177`	`try {`
`178`	`178`	`Tags additionalTags = httpClientMetricsTagsContributors.get(i).contribute(context);`
`@@ -254,6 +254,7 @@ public String getNormalizedUriPath(Map<Pattern, String> serverMatchPatterns, Lis`
`254`	`254`	`}`
`255`	`255`	`}`
`256`	`256`
`257`		`- private record DefaultContext(HttpRequest request) implements HttpClientMetricsTagsContributor.Context {`
	`257`	`+ private record DefaultContext(HttpRequest request,`
	`258`	`+ HttpResponse response) implements HttpClientMetricsTagsContributor.Context {`
`258`	`259`	`}`
`259`	`260`	`}`
Original file line number	Diff line number	Diff line change
`@@ -205,7 +205,7 @@ public void responseEnd(HttpRequestMetric requestMetric, HttpResponse response,`
`205`	`205`	`VertxMetricsTags.outcome(response),`
`206`	`206`	`HttpCommonTags.status(response.statusCode()));`
`207`	`207`	`if (!httpServerMetricsTagsContributors.isEmpty()) {`
`208`		`- HttpServerMetricsTagsContributor.Context context = new DefaultContext(requestMetric.request());`
	`208`	`+ HttpServerMetricsTagsContributor.Context context = new DefaultContext(requestMetric.request(), response);`
`209`	`209`	`for (int i = 0; i < httpServerMetricsTagsContributors.size(); i++) {`
`210`	`210`	`try {`
`211`	`211`	`Tags additionalTags = httpServerMetricsTagsContributors.get(i).contribute(context);`
`@@ -258,6 +258,7 @@ public void disconnected(LongTaskTimer.Sample websocketMetric) {`
`258`	`258`	`}`
`259`	`259`	`}`
`260`	`260`
`261`		`- private record DefaultContext(HttpServerRequest request) implements HttpServerMetricsTagsContributor.Context {`
	`261`	`+ private record DefaultContext(HttpServerRequest request,`
	`262`	`+ HttpResponse response) implements HttpServerMetricsTagsContributor.Context {`
`262`	`263`	`}`
`263`	`264`	`}`