log4j MDC實現日志追蹤

aristark 發布于2019-08-15 15:18 / 3100人閱讀

摘要：介紹中包含的可以被同一線程中執行的代碼所訪問內容。當前線程的子線程會繼承其父線程中的的內容。記錄日志時，只需要從中獲取所需的信息即可。作用使用來記錄日志，可以規范多開發下日志格式。

介紹：
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}

GPU云服務器云服務器 log4j日志 linux追蹤日志 log4j記錄日志 log4j日志文件

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/68984.html

日志排查問題困難？分布式日志鏈路跟蹤來幫你

摘要：當前線程的子線程會繼承其父線程中的的內容。若希望在線程池與主線程間傳遞，需配合和使用。一、背景開發排查系統問題用得最多的手段就是查看系統日志，在分布式環境中一般使用ELK來統一收集日志，但是在并發大時使用日志定位問題還是比較麻煩，由于大量的其他用戶/其他線程的日志也一起輸出穿行其中導致很難篩選出指定請求的全部相關日志，以及下游線程/服務對應的日志。 ? 二、解決思路每個請求都使...

EasonTyler 2019-08-19 10:32 評論0 收藏0
分布式調用跟蹤實戰

摘要：為了追蹤一個請求完整的流轉過程，我可以給請求分配一個唯一的，當請求調用其他服務時，我們傳遞這個。這是一個簡單的實現分布式調用追蹤的實踐，以上。背景分布式環境下，跨服務之間的調用錯綜復雜，如果突然爆出一個錯誤，雖然有日志記錄，但到底是哪個服務出了問題呢？是移動端傳的參數有錯誤，還是系統X或者系統Y提供的接口導致？在這種情況下，錯誤排查起來就非常費勁。為了追蹤一個請求完整的流轉過程，...

jlanglang 2019-08-16 10:48 評論0 收藏0
Spring Boot 參考指南（日志記錄）

摘要：默認情況下，如果使用，則使用進行日志記錄，還包括適當的路由，以確保使用或的依賴庫都能正確工作。分隔符，用于區分實際日志消息的開始。 26. 日志記錄 Spring Boot為所有內部日志記錄使用Commons Logging，但開放底層日志實現，提供了Java Util Logging、Log4J2和Logback的默認配置，在每種情況下，日志記錄器都被預先配置為使用控制臺輸出，可選的...

mengera88 2019-08-16 12:31 評論0 收藏0
Spring Cloud 參考文檔（Spring Cloud Sleuth特性）

摘要：介紹從版本開始，使用作為追蹤庫，為方便起見，在此處嵌入了的部分文檔。具有一個上下文，其中包含標識符，該標識符將放置在表示分布式操作的樹中的正確位置。追蹤通常由攔截器自動完成，在幕后，他們添加與他們在操作中的角色相關的標簽和事件。 Spring Cloud Sleuth特性將trace和span ID添加到Slf4J MDC，因此你可以在日志聚合器中從給定的trace或span提取...

chinafgj 2019-08-16 17:02 評論0 收藏0
【Java筆記】ThreadLocal的學習和理解

摘要：底層是一個的散列表可擴容的數組，并采用開放地址法來解決沖突。稍后討論方法每個對象都有一個值，每初始化一個對象，值就增加一個固定的大小。因此在使用的時候要手動調用方法，防止內存泄漏。 ThreadLocal定義先看JDK關于ThreadLocal的類注釋： This class provides thread-local variables. These variables diffe...

red_bricks 2019-08-16 11:13 評論0 收藏0