如何在日志中批量的添加业务ID埋点

很多系统的日志格式比较乱，没有一个统一的样式，而在系统已经成型的情况下，很难再大规模的去批量调整日志格式，所以设计了一个日志Util工具，在日志打印时嵌入指定的业务参数。

• 闲话少说，干货先上：
  LogUtil.java

   package com.alan.log.utils;
  
   import com.google.cmmon.base.Joiner;
   import org.apache.commons.lang3.StringUtils;
   import org.slf4j.MDC;
  
   /**
     * Created by alan on 2016/11/16.
     * 日志工具
    */
   public class LogUtil {
      private static final String BIZPARAM = "bizParam";
  
  /**
     * 设置日志中的业务参数
     *
     * @param bizId 业务ID
    */
  public static void setBizId(String... bizId) {
    String bizParam = MDC.get(BIZPARAM);
    if (StringUtils.isBlank(bizParam)) {
          bizParam = Joiner.on(",").skipNulls().join(bizId);
          MDC.put(BIZPARAM, bizParam);
    } else {
          StringBuilder sbd = new StringBuilder()
                    .append(bizParam)
                    .append(",")
                    .append(Joiner.on(",").skipNulls().join(bizId));
  
          MDC.put(BIZPARAM, sbd.toString());
    }
  }
  
  /**
    * 日志打点,加入清除原有数据的代码
    *
    * @param bizId 业务ID
   */
  public static void setBizIdWithClear(String... bizId) {
        MDC.clear();
        setBizId(bizId);
  }
  
  }
  

可以看到，logUtil使用了slf4j中的MDC来暂存bizId信息，关于MDC的说明，可以参考这里：http://logback.qos.ch/manual/mdc.html

至于提供的setBizIdWithClear方法，主要防止在线程池场景下线程复用时BizId串掉的问题出现。

• 如何调用
  目前采用的调用方式比较原始，在dubbo\rest Service方法、NSQ消息消费处理类入口中直接调用，如下：
  LogUtil.setBizIdWithClear(refundRequest.getAcquireNo(),refundRequest.getRequestId());

其中bizId可以根据自己系统中的不同考虑，传入不同的值，也可以传递多个。
当然，如果希望做的代码入侵性更小一些，可以考虑使用intercepter，或者针对web工程使用filter，或者直接使用切面来做。不过由于不同入口的bizId不尽相同，所以在这里就简单的做个调用。大家可以根据自己系统的情况选择不同的方式。

• 如何生效

既然记录在了MDC中，在写日志文化时如何记录下来呢？这块就需要配置对应的logback.xml或者log4j.xml了，如下：

     <appender name="STDOUT"  class="ch.qos.logback.core.ConsoleAppender">
       <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{bizParam}] %-5level %logger{56} - %msg%n
            </pattern>
      </encoder>
    </appender>   

这是一个普通的appender配置，关键就是在pattern格式表达式中的[%X{bizParam}]，bizParam需要与LogUtil中的BIZPARAM对应起来

• 最终的日志格式

      2016-11-18 16:13:39.022 [Thread-5] [161118105657385565] INFO  com.alan....
  

可以看到，对应的bizId已经按照对应的格式在日志中的固定位置打印出来了，后续做日志采集也好、日志搜索也好，都是会比较容易的。

PS：后续的日志采集、存储、搜索等功能，可以使用ES+LogStash+logView等开源框架，问题定位不要太爽。后续有时间会把这套日志处理框架写下，😀