#41 - ENH: Add HttpClientContext metrics() to provide statistical overview of activity

Author: rbygrave

client/pom.xml

@@ -34,7 +34,7 @@
     <dependency>
       <groupId>io.avaje</groupId>
       <artifactId>avaje-jsonb</artifactId>
-      <version>0.11</version>
+      <version>0.12</version>
       <optional>true</optional>
     </dependency>
 

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

@@ -10,7 +10,7 @@
 /**
  * Service loads the HttpApiProvider for HttpApi.
  */
-class DHttpApi {
+final class DHttpApi {
 
   private static final Logger log = LoggerFactory.getLogger(DHttpApi.class);
 

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

@@ -6,7 +6,7 @@
 import java.util.concurrent.CompletableFuture;
 import java.util.stream.Stream;
 
-class DHttpAsync implements HttpAsyncResponse {
+final class DHttpAsync implements HttpAsyncResponse {
 
   private final DHttpClientRequest request;
 

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

@@ -6,7 +6,7 @@
 import java.util.concurrent.CompletableFuture;
 import java.util.stream.Stream;
 
-class DHttpCall implements HttpCallResponse {
+final class DHttpCall implements HttpCallResponse {
 
   private final DHttpClientRequest request;
 

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

@@ -12,8 +12,10 @@
 import java.util.Map;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.atomic.AtomicReference;
+import java.util.concurrent.atomic.LongAccumulator;
+import java.util.concurrent.atomic.LongAdder;
 
-class DHttpClientContext implements HttpClientContext {
+final class DHttpClientContext implements HttpClientContext {
 
   /**
    * HTTP Authorization header.
@@ -33,6 +35,12 @@ class DHttpClientContext implements HttpClientContext {
   private final AtomicReference<AuthToken> tokenRef = new AtomicReference<>();
   private int loggingMaxBody = 1_000;
 
+  private final LongAdder metricResTotal = new LongAdder();
+  private final LongAdder metricResError = new LongAdder();
+  private final LongAdder metricResBytes = new LongAdder();
+  private final LongAdder metricResMicros = new LongAdder();
+  private final LongAccumulator metricResMaxMicros = new LongAccumulator(Math::max, 0);
+
   DHttpClientContext(HttpClient httpClient, String baseUrl, Duration requestTimeout, BodyAdapter bodyAdapter, RetryHandler retryHandler, RequestListener requestListener, AuthTokenProvider authTokenProvider, RequestIntercept intercept) {
     this.httpClient = httpClient;
     this.baseUrl = baseUrl;
@@ -94,6 +102,76 @@ public HttpClient httpClient() {
     return httpClient;
   }
 
+  @Override
+  public Metrics metrics() {
+    return metrics(false);
+  }
+
+  @Override
+  public Metrics metrics(boolean reset) {
+    if (reset) {
+      return new DMetrics(metricResTotal.sumThenReset(), metricResError.sumThenReset(), metricResBytes.sumThenReset(), metricResMicros.sumThenReset(), metricResMaxMicros.getThenReset());
+    } else {
+      return new DMetrics(metricResTotal.sum(), metricResError.sum(), metricResBytes.sum(), metricResMicros.sum(), metricResMaxMicros.get());
+    }
+  }
+
+  void metricsString(int stringBody) {
+    metricResBytes.add(stringBody);
+  }
+
+  static final class DMetrics implements Metrics {
+
+    private final long totalCount;
+    private final long errorCount;
+    private final long responseBytes;
+    private final long totalMicros;
+    private final long maxMicros;
+
+    DMetrics(long totalCount, long errorCount, long responseBytes, long totalMicros, long maxMicros) {
+      this.totalCount = totalCount;
+      this.errorCount = errorCount;
+      this.responseBytes = responseBytes;
+      this.totalMicros = totalMicros;
+      this.maxMicros = maxMicros;
+    }
+
+    @Override
+    public String toString() {
+      return "totalCount:" + totalCount + " errorCount:" + errorCount + " responseBytes:" + responseBytes + " totalMicros:" + totalMicros + " avgMicros:" + avgMicros()+ " maxMicros:" + maxMicros;
+    }
+
+    @Override
+    public long totalCount() {
+      return totalCount;
+    }
+
+    @Override
+    public long errorCount() {
+      return errorCount;
+    }
+
+    @Override
+    public long responseBytes() {
+      return responseBytes;
+    }
+
+    @Override
+    public long totalMicros() {
+      return totalMicros;
+    }
+
+    @Override
+    public long maxMicros() {
+      return maxMicros;
+    }
+
+    @Override
+    public long avgMicros() {
+      return totalCount == 0 ? 0 : totalMicros / totalCount;
+    }
+  }
+
   @Override
   public void checkResponse(HttpResponse<?> response) {
     if (response.statusCode() >= 300) {
@@ -123,6 +201,10 @@ public BodyContent readErrorContent(boolean responseAsBytes, HttpResponse<?> htt
 
   @Override
   public BodyContent readContent(HttpResponse<byte[]> httpResponse) {
+    final byte[] body = httpResponse.body();
+    if (body != null && body.length > 0) {
+      metricResBytes.add(body.length);
+    }
     byte[] bodyBytes = decodeContent(httpResponse);
     final String contentType = getContentType(httpResponse);
     return new BodyContent(contentType, bodyBytes);
@@ -193,6 +275,12 @@ <T> List<T> readList(Class<T> cls, BodyContent content) {
   }
 
   void afterResponse(DHttpClientRequest request) {
+    metricResTotal.add(1);
+    metricResMicros.add(request.responseTimeMicros());
+    metricResMaxMicros.accumulate(request.responseTimeMicros());
+    if (request.response().statusCode() >= 300) {
+      metricResError.add(1);
+    }
     if (requestListener != null) {
       requestListener.response(request.listenerEvent());
     }

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

@@ -14,7 +14,7 @@
 
 import static java.util.Objects.requireNonNull;
 
-class DHttpClientContextBuilder implements HttpClientContext.Builder {
+final class DHttpClientContextBuilder implements HttpClientContext.Builder {
 
   private HttpClient client;
   private String baseUrl;

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

@@ -531,16 +531,21 @@ public HttpResponse<byte[]> asByteArray() {
     return withHandler(HttpResponse.BodyHandlers.ofByteArray());
   }
 
+  private HttpResponse<String> addMetrics(final HttpResponse<String> res) {
+    context.metricsString(res.body().length());
+    return res;
+  }
+
   @Override
   public HttpResponse<String> asString() {
     loggableResponseBody = true;
-    return withHandler(HttpResponse.BodyHandlers.ofString());
+    return addMetrics(withHandler(HttpResponse.BodyHandlers.ofString()));
   }
 
   @Override
   public HttpResponse<String> asPlainString() {
     loggableResponseBody = true;
-    final HttpResponse<String> hres = withHandler(HttpResponse.BodyHandlers.ofString());
+    final HttpResponse<String> hres = addMetrics(withHandler(HttpResponse.BodyHandlers.ofString()));
     context.checkResponse(hres);
     return hres;
   }

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

@@ -6,7 +6,7 @@
 /**
  * Extends DHttpClientRequest with retry attempts.
  */
-class DHttpClientRequestWithRetry extends DHttpClientRequest {
+final class DHttpClientRequestWithRetry extends DHttpClientRequest {
 
   private final RetryHandler retryHandler;
   private int retryCount;

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

@@ -10,7 +10,7 @@
  * <p>
  * Noting that afterResponse interceptors are processed in reverse order.
  */
-class DRequestInterceptors implements RequestIntercept {
+final class DRequestInterceptors implements RequestIntercept {
 
   private final List<RequestIntercept> before;
   private final List<RequestIntercept> after;

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

@@ -2,7 +2,7 @@
 
 import java.util.List;
 
-class DRequestListeners implements RequestListener {
+final class DRequestListeners implements RequestListener {
 
   private final RequestListener[] listeners;