com.amazonaws.services.lambda.runtime.log4j2.LambdaAppender Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-lambda-java-log4j2 Show documentation

Support for using Log4j 2.x with AWS Lambda.

There is a newer version: 1.6.0

Show newest version

package com.amazonaws.services.lambda.runtime.log4j2;

import com.amazonaws.services.lambda.runtime.LambdaRuntime;
import com.amazonaws.services.lambda.runtime.LambdaRuntimeInternal;
import com.amazonaws.services.lambda.runtime.LambdaLogger;

import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.Layout;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.appender.AbstractAppender;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;

import java.io.Serializable;

/**
 * Class to append log4j2 logs from AWS Lambda function to CloudWatch
 * Created by adsuresh on 6/9/17.
 */
@Plugin(name = LambdaAppender.PLUGIN_NAME, category = LambdaAppender.PLUGIN_CATEGORY,
        elementType = LambdaAppender.PLUGIN_TYPE, printObject = true)
public class LambdaAppender extends AbstractAppender {

    public static final String PLUGIN_NAME = "Lambda";
    public static final String PLUGIN_CATEGORY = "Core";
    public static final String PLUGIN_TYPE = "appender";

    private LambdaLogger logger = LambdaRuntime.getLogger();

    /**
     * Builder class that follows log4j2 plugin convention
     * @param  Generic Builder class
     */
    public static class Builder> extends AbstractAppender.Builder
            implements org.apache.logging.log4j.core.util.Builder {

        /**
         * creates a new LambdaAppender
         * @return a new LambdaAppender
         */
        public LambdaAppender build() {
            return new LambdaAppender(super.getName(), super.getFilter(), super.getOrCreateLayout(),
                    super.isIgnoreExceptions());
        }
    }

    /**
     * Method used by log4j2 to access this appender
     * @param  Generic Builder class
     * @return LambdaAppender Builder
     */
    @PluginBuilderFactory
    public static > B newBuilder() {
        return new Builder().asBuilder();
    }

    /**
     * Constructor method following AbstractAppender convention
     * @param name name of appender
     * @param filter filter specified in xml
     * @param layout layout specified in xml
     * @param ignoreExceptions whether to show exceptions or not specified in xml
     */
    private LambdaAppender(String name, Filter filter, Layout layout, boolean ignoreExceptions) {
        super(name, filter, layout, ignoreExceptions);
        LambdaRuntimeInternal.setUseLog4jAppender(true);
    }

    /**
     * Append log event to System.out
     * @param event log4j event
     */
    public void append(LogEvent event) {
        logger.log(super.getLayout().toByteArray(event));
    }
}