cps-service/src/main/java/org/onap/cps/aop/CpsLoggingAspectService.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022 Nordix Foundation
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.aop;
  22
  23 import java.util.Arrays;
  24 import java.util.logging.Level;
  25 import java.util.logging.Logger;
  26 import lombok.SneakyThrows;
  27 import lombok.extern.slf4j.Slf4j;
  28 import org.aspectj.lang.ProceedingJoinPoint;
  29 import org.aspectj.lang.annotation.Around;
  30 import org.aspectj.lang.annotation.Aspect;
  31 import org.aspectj.lang.reflect.MethodSignature;
  32 import org.springframework.stereotype.Component;
  33 import org.springframework.util.StopWatch;
  34
  35 @Aspect
  36 @Component
  37 @Slf4j
  38 public class CpsLoggingAspectService {
  39
  40     private static final String CPS_PACKAGE_NAME = "org.onap.cps";
  41     private static final String ALL_CPS_METHODS = "execution(* " + CPS_PACKAGE_NAME + "..*(..)))";
  42
  43     /**
  44      * To measure method execution time as a logging.
  45      *
  46      * @param proceedingJoinPoint exposes the proceed(..) method in order to support around advice.
  47      * @return empty in case of void otherwise an object of return type
  48      */
  49     @Around(ALL_CPS_METHODS)
  50     @SneakyThrows
  51     public Object logMethodExecutionTime(final ProceedingJoinPoint proceedingJoinPoint) {
  52         if (isSlf4JDebugEnabled()) {
  53             final StopWatch stopWatch = new StopWatch();
  54             //Calculate method execution time
  55             stopWatch.start();
  56             final Object returnValue = proceedingJoinPoint.proceed();
  57             stopWatch.stop();
  58             final MethodSignature methodSignature = (MethodSignature) proceedingJoinPoint.getSignature();
  59             //Log method execution time
  60             log.debug("Execution time of : {}.{}() with argument[s] = {} having result = {} :: {} ms",
  61                     methodSignature.getDeclaringType().getSimpleName(),
  62                     methodSignature.getName(), Arrays.toString(proceedingJoinPoint.getArgs()), returnValue,
  63                     stopWatch.getTotalTimeMillis());
  64             return returnValue;
  65         }
  66         return proceedingJoinPoint.proceed();
  67     }
  68
  69     private static boolean isSlf4JDebugEnabled() {
  70         return Logger.getLogger(CPS_PACKAGE_NAME).isLoggable(Level.FINE);
  71     }
  72
  73 }