de.holisticon.util.tracee.contextlogger.watchdog.WatchdogAspect Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tracee-context-logger-watchdog Show documentation
Please refer to https://github.com/holisticon/tracee.
The newest version!
package de.holisticon.util.tracee.contextlogger.watchdog;


import de.holisticon.util.tracee.Tracee;
import de.holisticon.util.tracee.TraceeBackend;
import de.holisticon.util.tracee.contextlogger.ImplicitContext;
import de.holisticon.util.tracee.contextlogger.builder.TraceeContextLogger;
import de.holisticon.util.tracee.contextlogger.data.wrapper.WatchdogDataWrapper;
import de.holisticon.util.tracee.contextlogger.watchdog.util.WatchdogUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;

/**
 * Watchdog Assert class.
 * This aspects logs method calls of Watchdog annotated classes and methods in case of an exception is thrown during the execution of the method.
 * 
 * Created by Tobias Gindler, holisticon AG on 16.02.14.
 */

@Aspect
public class WatchdogAspect {

    private final boolean active;

    public WatchdogAspect() {
        this(Boolean.valueOf(System.getProperty(Constants.SYSTEM_PROPERTY_IS_ACTIVE, "true")));
    }

    WatchdogAspect(boolean active) {
        this.active = active;
    }


    @SuppressWarnings("unused")
    @Pointcut("(execution(* *(..)) && @annotation(de.holisticon.util.tracee.contextlogger.watchdog.Watchdog))")
    void withinWatchdogAnnotatedMethods() {
    }

    @SuppressWarnings("unused")
    @Pointcut("within(@de.holisticon.util.tracee.contextlogger.watchdog.Watchdog *)")
    void withinClassWithWatchdogAnnotation() {

    }

    @SuppressWarnings("unused")
    @Pointcut("execution(public * *(..))")
    void publicMethods() {

    }

    @SuppressWarnings("unused")
    @Around("withinWatchdogAnnotatedMethods() || (publicMethods() && withinClassWithWatchdogAnnotation()) ")
    public Object guard(final ProceedingJoinPoint proceedingJoinPoint) throws Throwable {

        try {
            return proceedingJoinPoint.proceed();
        } catch (final Throwable e) {

            // check if watchdog processing is flagged as active
            if (active) {

                // Now create toJson output
                final TraceeBackend traceeBackend = Tracee.getBackend();

                // make sure that original exception will be passed through
                try {

                    // get watchdog annotation
                    Watchdog watchdog = WatchdogUtils.getWatchdogAnnotation(proceedingJoinPoint);

                    // check if watchdog aspect processing is deactivated by annotation
                    if (WatchdogUtils.checkProcessWatchdog(watchdog, proceedingJoinPoint, e)) {

                            String annotatedId = watchdog.id().isEmpty() ? null : watchdog.id();
                            sendErrorReportToConnectors(traceeBackend, proceedingJoinPoint, annotatedId, e);
                            writeMethodCallToMdc(traceeBackend, proceedingJoinPoint, annotatedId);

                    }

                } catch (Throwable error) {
                    // will be ignored
                    traceeBackend.getLoggerFactory().getLogger(WatchdogAspect.class).error("error", error);
                }
            }
            // rethrow exception
            throw e;
        }

    }

    /**
     * Adds or enhances an mdc variable by call information.
     *
     * @param traceeBackend       the tracee backend
     * @param proceedingJoinPoint the aspectj calling context
     * @param annotatedId         the id defined in the watchdog annotation
     */
    void writeMethodCallToMdc(TraceeBackend traceeBackend, ProceedingJoinPoint proceedingJoinPoint, String annotatedId) {

        String json = TraceeContextLogger.createDefault().createJson(WatchdogDataWrapper.wrap(annotatedId, proceedingJoinPoint));
        String existingContent = traceeBackend.get(Constants.TRACEE_ATTRIBUTE_NAME);
        traceeBackend.put(Constants.TRACEE_ATTRIBUTE_NAME, existingContent != null ? existingContent + Constants.SEPARATOR + json : json);

    }

    /**
     * Sends the error reports to all connectors.
     *
     * @param traceeBackend       the tracee backend
     * @param proceedingJoinPoint the aspectj calling context
     * @param annotatedId         the id defined in the watchdog annotation
     */
    void sendErrorReportToConnectors(TraceeBackend traceeBackend, ProceedingJoinPoint proceedingJoinPoint, String annotatedId, Throwable e) {
        TraceeContextLogger.createDefault().logJsonWithPrefixedMessage("TRACEE WATCHDOG ERROR CONTEXT LISTENER :",
				ImplicitContext.COMMON, ImplicitContext.TRACEE, WatchdogDataWrapper.wrap(annotatedId, proceedingJoinPoint), e);
    }


}