PAGOPA-1761 fixing kibana dashboard

pagopa · May 21, 2024 · 126ff4f · 126ff4f
1 parent 5b43bbc
commit 126ff4f
Show file tree

Hide file tree

Showing 2 changed files with 159 additions and 129 deletions.
diff --git a/src/main/java/it/gov/pagopa/afm/calculator/config/LoggingAspect.java b/src/main/java/it/gov/pagopa/afm/calculator/config/LoggingAspect.java
@@ -1,157 +1,184 @@
 package it.gov.pagopa.afm.calculator.config;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+import it.gov.pagopa.afm.calculator.exception.AppError;
+import it.gov.pagopa.afm.calculator.model.ProblemJson;
 import lombok.extern.slf4j.Slf4j;
 import org.aspectj.lang.JoinPoint;
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.annotation.AfterReturning;
 import org.aspectj.lang.annotation.Around;
 import org.aspectj.lang.annotation.Aspect;
 import org.aspectj.lang.annotation.Pointcut;
+import org.aspectj.lang.reflect.CodeSignature;
 import org.slf4j.MDC;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
-import org.springframework.context.event.ContextRefreshedEvent;
-import org.springframework.context.event.EventListener;
-import org.springframework.core.env.AbstractEnvironment;
-import org.springframework.core.env.EnumerablePropertySource;
-import org.springframework.core.env.Environment;
-import org.springframework.core.env.MutablePropertySources;
 import org.springframework.http.ResponseEntity;
 import org.springframework.stereotype.Component;
 
 import javax.annotation.PostConstruct;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
-import java.util.Arrays;
-import java.util.stream.StreamSupport;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.UUID;
 
 @Aspect
 @Component
 @Slf4j
 public class LoggingAspect {
 
-    public static final String START_TIME = "startTime";
-    public static final String METHOD = "method";
-    public static final String STATUS = "status";
-    public static final String CODE = "httpCode";
-    public static final String RESPONSE_TIME = "responseTime";
-
-    @Value("${info.application.artifactId}")
-    private String artifactId;
-
-    @Value("${info.application.version}")
-    private String version;
-
-    @Value("${info.properties.environment}")
-    private String environment;
-
-    @Autowired
-    HttpServletRequest httRequest;
-
-    @Autowired
-    HttpServletResponse httpResponse;
-
-    @Pointcut("@within(org.springframework.web.bind.annotation.RestController)")
-    public void restController() {
-        // all rest controllers
+  public static final String START_TIME = "startTime";
+  public static final String METHOD = "method";
+  public static final String STATUS = "status";
+  public static final String CODE = "httpCode";
+  public static final String RESPONSE_TIME = "responseTime";
+  public static final String RESPONSE = "response";
+  public static final String FAULT_CODE = "faultCode";
+  public static final String FAULT_DETAIL = "faultDetail";
+  public static final String REQUEST_ID = "requestId";
+  public static final String OPERATION_ID = "operationId";
+  public static final String ARGS = "args";
+
+  @Autowired
+  HttpServletRequest httRequest;
+
+  @Autowired
+  HttpServletResponse httpResponse;
+
+  @Value("${info.application.name}")
+  private String name;
+
+  @Value("${info.application.version}")
+  private String version;
+
+  @Value("${info.properties.environment}")
+  private String environment;
+
+
+  @Pointcut("@within(org.springframework.web.bind.annotation.RestController)")
+  public void restController() {
+    // all rest controllers
+  }
+
+  @Pointcut("@within(org.springframework.stereotype.Repository)")
+  public void repository() {
+    // all repository methods
+  }
+
+  @Pointcut("@within(org.springframework.stereotype.Service)")
+  public void service() {
+    // all service methods
+  }
+
+  @Pointcut("execution(* *..client.*(..))")
+  public void client() {
+    // all service methods
+  }
+
+  /**
+   * Log essential info of application during the startup.
+   */
+  @PostConstruct
+  public void logStartup() {
+    log.info("-> Starting {} version {} - environment {}", name, version, environment);
+  }
+
+  @Around(value = "restController()")
+  public Object logApiInvocation(ProceedingJoinPoint joinPoint) throws Throwable {
+    MDC.put(METHOD, joinPoint.getSignature().getName());
+    MDC.put(START_TIME, String.valueOf(System.currentTimeMillis()));
+    MDC.put(OPERATION_ID, UUID.randomUUID().toString());
+    if(MDC.get(REQUEST_ID) == null) {
+      var requestId = UUID.randomUUID().toString();
+      MDC.put(REQUEST_ID, requestId);
     }
-
-    @Pointcut("@within(org.springframework.stereotype.Repository)")
-    public void repository() {
-        // all repository methods
+    String params = getParams(joinPoint);
+    MDC.put(ARGS, getParams(joinPoint));
+
+    log.info("Invoking API operation {} - args: {}", joinPoint.getSignature().getName(), params);
+
+    Object result = joinPoint.proceed();
+
+    MDC.put(STATUS, "OK");
+    MDC.put(CODE, String.valueOf(httpResponse.getStatus()));
+    MDC.put(RESPONSE_TIME, getExecutionTime());
+    MDC.put(RESPONSE, toJsonString(result));
+    log.info("Successful API operation {} - result: {}", joinPoint.getSignature().getName(), result);
+    MDC.remove(RESPONSE);
+    MDC.remove(STATUS);
+    MDC.remove(CODE);
+    MDC.remove(RESPONSE_TIME);
+    MDC.remove(START_TIME);
+    return result;
+  }
+
+  @AfterReturning(value = "execution(* *..exception.ErrorHandler.*(..))", returning = "result")
+  public void trowingApiInvocation(JoinPoint joinPoint, ResponseEntity<ProblemJson> result) {
+    MDC.put(STATUS, "KO");
+    MDC.put(CODE, String.valueOf(result.getStatusCodeValue()));
+    MDC.put(RESPONSE_TIME, getExecutionTime());
+    MDC.put(RESPONSE, toJsonString(result));
+    MDC.put(FAULT_CODE, getTitle(result));
+    MDC.put(FAULT_DETAIL, getDetail(result));
+    log.info("Failed API operation {} - error: {}", MDC.get(METHOD), result);
+    MDC.clear();
+  }
+
+  @Around(value = "repository() || service() || client()")
+  public Object logTrace(ProceedingJoinPoint joinPoint) throws Throwable {
+    String params = getParams(joinPoint);
+    log.debug("Call method {} - args: {}", joinPoint.getSignature().toShortString(), params);
+    Object result = joinPoint.proceed();
+    log.debug("Return method {} - result: {}", joinPoint.getSignature().toShortString(), result);
+    return result;
+  }
+
+  private static String getDetail(ResponseEntity<ProblemJson> result) {
+    if(result != null && result.getBody() != null && result.getBody().getDetail() != null) {
+      return result.getBody().getDetail();
+    } else return AppError.UNKNOWN.getDetails();
+  }
+
+  private static String getTitle(ResponseEntity<ProblemJson> result) {
+    if(result != null && result.getBody() != null && result.getBody().getTitle() != null) {
+      return result.getBody().getTitle();
+    } else return AppError.UNKNOWN.getTitle();
+  }
+
+  public static String getExecutionTime() {
+    String startTime = MDC.get(START_TIME);
+    if(startTime != null) {
+      long endTime = System.currentTimeMillis();
+      long executionTime = endTime - Long.parseLong(startTime);
+      return String.valueOf(executionTime);
     }
-
-    @Pointcut("@within(org.springframework.stereotype.Service)")
-    public void service() {
-        // all service methods
-    }
-
-    /**
-     * Log essential info of application during the startup.
-     */
-    @PostConstruct
-    public void logStartup() {
-        log.info("-> Starting {} version {} - environment {}", artifactId, version, environment);
+    return "-";
+  }
+
+  private static String getParams(ProceedingJoinPoint joinPoint) {
+    CodeSignature codeSignature = (CodeSignature) joinPoint.getSignature();
+    Map<String, Object> params = new HashMap<>();
+    int i = 0;
+    for (var paramName : codeSignature.getParameterNames()) {
+      Object param = joinPoint.getArgs()[i++];
+      params.put(paramName, param);
     }
-
-    /**
-     * If DEBUG log-level is enabled prints the env variables and the application properties.
-     *
-     * @param event Context of application
-     */
-    @EventListener
-    public void handleContextRefresh(ContextRefreshedEvent event) {
-        final Environment env = event.getApplicationContext().getEnvironment();
-        log.debug("Active profiles: {}", Arrays.toString(env.getActiveProfiles()));
-        final MutablePropertySources sources = ((AbstractEnvironment) env).getPropertySources();
-        StreamSupport.stream(sources.spliterator(), false)
-                .filter(EnumerablePropertySource.class::isInstance)
-                .map(ps -> ((EnumerablePropertySource<?>) ps).getPropertyNames())
-                .flatMap(Arrays::stream)
-                .distinct()
-                .filter(
-                        prop ->
-                                !(prop.toLowerCase().contains("credentials")
-                                        || prop.toLowerCase().contains("password")
-                                        || prop.toLowerCase().contains("pass")
-                                        || prop.toLowerCase().contains("pwd")
-                                        || prop.toLowerCase().contains("key")
-                                        || prop.toLowerCase().contains("secret")))
-                .forEach(prop -> log.debug("{}: {}", prop, env.getProperty(prop)));
-    }
-
-    @Around(value = "restController()")
-    public Object logApiInvocation(ProceedingJoinPoint joinPoint) throws Throwable {
-        MDC.put(METHOD, joinPoint.getSignature().getName());
-        MDC.put(START_TIME, String.valueOf(System.currentTimeMillis()));
-        log.info("{} {}", httRequest.getMethod(), httRequest.getRequestURI());
-        log.info(
-                "Invoking API operation {} - args: {}",
-                joinPoint.getSignature().getName(),
-                joinPoint.getArgs());
-
-        Object result = joinPoint.proceed();
-
-        MDC.put(STATUS, "OK");
-        MDC.put(CODE, String.valueOf(httpResponse.getStatus()));
-        MDC.put(RESPONSE_TIME, getExecutionTime());
-        log.info(
-                "Successful API operation {} - result: {}", joinPoint.getSignature().getName(), result);
-        MDC.remove(STATUS);
-        MDC.remove(CODE);
-        MDC.remove(RESPONSE_TIME);
-        MDC.remove(START_TIME);
-        return result;
-    }
-
-    @AfterReturning(value = "execution(* *..exception.ErrorHandler.*(..))", returning = "result")
-    public void trowingApiInvocation(JoinPoint joinPoint, ResponseEntity<?> result) {
-        MDC.put(STATUS, "KO");
-        MDC.put(CODE, String.valueOf(result.getStatusCodeValue()));
-        MDC.put(RESPONSE_TIME, getExecutionTime());
-        log.info("Failed API operation {} - error: {}", MDC.get(METHOD), result);
-        MDC.remove(STATUS);
-        MDC.remove(CODE);
-        MDC.remove(RESPONSE_TIME);
-        MDC.remove(START_TIME);
-    }
-
-    @Around(value = "repository() || service()")
-    public Object logTrace(ProceedingJoinPoint joinPoint) throws Throwable {
-        log.debug(
-                "Call method {} - args: {}", joinPoint.getSignature().toShortString(), joinPoint.getArgs());
-        Object result = joinPoint.proceed();
-        log.debug("Return method {} - result: {}", joinPoint.getSignature().toShortString(), result);
-        return result;
-    }
-
-    private static String getExecutionTime() {
-        String startTime = MDC.get(START_TIME);
-        if(startTime != null) {
-            long endTime = System.currentTimeMillis();
-            long executionTime = endTime - Long.parseLong(startTime);
-            return String.valueOf(executionTime);
-        }
-        return "1";
+    return toJsonString(params);
+
+  }
+
+  private static String toJsonString(Object param) {
+    try {
+      return new ObjectMapper()
+          .registerModule(new JavaTimeModule())
+          .writeValueAsString(param);
+    } catch (JsonProcessingException e) {
+      log.warn("An error occurred when trying to parse a parameter", e);
+      return "parsing error";
     }
+  }
 }
diff --git a/src/main/java/it/gov/pagopa/afm/calculator/exception/AppError.java b/src/main/java/it/gov/pagopa/afm/calculator/exception/AppError.java
@@ -5,12 +5,15 @@
 
 @Getter
 public enum AppError {
+
   ISSUERS_BIN_WITH_DIFFERENT_ABI_ERROR(
       HttpStatus.UNPROCESSABLE_ENTITY,
       "Issuers BIN with different ABI values found",
       "Found ABI with different value for BIN %s"),
   INTERNAL_SERVER_ERROR(
-      HttpStatus.INTERNAL_SERVER_ERROR, "Internal Server Error", "Something was wrong");
+      HttpStatus.INTERNAL_SERVER_ERROR, "Internal Server Error", "Something was wrong"),
+
+  UNKNOWN(null, null, null);
 
   public final HttpStatus httpStatus;
   public final String title;