日志系统

Posted 2020-12-28 viaiu

       上一篇说了一下《解决问题的一般套路》,里面讲到了日志系统的重要性，日志重要吗？监控重要吗？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 
{}", (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：用来设置WebDataBinder，WebDataBinder用来自动绑定前台请求参数到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语言查询某个时间段发生的错误日志，帮助我们分析问题。欢迎指正！