AbstractFalconAspect.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

package org.apache.falcon.aspect;

import org.apache.falcon.util.ResourcesReflectionUtil;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.HashMap;
import java.util.Map;

/**
 * Abstract Falcon Aspect, which intercept methods annotated with Monitored and
 * publishes messages. Subclasses should override publishMessage Method.
 */
@Aspect
public abstract class AbstractFalconAspect {

    private static final Logger LOG = LoggerFactory.getLogger(AbstractFalconAspect.class);

    @Around("@annotation(org.apache.falcon.monitors.Monitored)")
    public Object logAroundMonitored(ProceedingJoinPoint joinPoint) throws Throwable {

        String methodName = joinPoint.getSignature().getName();
        Object[] args = joinPoint.getArgs();
        Object result;
        ResourceMessage.Status status;

        long startTime = System.nanoTime();
        long endTime;
        try {
            result = joinPoint.proceed();
        } catch (Exception e) {
            endTime = System.nanoTime();
            status = ResourceMessage.Status.FAILED;
            publishMessage(getResourceMessage(
                    joinPoint.getSignature().getDeclaringType().getSimpleName()
                    + "." + methodName, args, status, endTime - startTime));
            throw e;
        }
        endTime = System.nanoTime();
        status = ResourceMessage.Status.SUCCEEDED;
        publishMessage(getResourceMessage(joinPoint.getSignature()
                .getDeclaringType().getSimpleName()
                + "." + methodName, args, status, endTime - startTime));
        return result;
    }

    private ResourceMessage getResourceMessage(String methodName, Object[] args,
                                               ResourceMessage.Status status, long executionTime) {
        String action = ResourcesReflectionUtil.getResourceMonitorName(methodName);

        assert action != null : "Method :" + methodName + " not parsed by reflection util";
        Map<String, String> dimensions = new HashMap<String, String>();

        if (ResourcesReflectionUtil.getResourceDimensionsName(methodName) == null) {
            LOG.warn("Class for method name: {} is not added to ResourcesReflectionUtil", methodName);
        } else {
            for (Map.Entry<Integer, String> param : ResourcesReflectionUtil
                    .getResourceDimensionsName(methodName).entrySet()) {
                dimensions.put(param.getValue(),
                        args[param.getKey()] == null ? "NULL" : args[param.getKey()].toString());
            }
        }

        Integer timeTakenArg = ResourcesReflectionUtil.getResourceTimeTakenName(methodName);
        return timeTakenArg == null ? new ResourceMessage(action, dimensions, status, executionTime)
            : new ResourceMessage(action, dimensions, status, Long.parseLong(args[timeTakenArg].toString()));
    }

    public abstract void publishMessage(ResourceMessage message);

    @Around("@annotation(org.apache.falcon.monitors.Alert)")
    public Object logAroundAlert(ProceedingJoinPoint joinPoint) throws Throwable {

        String methodName = joinPoint.getSignature().getName();
        String event = ResourcesReflectionUtil.getResourceMonitorName(
                joinPoint.getSignature().getDeclaringType().getSimpleName() + "." + methodName);
        Object[] args = joinPoint.getArgs();
        Object result;

        try {
            result = joinPoint.proceed();
        } finally {
            AlertMessage alertMessage = new AlertMessage(
                    event, args[0].toString(), args[1].toString());
            publishAlert(alertMessage);
        }

        return result;
    }

    public abstract void publishAlert(AlertMessage alertMessage);

    @Around("@annotation(org.apache.falcon.monitors.Auditable)")
    public Object logAroundAudit(ProceedingJoinPoint joinPoint) throws Throwable {
        Object[] args = joinPoint.getArgs();
        Object result;

        try {
            result = joinPoint.proceed();
        } finally {

            AuditMessage auditMessage = new AuditMessage(
                 getStringValue(args[0], "Unknown-User"),
                 getStringValue(args[1], "Unknown-Address"),
                 getStringValue(args[2], "Unknown-Host"),
                 getStringValue(args[3], "Unknown-URL"),
                 getStringValue(args[4], "Unknown-Address"),
                 getStringValue(args[5], "Unknown-Time"));
            publishAudit(auditMessage);
        }

        return result;
    }

    private String getStringValue(Object value, String defaultValue) {
        return value == null ? defaultValue : value.toString();
    }

    public abstract void publishAudit(AuditMessage auditMessage);
}