栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Log日志追踪之MDC

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Log日志追踪之MDC

        MDC(Mapped Diagnostic Context,映射调试上下文)是Slf4j(提供了接口定义和核心实现,日志库负责适配器的实现)提供的一种方便在多线程条件下记录日志的功能。

MDC 可以看成是一个与当前线程绑定的Map,可以往其中添加键值对。MDC 中包含的内容可以被同一线程中执行的代码所访问。当前线程的子线程会继承其父线程中的 MDC 的内容。当需要记录日志时,只需要从 MDC 中获取所需的信息即可。MDC 的内容则由程序在适当的时候保存进去。对于一个 Web 应用来说,通常是在请求被处理的最开始保存这些数据。

简而言之,MDC就是日志框架提供的一个InheritableThreadLocal,项目代码中可以将键值对放入其中,然后使用指定方式取出打印即可。

例如:

        使用Servlet Filter在接收到请求时,生成UUID填充MDC。在logback的配置中就可以使用%X{key}打印MDC中的内容,从而识别出同一次请求中的log。

以下是一个简单的MDCFilter实现示例,在MDC中填充了UUID、主机IP和主机名。UUID用于标记同一次请求中的log,主机IP和主机名方便异常发生时到相应机器上检查log。

log4j 1.x中MDCFilter实现
//MDC填充的KEY
public static final String REQUEST_UUID = "REQUEST_UUID";
public static final String HOST_IP = "HOST_IP";
public static final String HOST_NAME = "HOST_NAME";
public static final String APPKEY = "APPKEY";
private String appkey = null;

@Override
public void init(FilterConfig filterConfig) throws ServletException {
    appkey = filterConfig.getInitParameter("appkey");//appkey可以在filter  init-param中配置

    if(appkey == null) {

        appkey = "";

    }
} 

@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {

    try {
        insertIntoMDC(request);//填充MDC
        chain.doFilter(request, response);
    } finally {
        clearMDC();//请求结束,注意清除MDC中的内容,否则会造成内存泄露问题
    }
}

// 默认实现中填充了UUID,主机IP和主机地址
protected void insertIntoMDC(ServletRequest request) {

    MDC.put(MDCFilter.REQUEST_UUID, UUID.randomUUID().toString());

    MDC.put(MDCFilter.HOST_IP, getHostIP());

    MDC.put(MDCFilter.HOST_NAME, getHostName());

    MDC.put(MDCFilter.APPKEY, appkey);
}

protected void clearMDC() {

    MDC.remove(MDCFilter.REQUEST_UUID);

    MDC.remove(MDCFilter.HOST_IP);

    MDC.remove(MDCFilter.HOST_NAME);

    MDC.remove(MDCFilter.APPKEY);
}
log4j2.0中MDCFilter实现

在log4j 2.0 中,使用ThreadContext代替了MDC和

NDC[http://logging.apache.org/log4j/2.x/manual/thread-context.html]。

log4j 2.x 中,类似MDCFilter的实现:ThreadContextFilter

public static final String REQUEST_UUID = "REQUEST_UUID";
public static final String HOST_IP = "HOST_IP";
public static final String HOST_NAME = "HOST_NAME";
public static final String APPKEY = "APPKEY";
private String appkey = null;

@Override

public void init(FilterConfig filterConfig) throws ServletException {

    appkey = filterConfig.getInitParameter("appkey");//appkey可以在filter  init-param中配置

    if(appkey == null) {

        appkey = "";

    }
}

@Override

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {

    try {

        insertIntoMDC(request);

        chain.doFilter(request, response);

    } finally {

        clearMDC();

    }
}
     
protected void insertIntoMDC(ServletRequest request) {

    ThreadContext.put(ThreadContextFilter.REQUEST_UUID, UUID.randomUUID().toString());

    ThreadContext.put(ThreadContextFilter.HOST_IP, getHostIP());

    ThreadContext.put(ThreadContextFilter.HOST_NAME, getHostName());        

    ThreadContext.put(ThreadContextFilter.APPKEY, appkey);
}

protected void clearMDC() {

    ThreadContext.remove(ThreadContextFilter.REQUEST_UUID);

    ThreadContext.remove(ThreadContextFilter.HOST_IP);

    ThreadContext.remove(ThreadContextFilter.HOST_NAME);

    ThreadContext.remove(ThreadContextFilter.APPKEY);
}
logback配置中,使用MDC

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

%X{REQUEST_UUID} %X{HOST_IP} %X{HOST_NAME} %X{APPKEY} 

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/943756.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号