io.github.philkes.slf4j.callerinfo.Slf4jCallerInfoMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of slf4j-caller-info-maven-plugin Show documentation
Maven plugin adding caller-information to all SLF4J Log statements during compilation
The newest version!
package io.github.philkes.slf4j.callerinfo;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.slf4j.event.Level;

import java.io.File;
import java.io.IOException;
import java.util.*;
import java.util.stream.Collectors;

import static io.github.philkes.slf4j.callerinfo.AddCallerInfoToLogsVisitor.INJECTED_METHOD_PATTERN;
import static io.github.philkes.slf4j.callerinfo.AddCallerInfoToLogsVisitor.SLF4J_LOGGER_FQN;

/**
 * Mojo to scan the code for SLF4J Log statements and inject caller-information
 * into the log via the Mapped Diagnostic Context
 */
@Mojo(name = "inject", defaultPhase = LifecyclePhase.PROCESS_CLASSES)
public class Slf4jCallerInfoMojo extends AbstractMojo {

    /**
     * Injected pattern, can include any conversion words ('%class','%line','%method')
     */
    @Parameter(defaultValue = "%class:%line")
    String injection;

    /**
     * Name of the used MDC parameter in the logging-pattern
     */
    @Parameter(defaultValue = "callerInformation")
    String injectionMdcParameter;

    /**
     * Whether or not to print the package-name of the class, if '%class' is present in 'injection' parameter
     */
    @Parameter(defaultValue = "false")
    boolean includePackageName;

    /**
     * Target directory which contains the compiled '.class' files, defaults to project class target dir ('target/classes')
     */
    @Parameter(defaultValue = "${project.build.outputDirectory}")
    File target;

    /**
     * Regex filters to only inject into specific Java classes
     */
    @Parameter
    ClassFilters filters = ClassFilters.DEFAULT_FILTERS;

    /**
     * List of Regex to specify to which method calls the caller-information should be injected to.
     * 

     * Format: {@code /#}
     */
    @Parameter
    List injectedMethods = Arrays.stream(Level.values()).map
            (level -> String.format(INJECTED_METHOD_PATTERN, SLF4J_LOGGER_FQN, level.toString().toLowerCase())).collect(Collectors.toList()
    );


    public void execute() throws MojoExecutionException {
        Log log = getLog();
        if (injection.isEmpty() || (injectedMethods != null) && injectedMethods.isEmpty()) {
            log.warn("'injection' or 'injectedMethods' is set to empty, therefore execution is skipped.");
            return;
        } else {
            String testFormat = injection;
            for (String conversionWord : AddCallerInfoToLogsVisitor.CONVERSIONS) {
                testFormat = testFormat.replace(conversionWord, "");
            }
            if (testFormat.contains("%")) {
                log.warn("There is a `%` character in the 'injection' parameter," +
                        " without a valid conversion word afterwards, the '%' will be printed in the log statement.");
                log.warn(String.format("Available conversion words: %s, current 'injection': %s", String.join(", ", AddCallerInfoToLogsVisitor.CONVERSIONS), injection));
            }
        }
        log.info(String.format("Make sure to add the MDC parameter '%s' to your logging pattern, otherwise they wont be printed in your logs", injectionMdcParameter));
        try {
            new CallerInfoLogsClassWriter(target, filters, injectionMdcParameter, injection, includePackageName, injectedMethods, log)
                    .execute();
        } catch (IOException e) {
            throw new RuntimeException(e);
        }

    }

}