Add counters in one place for all controllers and timer example.

Author: CioleaFlorin

essentialprogramming-api/src/main/java/com/api/config/ApplicationConfig.java

@@ -44,6 +44,9 @@ public ApplicationConfig() {
         //Validate JWT Token
         register(SecurityFeature.class);
 
+        //Initialize controller counters
+        register(MetricsFeature.class);
+
         register(UserController.class);
         register(WelcomeController.class);
         register(PDFController.class);

essentialprogramming-api/src/main/java/com/api/config/MetricsFeature.java

@@ -0,0 +1,30 @@
+package com.api.config;
+
+import io.micrometer.core.instrument.MeterRegistry;
+
+import javax.inject.Inject;
+import javax.ws.rs.container.DynamicFeature;
+import javax.ws.rs.container.ResourceInfo;
+import javax.ws.rs.core.FeatureContext;
+import javax.ws.rs.ext.Provider;
+
+@Provider
+public class MetricsFeature implements DynamicFeature {
+
+    @Inject
+    private MeterRegistry meterRegistry;
+
+    public void setMeterRegistry(MeterRegistry meterRegistry) {
+        this.meterRegistry = meterRegistry;
+    }
+
+    @Override
+    public void configure(final ResourceInfo resourceInfo, final FeatureContext context) {
+
+        if (!resourceInfo.getResourceClass().getName().contains("Controller")) {
+            return;
+        }
+        context.register(new MetricsFilter(resourceInfo, meterRegistry));
+    }
+
+}

essentialprogramming-api/src/main/java/com/api/config/MetricsFilter.java

@@ -0,0 +1,69 @@
+package com.api.config;
+
+import io.micrometer.core.instrument.Counter;
+import io.micrometer.core.instrument.MeterRegistry;
+import org.glassfish.jersey.server.ContainerRequest;
+
+import javax.ws.rs.*;
+import javax.ws.rs.container.ContainerRequestContext;
+import javax.ws.rs.container.ContainerRequestFilter;
+import javax.ws.rs.container.ResourceInfo;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+
+public class MetricsFilter implements ContainerRequestFilter {
+
+    private static final String METRIC_KEY = "counter";
+
+    private static final Map<String, Counter> counters = new ConcurrentHashMap<>();
+
+
+    public MetricsFilter(ResourceInfo resourceInfo, MeterRegistry meterRegistry) {
+
+        String controllerName = resourceInfo.getResourceClass().getSimpleName();
+        String fullMethodName = resourceInfo.getResourceMethod().toGenericString();
+        String methodName = resourceInfo.getResourceMethod().getName();
+        String endpointPath = resourceInfo.getResourceClass().getAnnotation(Path.class).value()
+                + resourceInfo.getResourceMethod().getAnnotation(Path.class).value();
+
+        counters.put(fullMethodName, Counter
+                .builder(METRIC_KEY + "." + controllerName + "." + methodName)
+                .description("count of endpoint calls " + getHttpMethod(resourceInfo) + " : " + endpointPath)
+                .register(meterRegistry));
+    }
+
+    @Override
+    public void filter(final ContainerRequestContext requestContext) {
+
+        String methodName = ((ContainerRequest) requestContext)
+                .getUriInfo()
+                .getMatchedResourceMethod()
+                .getInvocable()
+                .getDefinitionMethod()
+                .toGenericString();
+
+        if (counters.containsKey(methodName)) {
+            counters.get(methodName).increment();
+        }
+    }
+
+
+    private String getHttpMethod(ResourceInfo resourceInfo) {
+
+        if (resourceInfo.getResourceMethod().isAnnotationPresent(GET.class)) {
+            return GET.class.getSimpleName();
+        } else if (resourceInfo.getResourceMethod().isAnnotationPresent(POST.class)) {
+            return POST.class.getSimpleName();
+        } else if (resourceInfo.getResourceMethod().isAnnotationPresent(DELETE.class)) {
+            return DELETE.class.getSimpleName();
+        } else if (resourceInfo.getResourceMethod().isAnnotationPresent(PUT.class)) {
+            return PUT.class.getSimpleName();
+        } else if (resourceInfo.getResourceMethod().isAnnotationPresent(PATCH.class)) {
+            return PATCH.class.getSimpleName();
+        } else if (resourceInfo.getResourceMethod().isAnnotationPresent(HEAD.class)) {
+            return HEAD.class.getSimpleName();
+        } else if (resourceInfo.getResourceMethod().isAnnotationPresent(OPTIONS.class)) {
+            return OPTIONS.class.getSimpleName();
+        } else return "";
+    }
+}

essentialprogramming-api/src/main/java/com/api/controller/UserController.java

@@ -1,7 +1,6 @@
 package com.api.controller;
 
 import com.api.config.Anonymous;
-import com.api.entities.User;
 import com.api.exceptions.codes.ErrorCode;
 import com.api.model.UserInput;
 import com.api.output.UserJSON;
@@ -16,6 +15,8 @@
 import com.util.enums.HTTPCustomStatus;
 import com.util.enums.Language;
 import com.util.exceptions.ApiException;
+import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.Timer;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.media.Content;
@@ -39,6 +40,7 @@
 import java.io.Serializable;
 import java.security.GeneralSecurityException;
 import java.util.List;
+import java.util.concurrent.Callable;
 import java.util.concurrent.CompletionException;
 import java.util.concurrent.ExecutorService;
 
@@ -51,14 +53,16 @@
 public class UserController {
 
     private final UserService userService;
+    private final MeterRegistry meterRegistry;
 
 
     @Context
     private Language language;
 
     @Inject
-    public UserController(final UserService userService) {
+    public UserController(final UserService userService, MeterRegistry meterRegistry) {
         this.userService = userService;
+        this.meterRegistry = meterRegistry;
     }
 
 
@@ -140,15 +144,20 @@ private Serializable loadUser(String email) throws ApiException {
     @Anonymous
     public void loadAll(@HeaderParam("Authorization") String authorization, @Suspended AsyncResponse asyncResponse) {
 
+        Timer timerExample = Timer
+                .builder("timer.load.users")
+                .description("measures the time taken to load all users")
+                .register(meterRegistry);
+        Callable<List<UserJSON>> findAllUsersTimed = timerExample.wrap((Callable<List<UserJSON>>) this::findAllUsers);
+
         final ExecutorService executorService = ExecutorsProvider.getExecutorService();
-        Computation.computeAsync(this::findAllUsers, executorService)
+        Computation.computeAsync(findAllUsersTimed, executorService)
                 .thenApplyAsync(json -> asyncResponse.resume(Response.ok(json).build()), executorService)
                 .exceptionally(error -> asyncResponse.resume(ExceptionHandler.handleException((CompletionException) error)));
-
     }
 
-    private List<User> findAllUsers() {
-        return userService.loadAll();
+    public List<UserJSON> findAllUsers() {
+        return userService.loadAllAsJSON();
     }
 
     @DELETE

essentialprogramming-api/src/main/java/com/api/service/UserService.java

@@ -2,7 +2,6 @@
 
 import com.api.entities.User;
 import com.api.env.resources.AppResources;
-import com.api.exceptions.codes.ErrorCode;
 import com.api.mapper.UserMapper;
 import com.api.model.UserInput;
 import com.api.output.UserJSON;
@@ -19,9 +18,9 @@
 import com.util.exceptions.ApiException;
 import com.util.io.FileInputResource;
 import com.util.web.JsonResponse;
+import io.micrometer.core.annotation.Timed;
 import lombok.RequiredArgsConstructor;
 import lombok.SneakyThrows;
-import org.apache.logging.log4j.ThreadContext;
 import org.jboss.weld.util.collections.ImmutableMap;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -36,9 +35,10 @@
 import java.security.GeneralSecurityException;
 import java.time.Clock;
 import java.time.LocalDateTime;
+import java.util.List;
 import java.util.Map;
 import java.util.Optional;
-import java.util.List;
+import java.util.stream.Collectors;
 
 import static com.config.ClockConfig.UTC_CLOCK;
 import static com.config.ObjectMapperConfig.ObjectMapperProvider;
@@ -139,7 +139,7 @@ private User getUserFromFile() throws IOException {
         }
     }
 
-
+    @Timed(value = "timed.method")
     private User saveUser(User user, UserInput input, com.util.enums.Language language) {
 
         final String uuid = NanoIdUtils.randomNanoId();
@@ -158,6 +158,11 @@ private User saveUser(User user, UserInput input, com.util.enums.Language langua
         return user;
     }
 
+    @Transactional
+    public List<UserJSON> loadAllAsJSON() {
+        return userRepository.findAll().stream().map(UserMapper::userToJson).collect(Collectors.toList());
+    }
+
     @Transactional
     public List<User> loadAll() {
         return userRepository.findAll();

essentialprogramming-api/src/main/java/com/config/MicrometerConfig.java

@@ -4,6 +4,7 @@
 import com.api.exceptions.codes.ErrorCode;
 import com.crypto.Crypt;
 import com.util.exceptions.ServiceException;
+import io.micrometer.core.aop.TimedAspect;
 import io.micrometer.core.instrument.Clock;
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.core.instrument.composite.CompositeMeterRegistry;
@@ -37,6 +38,11 @@ public MeterRegistry meterRegistry() {
         return compositeRegistry;
     }
 
+    @Bean
+    public TimedAspect timedAspect(MeterRegistry registry) {
+        return new TimedAspect(registry);
+    }
+
     private DatadogConfig configureDatadog() {
         final String apiKey = decryptKey(AppResources.DATADOG_API_KEY);
         final String applicationKey = decryptKey(AppResources.DATADOG_APPLICATION_KEY);