#27 - ENH: Add HttpClientRequest label ... typically for grouping / using with metrics collection and reporting

Author: rbygrave

client/src/main/java/io/avaje/http/client/DHttpClientRequest.java

@@ -51,6 +51,7 @@ class DHttpClientRequest implements HttpClientRequest, HttpClientResponse {
   private boolean skipAuthToken;
   private boolean suppressLogging;
   private long startAsyncNanos;
+  private String label;
 
   DHttpClientRequest(DHttpClientContext context, Duration requestTimeout) {
     this.context = context;
@@ -71,6 +72,17 @@ public HttpClientRequest suppressLogging() {
     return this;
   }
 
+  @Override
+  public HttpClientRequest label(String label) {
+    this.label = label;
+    return this;
+  }
+
+  @Override
+  public String label() {
+    return label;
+  }
+
   @Override
   public HttpClientRequest requestTimeout(Duration requestTimeout) {
     this.requestTimeout = requestTimeout;

client/src/main/java/io/avaje/http/client/HttpClientRequest.java

@@ -45,6 +45,22 @@ public interface HttpClientRequest {
    */
   HttpClientRequest suppressLogging();
 
+  /**
+   * Set a label for the request. The label is intended to be used to group and
+   * identify metrics for the request.
+   *
+   * @param label The label that can be used to identify metrics for the request
+   */
+  HttpClientRequest label(String label);
+
+  /**
+   * Return the label that has been set on this request.
+   * <p>
+   * Typically the label would be read in {@link RequestIntercept#afterResponse(HttpResponse, HttpClientRequest)}
+   * to assign request execution metrics.
+   */
+  String label();
+
   /**
    * Set the request timeout to use for this request. When not set the default
    * request timeout will be used.

client/src/test/java/io/avaje/http/client/RetryTest.java

@@ -25,6 +25,7 @@ HttpClientContext initClientWithRetry() {
   @Test
   void retryTest() {
     HttpResponse<String> res = clientContext.request()
+      .label("http_client_hello_retry")
       .path("hello/retry")
       .GET()
       .asString();
@@ -33,11 +34,13 @@ void retryTest() {
 
     assertThat(myIntercept.responseTimeMicros).isGreaterThan(1);
     assertThat(myIntercept.counter).isEqualTo(1);
+    assertThat(myIntercept.label).isEqualTo("http_client_hello_retry");
   }
 
   static class MyIntercept implements RequestIntercept {
     int counter;
     long responseTimeMicros;
+    String label;
 
     /**
      * Not called for the retry attempts. Only called on the final success or error response.
@@ -46,6 +49,7 @@ static class MyIntercept implements RequestIntercept {
     public void afterResponse(HttpResponse<?> response, HttpClientRequest request) {
       counter++;
       responseTimeMicros = request.responseTimeMicros();
+      label = request.label();
     }
   }
 }