Log4j2 custom layout

Viewed 15920

I am using Log4j2 with a PatternLayout. Is it possible to write my own Layout that extends AbstractStringLayout, so that I can customize my output message?

I have read the docs but I only see variations of layouts - no custom one.

https://logging.apache.org/log4j/2.x/manual/layouts.html

2 Answers
package com.mytest;
@Plugin(name = "MyHtmlLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = true)

public class MyHtmlLayout  extends AbstractStringLayout{
    protected MyHtmlLayout( Charset charset ){
        super( charset );
    }

    @Override
    public String toSerializable( LogEvent event ) {
        StringBuilder throwable = new StringBuilder();
        if (event.getThrown() != null) {
            StringWriter sw = new StringWriter();
            PrintWriter pw = new PrintWriter(sw);
            pw.println();
            event.getThrown().printStackTrace(pw);
            pw.close();
            throwable.append(sw.toString());
        }
        StringBuilder retValue=new StringBuilder();
        retValue.append("<tr><td>").append(new SimpleDateFormat("dd-MM-yyyy HH:mm:ss:S").format(event.getTimeMillis())).append(" ")
        .append(event.getLevel().toString()).append(" ").append(event.getLoggerName()).append(" ").append(event.getMessage().getFormattedMessage()).append(" ").append(throwable).append("</tr></td>\n");

        return retValue.toString();
    }

    @PluginFactory
    public static MyHtmlLayout createLayout(@PluginAttribute(value = "charset", defaultString = "UTF-8") Charset charset) {
        return new MyHtmlLayout(charset);
    }
    @Override
    public byte[] getHeader() {
        return ("<html>\n  <body>\n" + "<Table>\n").getBytes();
    }
    @Override
    public byte[] getFooter() {
        return ("</table>\n</body>\n</html>").getBytes();
    }
}

Configuration file:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="DEBUG" packages="com.mytest" name="NewCustLayout">
    <Appenders>
        <Console name="LogToConsole" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>

        
        <RollingFile name="LogToRollingFile" fileName="logs/app.html"
                     filePattern="logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz">
            <!-- <PatternLayout>
                <Pattern>%d %p %C{1.} [%t] %m%n</Pattern>
            </PatternLayout>-->
            <MyHtmlLayout/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
            <DefaultRolloverStrategy max="100"/>
        </RollingFile>
    </Appenders>
    <Loggers>
        <!-- avoid duplicated logs with additivity=false -->
        <Logger name="com.psx.logtest" level="debug" additivity="false">
            <AppenderRef ref="LogToRollingFile"/>
        </Logger>
        <Root level="error">
            <AppenderRef ref="LogToConsole"/>
        </Root>
    </Loggers>
</Configuration>
Related