如何配置Log4J在日志超过阈值时自动截断消息尾部？

方法一：利用Log4J2内置截断功能（快速实现） #

Log4J2的PatternLayout自带%maxLen格式符，可直接指定日志消息的最大长度，超过阈值自动截断尾部，无需额外编码。

• 核心语法：%maxLen{<阈值长度>}{<消息模板>}，默认截断尾部；若需添加截断标记，可扩展为%maxLen{<阈值长度>}{<消息模板>}{<截断标记>}
• 示例配置（log4j2.xml）：

<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <!-- 截断到100字符，超过部分加...标记 -->
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %maxLen{100}{%msg}{...}%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

方法二：自定义转换器（适配复杂需求） #

如果内置功能无法满足特殊逻辑（比如按字节数截断、自定义截断规则），可以实现自定义LogEventPatternConverter：

1. 编写自定义转换器类：

import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.pattern.LogEventPatternConverter;
import org.apache.logging.log4j.core.pattern.PatternConverter;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;

@Plugin(name = "TruncMsgConverter", category = PatternConverter.CATEGORY)
public class TruncMsgConverter extends LogEventPatternConverter {

    private final int maxLength;
    private final String truncSuffix;

    private TruncMsgConverter(int maxLength, String truncSuffix) {
        super("TruncMsg", "truncMsg");
        this.maxLength = maxLength;
        this.truncSuffix = truncSuffix == null ? "..." : truncSuffix;
    }

    @PluginFactory
    public static TruncMsgConverter newInstance(
            @PluginAttribute(value = "maxLength", defaultInt = 100) int maxLength,
            @PluginAttribute(value = "suffix", defaultString = "...") String suffix) {
        return new TruncMsgConverter(maxLength, suffix);
    }

    @Override
    public void format(LogEvent event, StringBuilder toAppendTo) {
        String rawMsg = event.getMessage().getFormattedMessage();
        if (rawMsg.length() <= maxLength) {
            toAppendTo.append(rawMsg);
            return;
        }
        // 预留后缀长度，避免截断后标记溢出
        int actualTruncLen = maxLength - truncSuffix.length();
        String truncated = rawMsg.substring(0, actualTruncLen) + truncSuffix;
        toAppendTo.append(truncated);
    }
}

2. 在配置文件中引用自定义转换器：

<Configuration status="WARN" packages="com.your.package"> <!-- 替换为转换器所在包路径 -->
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %truncMsg{200}{[已截断]}%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

注意事项 #

• Log4J 1.x无内置截断功能，建议升级至Log4J2（Log4J1已停止维护）；若需兼容1.x，需自定义Layout实现截断逻辑
• 默认按字符数截断，若需按字节数控制，需在自定义转换器中处理字符编码（如UTF-8中文占3字节）

内容的提问来源于stack exchange，提问作者Ajitesh Mandal