log4j非常堆栈文件输出

目的：log4j非常堆栈关联到traceId一句话中，方便搜索
1、获取堆栈后一起打印

1. private void logException(Throwable t, ProceedingJoinPoint joinPoint) {
2.         if (this.printErrorStackSys) {
3.             StringWriter sw = new StringWriter();
4.             PrintWriter pw = new PrintWriter(sw);
5.             t.printStackTrace(pw);
6.             String errorMsg = sw.toString();
8.             log.error("error->" + errorMsg);
9.         } else {// 子定义打印
10.             Signature signature = joinPoint.getSignature();
11.             String service = signature.toShortString();
12.             StringBuilder builder = new StringBuilder();
13.             builder.append("\r\n========================================== \r\n");
14.             builder.append("Invoke exception!!! \r\n");
15.             builder.append("Service = ").append(service).append("\r\n");
17.             Throwable cause = t.getCause();
18.             while (cause != null) {
19.                 builder.append("\n\t\tCause: ").append(cause.getClass().getCanonicalName());
20.                 builder.append(": ").append(cause.getMessage());
21.                 cause = cause.getCause();
22.             }
24.             builder.append(" StackTrace=");
25.             StackTraceElement[] stackTraceElements = t.getStackTrace();
26.             for(int i = 0; i<stackTraceElements.length; i++){
27.                 StackTraceElement stackTrace = stackTraceElements[i];
28.                 builder.append(stackTrace.getClassName()).append(":").append(stackTrace.getMethodName()).append(":").append(stackTrace.getLineNumber()).append("\r\n;");
29.             }
30.             builder.append("\r\n==========================================");
32.             log.error(builder);
33.         }
34.     }

复制代码

效果示例：
利用printStackTrace方法打印

自界说打印

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

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

1. <!--控制台输出-->
2. <Console name="Console" target="SYSTEM_OUT">
3.                         <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS}|${ctx:uuid}|%t|%-5p|%c{1}:%L|%msg%n" />
4.                 </Console>
5. <!--文件输出-->
6.                 <RollingFile name="RollingFile" filename="${logPath}/${rollingLogName}.log" filepattern="${logPath}/%d{yyyyMMdd}/${rollingLogName}-%i.log">
7.                         <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'>
8.                         </PatternLayout>
9.                         <Policies>
10.                                 <TimeBasedTriggeringPolicy interval="1" modulate="true" />
11.                                 <SizeBasedTriggeringPolicy size="1024 MB" />
12.                         </Policies>
13.                         <DefaultRolloverStrategy max="100" />
14.                 </RollingFile>

复制代码

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

3、自界说格式化插件

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

1. import org.apache.logging.log4j.core.LogEvent;
2. import org.apache.logging.log4j.core.config.Configuration;
3. import org.apache.logging.log4j.core.config.plugins.Plugin;
4. import org.apache.logging.log4j.core.impl.LocationAware;
5. import org.apache.logging.log4j.core.pattern.ConverterKeys;
6. import org.apache.logging.log4j.core.pattern.ThrowablePatternConverter;
8. @Plugin(
9.         name = "CustomerThrowablePatternConverter",
10.         category = "Converter"
11. )
12. @ConverterKeys({"ct", "customerThrowable"})
14. public class CustomerThrowablePatternConverter extends ThrowablePatternConverter implements LocationAware {
16.     protected CustomerThrowablePatternConverter(String[] options, Configuration config) {
17.         super("CT", "CTStyle", options, config);
18.     }
20.     // 被触发的得到实例的方法
21.     public static CustomerThrowablePatternConverter newInstance(Configuration config, String[] options) {
22.         return new CustomerThrowablePatternConverter(options, config);
23.     }
24.     @Override
25.     public void format(LogEvent event, StringBuilder buffer) {
26.         Throwable thrown = event.getThrown();
27.         if (thrown != null && thrown instanceof CustomerException) {
28.             buffer.append("自定义异常");
29.         }
31.         super.format(event, buffer);
32.     }
34.     // 位置信息
35.     @Override
36.     public boolean requiresLocation() {
37.         return true;
38.     }
39. }

复制代码

  <atternLayout 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：表示一个日志变乱的类，将要输出的日志上下文信息封装成变乱。
  

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

复制代码

• RingBuffer：一个循环缓冲区，用于存储变乱数据。
  

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

复制代码

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

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

复制代码

• EventHandler：负责处理变乱的消费者类，界说了一个 onEvent 方法，该方法会在变乱预备好后被调用。
  

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

复制代码

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的子类举行格式化操纵拼接打印日志输出

1. // 异步输出日志方法重写
2. protected void log(LogEvent event, LoggerConfig.LoggerConfigPredicate predicate) {
3.         if (predicate == LoggerConfigPredicate.ALL && ASYNC_LOGGER_ENTERED.get() == Boolean.FALSE && this.hasAppenders()) {
4.             ASYNC_LOGGER_ENTERED.set(Boolean.TRUE);
6.             try {
7.                 super.log(event, LoggerConfigPredicate.SYNCHRONOUS_ONLY);
8.                 this.logToAsyncDelegate(event);
9.             } finally {
10.                 ASYNC_LOGGER_ENTERED.set(Boolean.FALSE);
11.             }
12.         } else {
13.             super.log(event, predicate);
14.         }
16.     }
17. //父类的方法，1、同步日志调用， 2、EventHandler回调使用
18. protected void log(LogEvent event, LoggerConfigPredicate predicate) {
19.         if (!this.isFiltered(event)) {
20.             this.processLogEvent(event, predicate);
21.         }
23.     }
24. // 日志处理--打印输出
25.   private void processLogEvent(LogEvent event, LoggerConfigPredicate predicate) {
26.         event.setIncludeLocation(this.isIncludeLocation());
27.         // 判断当前 ！config instanceof AsyncLoggerConfig是否为非异步
28.         if (predicate.allow(this)) {
29.         // 打印处理
30.             this.callAppenders(event);
31.         }
33.         this.logParent(event, predicate);
34.     }
35. // 队列处理
36. private void logToAsyncDelegate(LogEvent event) {
37.         if (!this.isFiltered(event)) {
38.             this.populateLazilyInitializedFields(event);
39.             // 发布序列号，添加到缓冲区
40.             if (!this.delegate.tryEnqueue(event, this)) {
41.             // 缓存区满了处理
42.                 this.handleQueueFull(event);
43.             }
44.         }
46.     }
49.   public void format(LogEvent event, StringBuilder buf) {
50.         if (this.skipFormattingInfo) {
51.             this.converter.format(event, buf);
52.         } else {
53.             this.formatWithInfo(event, buf);
54.         }
55.     }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。