日志系統


       上一篇說了一下《解決問題的一般套路》,里面講到了日志系統的重要性,日志重要嗎?監控重要嗎?of course!日志就是要能找到用戶做了什么請求那個機器。

       上下游接口請求,請求參數和入參是否正確,我們可以統一寫一個面向切面方法去打印日志,不用每一處去寫,切入點大家自己按照規則定義,AOP是Spring提供的關鍵特性之一。AOP即面向切面編程,是OOP編程的有效補充。使用AOP技術,可以將一些系統性相關的編程工作,獨立提取出來,獨立實現,然后通過切面切入進系統。從而避免了在業務邏輯的代碼中混入很多的系統相關的邏輯——比如權限管理,事物管理,日志記錄等等。這些系統性的編程工作都可以獨立編碼實現,然后通過AOP技術切入進系統即可。從而達到了 將不同的關注點分離出來的效果。

@Aspect
@Component
public class ControllerLogAspect {
    private Logger logger = LoggerFactory.getLogger(getClass());

    ThreadLocal<Long> startTime = new ThreadLocal<>();

    @Pointcut("execution(* com.xxx.mobile.web.controller..*.*(..))")
    public void controllerLog() {

    }

    @Before("controllerLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        startTime.set(System.currentTimeMillis());
        if (joinPoint == null) {
            return;
        }
        Signature signature = joinPoint.getSignature();
        // 接收到請求,記錄請求內容
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        ServletRequestAttributes attributes = null;
        HttpServletRequest request = null;
        String requestUrl = "";
        String httpMethod = "";
        String declaringTypeName = "";
        String actionName = "";
        String ip = "";
        if (requestAttributes != null) {
            attributes = (ServletRequestAttributes) requestAttributes;
        }
        if (attributes != null) {
            request = attributes.getRequest();
        }
        if (request != null) {
            requestUrl = request.getRequestURL().toString();
            httpMethod = request.getMethod();
            ip = IpUtils.getIpAddr(request);
        }
        if (signature != null) {
            declaringTypeName = joinPoint.getSignature().getDeclaringTypeName();
            actionName = joinPoint.getSignature().getName();
        }
        // 記錄下請求內容
        logger.debug("URL:[{}] HTTP_METHOD:[{}] CLASS_METHOD:[{}.{}] ip:[{}] ARGS:{}",
                requestUrl, httpMethod, declaringTypeName, actionName, ip, Arrays.toString(joinPoint.getArgs()));
    }

    @AfterReturning(returning = "ret", pointcut = "controllerLog()")
    public void doAfterReturning(Object ret) throws Throwable {
        // 處理完請求,返回內容
        logger.debug("Execute Time:{}ms \n{}", (System.currentTimeMillis() - startTime.get()), ret);
    }

      下面將使用@ExceptionHandler處理全局異常,將異常信息更加人性化的輸出給用戶。當然我們記錄日志還是會用log4j。至於log4j的用法大家可以百度。

@ControllerAdvice
public class MobileWebExceptionHandler {

    private static Logger logger = LoggerFactory.getLogger(MobileWebExceptionHandler.class);

    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public Object exceptionHandler(HttpServletRequest request, Exception e) throws Exception {
        String message = String.format("Url:[%s]-%s", request.getRequestURL().toString(), e.getMessage());
        logger.error(message, e);
        return MobileWebResponse.error(CODE_INVALID_PARAMETER, e.getMessage());
    }

  通過@ControllerAdvice。我們可以將對於控制器的全局配置放置在同一個位置,注解了@ControllerAdvice的類的方法可以使用@ExceptionHandler@InitBinder@ModelAttribute注解到方法上,這對所有注解了@RequestMapping的控制器內的方法有:

@ExceptionHandler:用於全局處理控制器里面的異常。
@InitBinder:用來設置WebDataBinderWebDataBinder用來自動綁定前台請求參數到Model中。
@ModelAttribute@ModelAttribute本來的作用是綁定鍵值對到Model里,此處是讓全局的@RequestMapping都能獲得在此處設置的鍵值對。

      什么時候該打印什么樣的日志級別,這個也很重要,一般情況下我們打印德日志級別info,warn,error居多,日志級別有:

ALL:最低等級的,用於打開所有日志記錄。
TRACE: designates finer­grained informational events than the DEBUG.Since:1.2.12,很低的日志級別,一般不會使用。
DEBUG: 指出細粒度信息事件對調試應用程序是非常有幫助的,主要用於開發過程中打印一些運行信息。
INFO: 消息在粗粒度級別上突出強調應用程序的運行過程。打印一些你感興趣的或者重要的信息,這個可以用於生產環境中輸出程序運行的一些重要信息,但是不能濫用,避免打印過多的日志。
WARN: 表明會出現潛在錯誤的情形,有些信息不是錯誤信息,但是也要給程序員的一些提示。
ERROR: 指出雖然發生錯誤事件,但仍然不影響系統的繼續運行。打印錯誤和異常信息,如果不想輸出太多的日志,可以使用這個級別。
FATAL: 指出每個嚴重的錯誤事件將會導致應用程序的退出。這個級別比較高了。重大錯誤,這種級別你可以直接停止程序了。
OFF: 最高等級的,用於關閉所有日志記錄 

     SpringBootAdmin顯示日志監控級別,我們可以根據自己的需求控制打印什么樣的日志:

       我們在打印日志一般日志頭會有時間,應用名,spanId,traceId,代碼行數,堆棧信息等,如下:

2018-08-05 11:52:58.470 WARN [xxx-web,e1ec017e8247b79e,e1ec017e8247b79e,true] 10652 --- [qtp1033348658-177] o.s.web.servlet.PageNotFound [1147 ] : No mapping found for HTTP request with URI [/flyway] in DispatcherServlet with name 'dispatcherServlet'

       如果那個app報錯了,錯誤日志怎樣讓大家看到,會選擇用RabbitMq+ELK(Elasticsearch , Logstash, Kibana), 這篇ELK原理與介紹(https://www.cnblogs.com/aresxin/p/8035137.html),這位小哥哥說的還不錯。Kafka可以被redis和RabbitMq 所替換。最終錯誤日志會顯示在kibana上,如下圖,除了時時監控錯誤的個數,還可以DSL語言查詢某個時間段發生的錯誤日志,幫助我們分析問題。歡迎指正!

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM