微服務(wù)應(yīng)用日志處理與組件封裝

微服務(wù)應(yīng)用日志組件定制

隨著微服務(wù)等設(shè)計(jì)理念在系統(tǒng)中的應(yīng)用,業(yè)務(wù)的調(diào)用鏈越來越復(fù)雜,日志信息越來越大,從快速增長(zhǎng)的日志數(shù)據(jù)流中提取出所需的信息,并將其與其他相關(guān)聯(lián)的事件進(jìn)行關(guān)聯(lián),將變得越加困難。ELK+KafKa作為微服務(wù)應(yīng)用日志中心解決方案是業(yè)界常規(guī)辦法,前提是應(yīng)用日志輸出的規(guī)范化,日志組件就是為了完成這一目標(biāo)。

微服務(wù)應(yīng)用日志格式規(guī)劃

經(jīng)過公司技術(shù)人員充分討論和分析,確認(rèn)了應(yīng)用日志輸出格式如下:

|時(shí)間|日志級(jí)別|線程名|代碼發(fā)生行|同步調(diào)用ID|客戶系統(tǒng)節(jié)點(diǎn)|服務(wù)系統(tǒng)節(jié)點(diǎn)|客戶系統(tǒng)名稱|服務(wù)系統(tǒng)名稱|日志類型|全局流水號(hào)|定制化字段^日志信息|
  • 時(shí)間:記錄日志產(chǎn)生時(shí)間;
  • 日志級(jí)別:FATAL、ERROR、WARN、INFO、DEBUG;
  • 線程名:執(zhí)行操作線程名稱;
  • 代碼發(fā)生行:日志事件發(fā)生在代碼中位置;
  • 同步調(diào)用ID:用于同步調(diào)用鏈分析、可以關(guān)聯(lián)ZipKin、Pinpoint等工具關(guān)聯(lián)排查問題;
  • 客戶系統(tǒng)節(jié)點(diǎn):表示服務(wù)-客戶端系統(tǒng)節(jié)點(diǎn)的標(biāo)識(shí),可以為IP或者DockerID;
  • 服務(wù)系統(tǒng)節(jié)點(diǎn):表示服務(wù)-服務(wù)端系統(tǒng)節(jié)點(diǎn)的標(biāo)識(shí),可以為IP或者DockerID;
  • 客戶系統(tǒng)名稱:表示服務(wù)-客戶端系統(tǒng)的標(biāo)識(shí),可以為系統(tǒng)簡(jiǎn)稱和全稱;
  • 服務(wù)系統(tǒng)名稱:表示服務(wù)-服務(wù)端系統(tǒng)的標(biāo)識(shí),可以為系統(tǒng)簡(jiǎn)稱和全稱;
  • 全局流水號(hào):貫穿一次業(yè)務(wù)流程的全局流水號(hào);
  • 日志類型:枚舉,REQ-接口請(qǐng)求報(bào)文,RESP-接口響應(yīng)報(bào)文,BIZ-通用日志;
  • INFO:定制化字段(格式采用 關(guān)鍵字段=值,關(guān)鍵字段2=值) ^ 業(yè)務(wù)信息(記錄詳細(xì)日志信息)。

舉個(gè)栗子:

|2018-03-28 14:26:21.001|INFO|demo-service-woker:share-d-3[share]-thread-1|com.xxxx.xxx.service.interceptor.ParamCheckInterceptor:59:doInvoke|4507080825331412517041832|127.0.0.1:50344|127.0.0.1:20015|demo-a|demo-b|20170428142618325183APP|BIZ|phoneNumber=185****1234, woAccountId=110000008592138^參數(shù)及權(quán)限校驗(yàn)攔截,驗(yàn)證通過.|

日志組件實(shí)現(xiàn)方案

Java技術(shù)平臺(tái)日志輸出組件主要有java.util.logging、log4j、log4j2、logback、slf4j。我司目前使用的log4j2+slf4j組合作為應(yīng)用日志輸出組件,為了實(shí)現(xiàn)上述日志格式輸出,主要有兩種方式在組件上實(shí)現(xiàn)封裝。應(yīng)用采用SpringBoot+Restful作為主框架

Log4J的MDC方案

MDC[http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/MDC.html]是為每個(gè)線程建立一個(gè)獨(dú)立的存儲(chǔ)空間,開發(fā)人員可以根據(jù)需要把信息存入其中。MDC使用Map機(jī)制來存儲(chǔ)信息,信息以key/value對(duì)的形式存儲(chǔ)在Map中。
使用Servlet Filter或者AOP在服務(wù)接收到請(qǐng)求時(shí),獲取需要的值填充MDC。在log4j2的配置中就可以使用%X{key}打印MDC中的內(nèi)容,從而識(shí)別出同一次請(qǐng)求中的log。

Log4j2.X版本
MdcLogfilter類
public class MdcLogfilter implements Filter {

    public static final String TRACE_ID = "traceId";

    public static final String CLIENT_ADDR = "clientAddr";

    public static final String SERVER_ADDR = "serverAddr";

    public static final String CLIENT_SYS_NAME = "clientSysName";

    public static final String SERVER_SYS_NAME = "serverSysName";

    public static final String TRANS_ID = "transId";

    public static final String LOG_TYPE = LogTypeEnum.BIZ.getKey();

    private String systemName;

    public MdcLogfilter( String systemName ) {
        this.systemName = systemName;
    }

    @Override
    public void init( FilterConfig filterConfig ) throws ServletException {
    }

    @Override
    public void doFilter( ServletRequest request, ServletResponse response, FilterChain chain ) throws IOException, ServletException {
        try {
            insertIntoMDC(request);
            chain.doFilter(request, response);
        } finally {
            ThreadContext.clearAll();
        }
    }

    @Override
    public void destroy() {
    }

    protected void insertIntoMDC( ServletRequest request ) {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        String traceId = httpRequest.getHeader(TRACE_ID);
        String clientAddr = httpRequest.getRemoteAddr();
        String serverAddr = getSreverAddr();
        String clientSysName = httpRequest.getHeader(CLIENT_SYS_NAME);
        String serverSysName = systemName;
        String transId = (String) httpRequest.getAttribute(TRANS_ID);
        ThreadContext.put(TRACE_ID, traceId);
        ThreadContext.put(CLIENT_ADDR, clientAddr);
        ThreadContext.put(SERVER_ADDR, serverAddr);
        ThreadContext.put(CLIENT_SYS_NAME, clientSysName);
        ThreadContext.put(SERVER_SYS_NAME, serverSysName);
        ThreadContext.put(TRANS_ID, transId);
        ThreadContext.put(LOG_TYPE, LogTypeEnum.REQ.getKey());
    }

    private String getServerAddr() {
        return null;
    }

}

MDCLogAspect類
@Aspect
public class MDCLogAspect {

    private static final Logger LOGGER = LoggerFactory.getLogger(EpayLogAspect.class);

    private static long STIME = LogUtil.getNowTimeInMillis();

    private static String REQUESTURL = "url";

    @Pointcut("execution(public * com.demo..*.*.controller.*.*(..))")
    public void log() {
    }

    @Before("log()")
    public void deBefore( JoinPoint joinPoint ) throws Throwable {
        STIME = LogUtil.getNowTimeInMillis();
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        Map<String, String[]> params = request.getParameterMap();
        String queryString = "";
        for (String key : params.keySet()) {
            String[] values = params.get(key);
            for (int i = 0; i < values.length; i++) {
                String value = values[i];
                queryString += key + "=" + value + "&";
            }
        }
        
        if (!StringUtils.isEmpty(queryString)){
            queryString = queryString.substring(0, queryString.length() - 1);
        }
        REQUESTURL = request.getRequestURL().toString();

        LOGGER.info("url:{},req:{}", REQUESTURL, queryString);
        MDC.put(LogPreKeyConstants.LOGTYPE, LogTypeEnum.BIZ.getKey());
    }

    @AfterReturning(returning = "ret", pointcut = "log()")
    public void doAfterReturning( Object ret ) throws Throwable {
        MDC.put(LogPreKeyConstants.LOGTYPE, LogTypeEnum.RESP.getKey());
        LOGGER.info("url:{},resp:{}", REQUESTURL, ret);
        MDC.remove(LogPreKeyConstants.LOGTYPE);
        MDC.put(LogPreKeyConstants.LOGTYPE, LogTypeEnum.BIZ.getKey());
    }

    //后置異常通知
    @AfterThrowing("log()")
    public void throwss( JoinPoint jp ) {
        String costtime = LogUtil.getNowTimeInMillis() - STIME + "ms";
        LOGGER.info("url:{},executetime:{}", REQUESTURL, costtime);
    }

    //后置最終通知,final增強(qiáng),不管是拋出異常或者正常退出都會(huì)執(zhí)行
    @After("log()")
    public void after( JoinPoint jp ) {
        String costtime = LogUtil.getNowTimeInMillis() - STIME + "ms";
        LOGGER.info("url:{},executetime:{}", REQUESTURL, costtime);
    }
}

Log4j1.X版本

log4j1.x版本,ThreadContext類換成MDC即可

log4j配置使用MDC

在log4j配置中,使用mdc:(log4j 1.x 與 2.x中都可以使用此配置)

<PatternLayout pattern="|%d{yyyy-MM-dd HH:mm:ss.SSS}|%5p|%5t|%4c:%L|%X{traceid}|%X{clientaddr}|%X{serveraddr}|%X{cientsysname}|%X{serversysname}|%X{transid}|%X{logType}|%m|%n" />
Springboot使用

實(shí)現(xiàn)定制化log-start,應(yīng)用依賴即可。

Log4J的適配器封裝方案

使用適配器模式封裝log4j接口,使用AOP在服務(wù)接收到請(qǐng)求時(shí),獲取需要的值填充本地線程副本中,打印日志時(shí)候拼接輸出到日志。

Log4j2.X/Log4j1.X版本
LogContextHolder
public class AdapterLogContextHolder {

    private static final ThreadLocal<AdapterLogContext> LOG_CONTEXT = new ThreadLocal<>();

    private static AdapterLogContextHolder context = new AdapterLogContextHolder();

    private AdapterLogContextHolder() {
    }

    public static AdapterLogContextHolder getInstance() {
        return context;
    }

    public AdapterLogContext getLogContext() {
        AdapterLogContext context = LOG_CONTEXT.get();

        if (context == null) {
            context = new AdapterLogContext();
            LOG_CONTEXT.set(context);
        }
        return context;
    }

    public void setLogContext( AdapterLogContext context ) {
        LOG_CONTEXT.set(context);
    }

    public void removeLogContext() {
        LOG_CONTEXT.remove();
    }

    public String getTraceID() {
        return getLogContext().getTraceID();
    }

    public void setTraceID( String id ) {
        getLogContext().setTraceID(id);
    }
}


AdapterLogContext
public class AdapterLogContext implements Serializable, Cloneable {

    private static final long serialVersionUID = 6126191683350551062L;

    private String traceID = "traceID";

    private long callStartTimes;

    private String transID = "transId";

    private String clientAddr = "clientAddr";

    private String serverAddr = "serverAddr";

    private String clientSysName = "clientSysName";

    private String serverSysName = "serverSysName";

    @Override
    public Object clone() throws CloneNotSupportedException {
        return super.clone();
    }
    //get、set .....
}
LoggerAdapter
public class LoggerAdapter {

    final static String FQCN = LoggerAdapter.class.getName();

    private static LoggerAdapter loggerAdapter;

    private static volatile HashMap<String, LoggerAdapter> loggerxMap = null;

    protected Logger logger = null;

    private LoggerAdapter( Logger logger ) {
        this.logger = logger;
    }

    public static LoggerAdapter getLogger( Class<?> classObject ) {

        if (null == classObject) {
            throw new IllegalArgumentException();
        }

        if (loggerxMap == null) {
            synchronized (Loggerx.class) {
                if (loggerxMap == null) {
                    loggerxMap = new HashMap<>();
                    return getLoggerAdapter(classObject);
                }
            }
        }

        LoggerAdapter loggerAdapter = loggerxMap.get(classObject.getSimpleName());
        if (loggerAdapter == null) {
            return getLoggerAdapter(classObject);
        } else {
            return loggerAdapter;
        }
    }

    private static LoggerAdapter getLoggerAdapter( Class<?> classObject ) {
        Logger logger = LogManager.getLogger(classObject);
        if (logger == null) {
            return null;
        }

        LoggerAdapter loggerAdapter = new LoggerAdapter(logger);
        loggerxMap.put(classObject.getSimpleName(), loggerAdapter);

        return loggerAdapter;
    }

    public void info( LogType logType, Object message ) {
        String msgFormatted = msgFormat(logType, message);
        logger.log(FQCN, Level.INFO, msgFormatted, null);
    }

    public void info( LogType logType, Map<String, String> custMsg, Object message ) {
        String msgFormatted = msgFormat(logType, custMsg, message);
        logger.log(FQCN, Level.INFO, msgFormatted, null);
    }

    public void error( LogType logType, Object message ) {
        String msgFormatted = msgFormat(logType, message);
        logger.log(FQCN, Level.ERROR, msgFormatted, null);
    }

    public void error( LogType logType, Map<String, String> custMsg, Object message ) {
        String msgFormatted = msgFormat(logType, custMsg, message);
        logger.log(FQCN, Level.ERROR, msgFormatted, null);
    }

    public void error( LogType logType, Object message, Throwable t ) {
        String msgFormatted = msgFormat(logType, message);
        logger.log(FQCN, Level.ERROR, msgFormatted, t);
    }

    public void error( LogType logType, Map<String, String> custMsg, Object message, Throwable t ) {
        String msgFormatted = msgFormat(logType, custMsg, message);
        logger.log(FQCN, Level.ERROR, msgFormatted, t);
    }

    public void warn( LogType logType, Object message ) {
        String msgFormatted = msgFormat(logType, message);
        logger.log(FQCN, Level.WARN, msgFormatted, null);
    }

    public void warn( LogType logType, Map<String, String> custMsg, Object message ) {
        String msgFormatted = msgFormat(logType, custMsg, message);
        logger.log(FQCN, Level.WARN, msgFormatted, null);
    }

    public void debug( LogType logType, Object message ) {
        String msgFormatted = msgFormat(logType, message);
        logger.log(FQCN, Level.DEBUG, msgFormatted, null);
    }

    protected String msgFormat( LogType logType, Object message ) {
        StringBuilder sb = new StringBuilder();
        AdapterLogContext logContext = AdapterLogContextHolder.getInstance().getLogContext();
        sb.append(logContext.getTraceID());
        sb.append("|").append(logContext.getClientAddr());
        sb.append("|").append(logContext.getServerAddr());
        sb.append("|").append(logContext.getClientSysName());
        sb.append("|").append(logContext.getServerAddr());
        sb.append("|").append(logContext.getTransID());
        sb.append("|").append(logType);
        sb.append("|").append("custmsg=null");
        sb.append(message != null ? "^" + message.toString().replaceAll("\r|\n", "").replaceAll("\\|", "#") + "|" : "");
        return sb.toString();
    }

    protected String msgFormat( LogType logType, Map<String, String> custMsgMap, Object message ) {
        if (custMsgMap == null || custMsgMap.isEmpty()) {
            return msgFormat(logType, message);
        } else {
            StringBuilder sb = new StringBuilder();
            AdapterLogContext logContext = AdapterLogContextHolder.getInstance().getLogContext();
            sb.append("|").append(logContext.getClientAddr());
            sb.append("|").append(logContext.getServerAddr());
            sb.append("|").append(logContext.getClientSysName());
            sb.append("|").append(logContext.getServerAddr());
            sb.append("|").append(logContext.getTransID());
            sb.append("|").append(logType);
            sb.append("|");
            for (Map.Entry<String, String> entry : custMsgMap.entrySet()) {
                sb.append(entry.getKey() + "=" + entry.getValue() + ",");
            }
            sb.deleteCharAt(sb.length() - 1);
            sb.append(message != null ? "^" + message.toString().replaceAll("\r|\n", "") + "|" : "");
            return sb.toString();
        }
    }
}

AOP切片類LoggerAdapter
public class ClientContextBeforeAdvice implements MethodBeforeAdvice {

    @Override
    public void before(Method arg0, Object[] arg1, Object arg2) throws Throwable {
        try {
            if (arg1.length == 0 || !(arg1[0] instanceof BaseRequest)) {
                return;
            }

            AdapterLogContext logContext = AdapterLogContextHolder.getInstance().getLogContext()

            //獲取logContext各個(gè)屬性值
            BaseRequest request = (BaseRequest) arg1[0];
            request.setLogContext(logContext);
        } catch (Exception e) {
            LOGGER.error(LogType.EX, "", e);
            throw e;
        }
    }
}

//其他AOP切片
log4j配置使用適配器模式

在log4j配置中,log4j 1.x 與 2.x中都可以使用正常配置

Springboot使用

實(shí)現(xiàn)定制化log-start,應(yīng)用依賴即可。

MDC方式與Adapter方式對(duì)比

兩種對(duì)比,MDC優(yōu)點(diǎn)在于不改變開發(fā)人員使用log4j方法,引入不需要更改業(yè)務(wù)代碼,Adapter優(yōu)勢(shì)在于使用AOP和ThreadLocal方式更方便定制化。我司目前使用MDC方案.

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,598評(píng)論 19 139
  • 在應(yīng)用程序中添加日志記錄總的來說基于三個(gè)目的:監(jiān)視代碼中變量的變化情況,周期性的記錄到文件中供其他應(yīng)用進(jìn)行統(tǒng)計(jì)分析...
    時(shí)待吾閱讀 5,160評(píng)論 0 6
  • 在應(yīng)用程序中添加日志記錄總的來說基于三個(gè)目的:監(jiān)視代碼中變量的變化情況,周期性的記錄到文件中供其他應(yīng)用進(jìn)行統(tǒng)計(jì)分析...
    時(shí)待吾閱讀 5,225評(píng)論 1 13
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 47,275評(píng)論 6 342
  • 最近,電視劇<我的前半生>正熱播,也引發(fā)人們對(duì)家庭主婦這一話題的討論,先不去評(píng)價(jià)這部劇的好壞,單從家庭主婦四個(gè)字我...
    屋妍閱讀 263評(píng)論 0 3

友情鏈接更多精彩內(nèi)容