Merge pull request #630 from commercetools/newrelic_add_metrics

Newrelic add metrics

Author: jenschude

.git-blame-ignore-revs

@@ -1,4 +1,5 @@
 a8ec45c8ea4ba559247b654d01b0d35b21a68865
 33f3224cb40e3fa8c56ddb88962e3a4e9319685d
 430a1a0a5dd4efe78e21526c37bec9dbce036401
-d0129c1095216d5c830900c8a6223ef5d4274de1
+d0129c1095216d5c830900c8a6223ef5d4274de1
+4bc5c823b8ebf5a00491c7e63e1ea49d29bf5ee7

commercetools/commercetools-monitoring-newrelic/src/main/java/com/commercetools/monitoring/newrelic/NewRelicTelemetryMiddleware.java

@@ -1,6 +1,10 @@
 
 package com.commercetools.monitoring.newrelic;
 
+import static com.commercetools.monitoring.newrelic.NewrelicInfo.*;
+
+import java.time.Duration;
+import java.time.Instant;
 import java.util.Optional;
 import java.util.concurrent.CompletableFuture;
 import java.util.function.Function;
@@ -19,6 +23,18 @@
  *
  * {@include.example example.NewRelicApiRootBuilderTest#addNewRelic()}
  *
+ * The middleware adds the following metrics to Newrelic:
+ * <ul>
+ *     <li>Custom/Commercetools/Client/Duration: The duration of the request in milliseconds</li>
+ *     <li>Custom/Commercetools/Client/Request/Total: The total number of requests</li>
+ *     <li>Custom/Commercetools/Client/Request/Error: The total number of requests with a status code greater or equal to 400</li>
+ * </ul>
+ *
+ * <p>The metrics are added as metric timeslice data, therefore an APM is expected in the application.</p>
+ *
+ * <br/>
+ * <h2>Implementation details</h2>
+ *
  * <p>The middleware reads the {@link NewRelicContext} from the Request and restores the transaction using a {@link Token}
  * The details of the request and response are then reported as {@link Segment} with {@link HttpParameters}</p>
  *
@@ -39,7 +55,7 @@ public class NewRelicTelemetryMiddleware implements TelemetryMiddleware {
     @Override
     public CompletableFuture<ApiHttpResponse<byte[]>> invoke(ApiHttpRequest request,
             Function<ApiHttpRequest, CompletableFuture<ApiHttpResponse<byte[]>>> next) {
-
+        final Instant start = Instant.now();
         Optional<NewRelicContext> context = Optional.ofNullable(request.getContext(NewRelicContext.class));
         context.map(NewRelicContext::getToken).ifPresent(Token::link);
         Optional<Token> token = context.map(NewRelicContext::getTransaction).map(Transaction::getToken);
@@ -54,6 +70,14 @@ public CompletableFuture<ApiHttpResponse<byte[]>> invoke(ApiHttpRequest request,
                     .status(response.getStatusCode(), response.getMessage())
                     .build()));
             segment.ifPresent(Segment::end);
+
+            NewRelic.incrementCounter(PREFIX + CLIENT_REQUEST_TOTAL);
+            NewRelic.recordResponseTimeMetric(PREFIX + CLIENT_DURATION,
+                Duration.between(start, Instant.now()).toMillis());
+
+            if (response.getStatusCode() >= 400) {
+                NewRelic.incrementCounter(PREFIX + CLIENT_REQUEST_ERROR);
+            }
             return response;
         });
     }

commercetools/commercetools-monitoring-newrelic/src/main/java/com/commercetools/monitoring/newrelic/NewrelicInfo.java

@@ -0,0 +1,11 @@
+
+package com.commercetools.monitoring.newrelic;
+
+public class NewrelicInfo {
+    public static final String CLIENT_DURATION = "Client/Duration";
+    public static final String CLIENT_REQUEST_ERROR = "Client/Request/Error";
+    public static final String CLIENT_REQUEST_TOTAL = "Client/Request/Total";
+    public static final String JSON_SERIALIZATION = "Json/Serialization";
+    public static final String JSON_DESERIALIZATION = "Json/Deserialization";
+    public static final String PREFIX = "Custom/Commercetools/";
+}

commercetools/commercetools-monitoring-newrelic/src/main/java/com/commercetools/monitoring/newrelic/NewrelicResponseSerializer.java

@@ -0,0 +1,63 @@
+
+package com.commercetools.monitoring.newrelic;
+
+import static com.commercetools.monitoring.newrelic.NewrelicInfo.*;
+
+import java.time.Duration;
+import java.time.Instant;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.JavaType;
+import com.newrelic.api.agent.NewRelic;
+
+import io.vrap.rmf.base.client.ApiHttpResponse;
+import io.vrap.rmf.base.client.ResponseSerializer;
+
+/**
+ * This serializer uses API to submit metrics to newrelic.
+ */
+public class NewrelicResponseSerializer implements ResponseSerializer {
+    private final ResponseSerializer serializer;
+
+    public NewrelicResponseSerializer(final ResponseSerializer serializer) {
+        this.serializer = serializer;
+    }
+
+    @Override
+    public <O> ApiHttpResponse<O> convertResponse(ApiHttpResponse<byte[]> response, Class<O> outputType) {
+        Instant start = Instant.now();
+        ApiHttpResponse<O> result = serializer.convertResponse(response, outputType);
+        long durationInMillis = Duration.between(start, Instant.now()).toMillis();
+        NewRelic.recordResponseTimeMetric(PREFIX + JSON_SERIALIZATION, durationInMillis);
+        return result;
+    }
+
+    @Override
+    public <O> ApiHttpResponse<O> convertResponse(ApiHttpResponse<byte[]> response, JavaType outputType) {
+        Instant start = Instant.now();
+        ApiHttpResponse<O> result = serializer.convertResponse(response, outputType);
+        long durationInMillis = Duration.between(start, Instant.now()).toMillis();
+        NewRelic.recordResponseTimeMetric(PREFIX + JSON_SERIALIZATION, durationInMillis);
+        return result;
+    }
+
+    @Override
+    public <O> ApiHttpResponse<O> convertResponse(ApiHttpResponse<byte[]> response, TypeReference<O> outputType) {
+        Instant start = Instant.now();
+        ApiHttpResponse<O> result = serializer.convertResponse(response, outputType);
+        long durationInMillis = Duration.between(start, Instant.now()).toMillis();
+        NewRelic.recordResponseTimeMetric(PREFIX + JSON_SERIALIZATION, durationInMillis);
+        return result;
+    }
+
+    @Override
+    public byte[] toJsonByteArray(Object value) throws JsonProcessingException {
+        Instant start = Instant.now();
+        byte[] result = serializer.toJsonByteArray(value);
+        long durationInMillis = Duration.between(start, Instant.now()).toMillis();
+        NewRelic.recordResponseTimeMetric(PREFIX + JSON_DESERIALIZATION, durationInMillis);
+        return result;
+    }
+
+}

examples/spring-newrelic/src/main/java/com/commercetools/sdk/examples/springmvc/service/CtpClientBeanService.java

@@ -7,6 +7,7 @@
 
 import com.commercetools.monitoring.newrelic.NewRelicContext;
 import com.commercetools.monitoring.newrelic.NewRelicTelemetryMiddleware;
+import com.commercetools.monitoring.newrelic.NewrelicResponseSerializer;
 import com.newrelic.api.agent.NewRelic;
 import com.newrelic.api.agent.Trace;
 import io.vrap.rmf.base.client.*;
@@ -40,6 +41,7 @@ public ApiHttpClient client() {
         return ApiRootBuilder.of()
                 .defaultClient(credentials())
                 .withTelemetryMiddleware(new NewRelicTelemetryMiddleware())
+                .withSerializer(new NewrelicResponseSerializer(ResponseSerializer.of()))
                 .buildClient();
     }
 

examples/spring-newrelic/src/main/java/com/commercetools/sdk/examples/springmvc/web/AppContoller.java renamed to examples/spring-newrelic/src/main/java/com/commercetools/sdk/examples/springmvc/web/AppController.java

@@ -20,7 +20,7 @@
 import java.util.concurrent.ExecutionException;
 
 @Controller
-public class AppContoller {
+public class AppController {
     @GetMapping("/")
     public String home() {
         return "home/index";