资讯专栏INFORMATION COLUMN

log4j MDC实现日志追踪

aristark / 2988人阅读

摘要:介绍中包含的可以被同一线程中执行的代码所访问内容。当前线程的子线程会继承其父线程中的的内容。记录日志时,只需要从中获取所需的信息即可。作用使用来记录日志,可以规范多开发下日志格式。

介绍:
MDC 中包含的可以被同一线程中执行的代码所访问内容。当前线程的子线程会继承其父线程中的 MDC 的内容。记录日志时,只需要从 MDC 中获取所需的信息即可。
作用:
使用MDC来记录日志,可以规范多开发下日志格式。

一:新建线程处理类 ThreadContext

import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;

/**
 * 线程上下文
 *
 * @date 2017年3月1日
 * @since 1.0.0
 */
public class ThreadContext {
    /**
     * 线程上下文变量的持有者
     */
    private final static ThreadLocal> CTX_HOLDER = new ThreadLocal>();

    static {
        CTX_HOLDER.set(new HashMap());
    }

 
    /**
     * traceID
     */
    private final static String TRACE_ID_KEY = "traceId";

    /**
     * 会话ID
     */
    private final static String SESSION_KEY = "token";

    /**
     * 操作用户ID
     */
    private final static String VISITOR_ID_KEY = "userId";
    /**
     * 操作用户名
     */
    private final static String VISITOR_NAME_KEY = "userName";

    /**
     * 客户端IP
     */
    private static final String CLIENT_IP_KEY = "clientIp";

    /**
     * 添加内容到线程上下文中
     *
     * @param key
     * @param value
     */
    public final static void putContext(String key, Object value) {
        Map ctx = CTX_HOLDER.get();
        if (ctx == null) {
            return;
        }
        ctx.put(key, value);
    }

    /**
     * 从线程上下文中获取内容
     *
     * @param key
     */
    @SuppressWarnings("unchecked")
    public final static  T getContext(String key) {
        Map ctx = CTX_HOLDER.get();
        if (ctx == null) {
            return null;
        }
        return (T) ctx.get(key);
    }

    /**
     * 获取线程上下文
     */
    public final static Map getContext() {
        Map ctx = CTX_HOLDER.get();
        if (ctx == null) {
            return null;
        }
        return ctx;
    }

    /**
     * 删除上下文中的key
     *
     * @param key
     */
    public final static void remove(String key) {
        Map ctx = CTX_HOLDER.get();
        if (ctx != null) {
            ctx.remove(key);
        }
    }

    /**
     * 上下文中是否包含此key
     *
     * @param key
     * @return
     */
    public final static boolean contains(String key) {
        Map ctx = CTX_HOLDER.get();
        if (ctx != null) {
            return ctx.containsKey(key);
        }
        return false;
    }

    /**
     * 清空线程上下文
     */
    public final static void clean() {
        CTX_HOLDER.remove();
    }

    /**
     * 初始化线程上下文
     */
    public final static void init() {
        CTX_HOLDER.set(new HashMap());
    }


    /**
     * 设置traceID数据
     */
    public final static void putTraceId(String traceId) {
        putContext(TRACE_ID_KEY, traceId);
    }

    /**
     * 获取traceID数据
     */
    public final static String getTraceId() {
        return getContext(TRACE_ID_KEY);
    }

    /**
     * 设置会话的用户ID
     */
    public final static void putUserId(Integer userId) {
        putContext(VISITOR_ID_KEY, userId);
    }

    /**
     * 设置会话的用户ID
     */
    public final static int getUserId() {
        Integer val = getContext(VISITOR_ID_KEY);
        return val == null ? 0 : val;
    }

    /**
     * 设置会话的用户名
     */
    public final static void putUserName(String userName) {
        putContext(VISITOR_NAME_KEY, userName);
    }

    /**
     * 获取会话的用户名称
     */
    public final static String getUserName() {
        return Optional.ofNullable(getContext(VISITOR_NAME_KEY))
                .map(name -> String.valueOf(name))
                .orElse("");
    }

    /**
     * 取出IP
     *
     * @return
     */
    public static final String getClientIp() {
        return getContext(CLIENT_IP_KEY);
    }

    /**
     * 设置IP
     *
     * @param ip
     */
    public static final void putClientIp(String ip) {
        putContext(CLIENT_IP_KEY, ip);
    }

    /**
     * 设置会话ID
     *
     * @param token
     */
    public static void putSessionId(String token) {
        putContext(SESSION_KEY, token);
    }

    /**
     * 获取会话ID
     *
     * @param token
     */
    public static String getSessionId(String token) {
        return getContext(SESSION_KEY);
    }

    /**
     * 清空会话数据
     */
    public final static void removeSessionId() {
        remove(SESSION_KEY);
    }
}

二:添加工具类TraceUtil

import java.util.UUID;
import org.slf4j.MDC;
import ThreadContext;

/**
 * trace工具
 *
 * @date 2017年3月10日
 * @since 1.0.0
 */
public class TraceUtil {

    public static void traceStart() {
        ThreadContext.init();
        String traceId = generateTraceId();
        MDC.put("traceId", traceId);
        ThreadContext.putTraceId(traceId);
    }

    public static void traceEnd() {
        MDC.clear();
        ThreadContext.clean();
    }

    /**
     * 生成跟踪ID
     *
     * @return
     */
    private static String generateTraceId() {
        return UUID.randomUUID().toString();
    }
}

三:添加ContextFilter,对于每个请求随机生成RequestID并放入MDC

import java.io.IOException;

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.web.filter.OncePerRequestFilter;

import com.pingan.manpan.common.util.TraceUtil;
import com.pingan.manpan.user.dto.ThreadContext;
import com.pingan.manpan.web.common.surpport.IpUtils;

/**
 * 上下文Filter
 *
 * @date 2017/3/10
 * @since 1.0.0
 */
//@Order 标记组件的加载顺序
@Order(Ordered.HIGHEST_PRECEDENCE)
public class ContextFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response,
                                    FilterChain filterChain) throws ServletException, IOException {
        try {
            ThreadContext.putClientIp(IpUtils.getClientIp(request));
            TraceUtil.traceStart();

            filterChain.doFilter(request, response);
        } finally {
            TraceUtil.traceEnd();
        }
    }
}

四:在webConfiguriation注册filter

    /**
     * 请求上下文,应该在最外层
     *
     * @return
     */
    @Bean
    public FilterRegistrationBean requestContextRepositoryFilterRegistrationBean() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(new ContextFilter());
        filterRegistrationBean.addUrlPatterns("/*");
        return filterRegistrationBean;
    }

五:修改log4j日志配置文件,设置日志traceId





    

    
    
    

    
    

    
        
            ${FILE_LOG_PATTERN}
        
        ${LOG_FILE}${LOG_FILE_SUFFIX}
        
            ${LOG_FILE}.%d{yyyy-MM-dd}${LOG_FILE_SUFFIX}
        
    

    
        127.0.0.1
        local6
        514
        ${FILE_LOG_PATTERN}
    
    
    

    
        
        
        
    


文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/68984.html

相关文章

  • 日志排查问题困难?分布式日志链路跟踪来帮你

    摘要:当前线程的子线程会继承其父线程中的的内容。若希望在线程池与主线程间传递,需配合和使用。 一、背景 开发排查系统问题用得最多的手段就是查看系统日志,在分布式环境中一般使用ELK来统一收集日志,但是在并发大时使用日志定位问题还是比较麻烦,由于大量的其他用户/其他线程的日志也一起输出穿行其中导致很难筛选出指定请求的全部相关日志,以及下游线程/服务对应的日志。   二、解决思路 每个请求都使...

    EasonTyler 评论0 收藏0
  • 分布式调用跟踪实战

    摘要:为了追踪一个请求完整的流转过程,我可以给请求分配一个唯一的,当请求调用其他服务时,我们传递这个。这是一个简单的实现分布式调用追踪的实践,以上。 背景 分布式环境下,跨服务之间的调用错综复杂,如果突然爆出一个错误,虽然有日志记录,但到底是哪个服务出了问题呢?是移动端传的参数有错误,还是系统X或者系统Y提供的接口导致?在这种情况下,错误排查起来就非常费劲。 为了追踪一个请求完整的流转过程,...

    jlanglang 评论0 收藏0
  • Spring Boot 参考指南(日志记录)

    摘要:默认情况下,如果使用,则使用进行日志记录,还包括适当的路由,以确保使用或的依赖库都能正确工作。分隔符,用于区分实际日志消息的开始。 26. 日志记录 Spring Boot为所有内部日志记录使用Commons Logging,但开放底层日志实现,提供了Java Util Logging、Log4J2和Logback的默认配置,在每种情况下,日志记录器都被预先配置为使用控制台输出,可选的...

    mengera88 评论0 收藏0
  • Spring Cloud 参考文档(Spring Cloud Sleuth特性)

    摘要:介绍从版本开始,使用作为追踪库,为方便起见,在此处嵌入了的部分文档。具有一个上下文,其中包含标识符,该标识符将放置在表示分布式操作的树中的正确位置。追踪通常由拦截器自动完成,在幕后,他们添加与他们在操作中的角色相关的标签和事件。 Spring Cloud Sleuth特性 将trace和span ID添加到Slf4J MDC,因此你可以在日志聚合器中从给定的trace或span提取...

    chinafgj 评论0 收藏0
  • 【Java笔记】ThreadLocal的学习和理解

    摘要:底层是一个的散列表可扩容的数组,并采用开放地址法来解决冲突。稍后讨论方法每个对象都有一个值,每初始化一个对象,值就增加一个固定的大小。因此在使用的时候要手动调用方法,防止内存泄漏。 ThreadLocal定义 先看JDK关于ThreadLocal的类注释: This class provides thread-local variables. These variables diffe...

    red_bricks 评论0 收藏0

发表评论

0条评论

aristark

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<