当前位置：首页 > news >正文

log4j异常堆栈文件输出

news 2025/6/28 11:07:24

目的：log4j异常堆栈关联到traceId一句话中，方便搜索

1、获取堆栈后一起打印

 private void logException(Throwable t, ProceedingJoinPoint joinPoint) {if (this.printErrorStackSys) {StringWriter sw = new StringWriter();PrintWriter pw = new PrintWriter(sw);t.printStackTrace(pw);String errorMsg = sw.toString();log.error("error->" + errorMsg);} else {// 子定义打印Signature signature = joinPoint.getSignature();String service = signature.toShortString();StringBuilder builder = new StringBuilder();builder.append("\r\n========================================== \r\n");builder.append("Invoke exception!!! \r\n");builder.append("Service = ").append(service).append("\r\n");Throwable cause = t.getCause();while (cause != null) {builder.append("\n\t\tCause: ").append(cause.getClass().getCanonicalName());builder.append(": ").append(cause.getMessage());cause = cause.getCause();}builder.append(" StackTrace=");StackTraceElement[] stackTraceElements = t.getStackTrace();for(int i = 0; i<stackTraceElements.length; i++){StackTraceElement stackTrace = stackTraceElements[i];builder.append(stackTrace.getClassName()).append(":").append(stackTrace.getMethodName()).append(":").append(stackTrace.getLineNumber()).append("\r\n;");}builder.append("\r\n==========================================");log.error(builder);}}

结果示例：
使用printStackTrace方法打印
在这里插入图片描述

自定义打印
在这里插入图片描述

2、使用%throwable打印堆栈跟踪信息

%throwable 用于在日志配置文件中输出异常的堆栈跟踪信息。
它不是 XML 的标准标签或属性，而是日志框架中的占位符

<!--控制台输出-->
<Console name="Console" target="SYSTEM_OUT"><PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS}|${ctx:uuid}|%t|%-5p|%c{1}:%L|%msg%n" /></Console>
<!--文件输出--><RollingFile name="RollingFile" filename="${logPath}/${rollingLogName}.log" filepattern="${logPath}/%d{yyyyMMdd}/${rollingLogName}-%i.log"><PatternLayout pattern='{"time":"%d{yyyy-MM-dd HH:mm:ss.SSS}","thread":"%t","tid":"${ctx:uuid}","level":"%-5p","class_line":"%c:%L","msg":"{%msg}%throwable"}%n'></PatternLayout><Policies><TimeBasedTriggeringPolicy interval="1" modulate="true" /><SizeBasedTriggeringPolicy size="1024 MB" /></Policies><DefaultRolloverStrategy max="100" /></RollingFile>

%d{HH:mm:ss,SSS} 表示日期和时间。
[%t] 表示线程名称。
%-5p 表示日志级别，左对齐，宽度为 5。
%c{1} 表示日志记录器的名称，只显示最后一级。
:%L 表示日志记录器的行号。
%m 表示日志消息。
%throwable 表示异常的堆栈跟踪信息。
%n 表示换行符。

结果示例：
在这里插入图片描述

3、自定义格式化插件

这种方式与2一样，2使用的是ThrowablePatternConverter

import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.Configuration;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.impl.LocationAware;
import org.apache.logging.log4j.core.pattern.ConverterKeys;
import org.apache.logging.log4j.core.pattern.ThrowablePatternConverter;@Plugin(name = "CustomerThrowablePatternConverter",category = "Converter"
)
@ConverterKeys({"ct", "customerThrowable"})public class CustomerThrowablePatternConverter extends ThrowablePatternConverter implements LocationAware {protected CustomerThrowablePatternConverter(String[] options, Configuration config) {super("CT", "CTStyle", options, config);}// 被触发的得到实例的方法public static CustomerThrowablePatternConverter newInstance(Configuration config, String[] options) {return new CustomerThrowablePatternConverter(options, config);}@Overridepublic void format(LogEvent event, StringBuilder buffer) {Throwable thrown = event.getThrown();if (thrown != null && thrown instanceof CustomerException) {buffer.append("自定义异常");}super.format(event, buffer);}// 位置信息@Overridepublic boolean requiresLocation() {return true;}
}

<PatternLayout pattern=‘{“tid”:“${ctx:uuid}”,“time”:“%d{yyyy-MM-dd HH:mm:ss.SSS}”,“thread”:“%t”,“level”:“%-5p”,“class_line”:“%c:%L”,“msg”:“%enc{%msg-%customerThrowable}{JSON}”}%n’>

在这里插入图片描述

4、源码分析

Disruptor 是一个高性能的无锁并发框架，常用于异步日志记录、消息传递等场景。

LogEvent：表示一个日志事件的类，将要输出的日志上下文信息封装成事件。

 public LogEvent createEvent(String loggerName, Marker marker, String fqcn, StackTraceElement location, Level level, Message data, List<Property> properties, Throwable t) {return new Log4jLogEvent(loggerName, marker, fqcn, location, level, data, properties, t);}

RingBuffer：一个循环缓冲区，用于存储事件数据。

 private static final EventTranslatorTwoArg<Log4jEventWrapper, LogEvent, AsyncLoggerConfig> TRANSLATOR = new EventTranslatorTwoArg<Log4jEventWrapper, LogEvent, AsyncLoggerConfig>() {public void translateTo(Log4jEventWrapper ringBufferElement, long sequence, LogEvent logEvent, AsyncLoggerConfig loggerConfig) {ringBufferElement.event = logEvent;ringBufferElement.loggerConfig = loggerConfig;}};

Sequencer：负责管理和分配序列号的组件。方法用于发布一个序列号，表示某个事件已经准备好，可以被消费者线程处理。发布后的消息通常由一个或多个消费者类（也称为事件处理器或 EventHandler）进行消费。

private <A, B> void translateAndPublish(EventTranslatorTwoArg<E, A, B> translator, long sequence, A arg0, B arg1) {try {translator.translateTo(this.get(sequence), sequence, arg0, arg1);} finally {this.sequencer.publish(sequence);}}

EventHandler：负责处理事件的消费者类，定义了一个 onEvent 方法，该方法会在事件准备好后被调用。

   public void onEvent(Log4jEventWrapper event, long sequence, boolean endOfBatch) throws Exception {event.event.setEndOfBatch(endOfBatch);// 去消费event.loggerConfig.logToAsyncLoggerConfigsOnCurrentThread(event.event);event.clear();this.notifyIntermediateProgress(sequence);}

5、主要流程

org.apache.logging.log4j.core.async.AsyncLoggerConfig#log
->org.apache.logging.log4j.core.Logger#logMessage
->org.apache.logging.log4j.core.config.LoggerConfig#log(java.lang.String, java.lang.String, org.apache.logging.log4j.Marker, org.apache.logging.log4j.Level, org.apache.logging.log4j.message.Message, java.lang.Throwable)
->org.apache.logging.log4j.core.config.AwaitCompletionReliabilityStrategy#log(org.apache.logging.log4j.util.Supplier<org.apache.logging.log4j.core.config.LoggerConfig>, java.lang.String, java.lang.String, org.apache.logging.log4j.Marker, org.apache.logging.log4j.Level, org.apache.logging.log4j.message.Message, java.lang.Throwable)
->org.apache.logging.log4j.core.appender.RollingFileAppender#append
->org.apache.logging.log4j.core.layout.PatternLayout#encode
->org.apache.logging.log4j.core.layout.PatternLayout.PatternSerializer#toSerializable(org.apache.logging.log4j.core.LogEvent, java.lang.StringBuilder)
->LogEventPatternConverter的子类进行格式化操作拼接打印日志输出

// 异步输出日志方法重写protected void log(LogEvent event, LoggerConfig.LoggerConfigPredicate predicate) {if (predicate == LoggerConfigPredicate.ALL && ASYNC_LOGGER_ENTERED.get() == Boolean.FALSE && this.hasAppenders()) {ASYNC_LOGGER_ENTERED.set(Boolean.TRUE);try {super.log(event, LoggerConfigPredicate.SYNCHRONOUS_ONLY);this.logToAsyncDelegate(event);} finally {ASYNC_LOGGER_ENTERED.set(Boolean.FALSE);}} else {super.log(event, predicate);}}
//父类的方法，1、同步日志调用， 2、EventHandler回调使用protected void log(LogEvent event, LoggerConfigPredicate predicate) {if (!this.isFiltered(event)) {this.processLogEvent(event, predicate);}}
// 日志处理--打印输出private void processLogEvent(LogEvent event, LoggerConfigPredicate predicate) {event.setIncludeLocation(this.isIncludeLocation());// 判断当前 ！config instanceof AsyncLoggerConfig是否为非异步if (predicate.allow(this)) {// 打印处理this.callAppenders(event);}this.logParent(event, predicate);}
// 队列处理private void logToAsyncDelegate(LogEvent event) {if (!this.isFiltered(event)) {this.populateLazilyInitializedFields(event);// 发布序列号，添加到缓冲区if (!this.delegate.tryEnqueue(event, this)) {// 缓存区满了处理this.handleQueueFull(event);}}}public void format(LogEvent event, StringBuilder buf) {if (this.skipFormattingInfo) {this.converter.format(event, buf);} else {this.formatWithInfo(event, buf);}}