aboutsummaryrefslogtreecommitdiffstats
path: root/cps-service/src/main/java/org/onap/cps/aop/CpsLoggingAspectService.java
blob: b5fe0abaea59d913f237d3cd01c47b27d69634a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/*
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2022 Nordix Foundation
 *  ================================================================================
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *  SPDX-License-Identifier: Apache-2.0
 *  ============LICENSE_END=========================================================
 */

package org.onap.cps.aop;

import java.util.Arrays;
import java.util.logging.Level;
import java.util.logging.Logger;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
import org.springframework.util.StopWatch;

@Aspect
@Component
@Slf4j
public class CpsLoggingAspectService {

    private static final String CPS_PACKAGE_NAME = "org.onap.cps";
    private static final String ALL_CPS_METHODS = "execution(* " + CPS_PACKAGE_NAME + "..*(..)))";

    /**
     * To measure method execution time as a logging.
     *
     * @param proceedingJoinPoint exposes the proceed(..) method in order to support around advice.
     * @return empty in case of void otherwise an object of return type
     */
    @Around(ALL_CPS_METHODS)
    @SneakyThrows
    public Object logMethodExecutionTime(final ProceedingJoinPoint proceedingJoinPoint) {
        if (isSlf4JDebugEnabled()) {
            final StopWatch stopWatch = new StopWatch();
            //Calculate method execution time
            stopWatch.start();
            final Object returnValue = proceedingJoinPoint.proceed();
            stopWatch.stop();
            final MethodSignature methodSignature = (MethodSignature) proceedingJoinPoint.getSignature();
            //Log method execution time
            log.debug("Execution time of : {}.{}() with argument[s] = {} having result = {} :: {} ms",
                    methodSignature.getDeclaringType().getSimpleName(),
                    methodSignature.getName(), Arrays.toString(proceedingJoinPoint.getArgs()), returnValue,
                    stopWatch.getTotalTimeMillis());
            return returnValue;
        }
        return proceedingJoinPoint.proceed();
    }

    private static boolean isSlf4JDebugEnabled() {
        return Logger.getLogger(CPS_PACKAGE_NAME).isLoggable(Level.FINE);
    }

}