微服务应用日志处理与组件封装-白红宇

微服务应用日志处理与组件封装

阅读量：5216 次

发布时间：2019-06-14

本文共 11590 字，大约阅读时间需要 38 分钟。

微服务应用日志组件定制

随着微服务等设计理念在系统中的应用，业务的调用链越来越复杂，日志信息越来越大，从快速增长的日志数据流中提取出所需的信息，并将其与其他相关联的事件进行关联，将变得越加困难.ELK + KAFKA作为微服务应用日志中心解决方案是业界常规办法，前提是应用日志输出的规范化，日志组件就是为了完成这一目标。

微服务应用日志格式规划

经过公司技术人员充分讨论和分析，确认了应用日志输出格式如下：

|时间|日志级别|线程名|代码发生行|同步调用ID|客户系统节点|服务系统节点|客户系统名称|服务系统名称|日志类型|全局流水号|定制化字段^日志信息|

时间：记录日志产生时间;

日志级别：致命，ERROR，WARN，INFO，DEBUG;

线程名：执行操作线程名称;

代码发生行：日志事件发生在代码中位置;

同步调用ID：用于同步调用链分析，可以关联基普金，精确定位等工具关联排查问题;

客户系统节点：表示服务 - 客户端系统节点的标识，可以为IP或者DockerID;

服务系统节点：表示服务 - 服务端系统节点的标识，可以为IP或者DockerID;

客户系统名称：表示服务 - 客户端系统的标识，可以为系统简称和全称;

服务系统名称：表示服务 - 服务端系统的标识，可以为系统简称和全称;

全局流水号：贯穿一次业务流程的全局流水号;

日志类型：枚举，REQ-接口请求报文，RESP-接口响应报文，BIZ-通用日志;

INFO：定制化字段（格式采用关键字段=值，关键字段2 =值）^业务信息（记录详细日志信息）。

举个栗子：

|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^参数及权限校验拦截，验证通过.|

日志组件实现方案

Java的技术平台日志输出组件主要有java.util.logging中，log4j的，log4j2，的logback，SLF4J。我司目前使用的log4j2 + SLF4J组合作为应用日志输出组件，为了实现上述日志格式输出，主要有两种方式在组件上实现封装，应用采用SpringBoot +宁静作为主框架

Log4J的的MDC方案

MDC [ 是为每个线程建立一个独立的存储空间，开发人员可以根据需要把信息存入其中.MDC使用Map机制来存储信息，信息以键/值对的形式存储在Map中。

使用Servlet过滤器或者AOP在服务接收到请求时，获取需要的值填充MDC。在log4j2的配置中就可以使用％ X {}键MDC打印中的内容，从而识别出同一次请求中的日志。

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类

@Aspectpublic 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
      
        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增强，不管是抛出异常或者正常退出都会执行 @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中都可以使用此配置）

Springboot使用

实现定制化登录开始，应用依赖即可。

Log4J的的适配器封装方案

使用适配器模式封装log4j的接口，使用AOP在服务接收到请求时，获取需要的值填充本地线程副本中，打印日志时候拼接输出到日志。

Log4j2.X / Log4j1.X版本

LogContextHolder

public class AdapterLogContextHolder { private static final ThreadLocal
      
        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
      
        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
       
         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
        
          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
         
           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
          
            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
           
             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
            
              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各个属性值 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使用

实现定制化登录开始，应用依赖即可。

MDC方式与适配器方式对比

两种对比，MDC优点在于不改变开发人员使用的log4j方法，引入不需要更改业务代码，适配器优势在于使用AOP和ThreadLocal的方式更方便定制化。我司目前使用MDC方案。

转载于:https://www.cnblogs.com/airen123/p/10609004.html

你可能感兴趣的文章