Logback配置文件这么写,还愁不会整理日志?

摘要:

1.日志输出到文件并根据 LEVEL 级别将日志分类保存到不同文件

2.通过异步输出日志减少磁盘 IO 提高性能

3.异步输出日志的原理

1、配置文件logback-spring.xml

SpringBoot 工程自带 logback slf4j 的依赖,所以重点放在编写配置文件上,需 要引入什么依赖,日志依赖冲突 统统都不需要我们管了。

logback 框架会默认加载 classpath 下命名为 logback-spring.xml logback.xml 的配置文件。

如果将所有日志都存储在一个文件中,文件大小也随着应用的运行越来越大并且不好排查问题,正确的做法应该是将 error 日志和其他日志分开,并且不同级别的日志根据时间段进行记录存储。

配置文件:



    
    
    
    

    
            
        true
        
            
            [%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] [%logger{50}] [%M] [%line] - %msg%n
            UTF-8
        
    

    
    
        ${LOG_HOME}/${PROJECT_NAME}/error.log
        
        
            ERROR
            ACCEPT
            DENY
        
        
            
            ${LOG_HOME}/${PROJECT_NAME}/%d{yyyy-MM-dd}/error.%i.zip
            
            3650
            
            100MB
        
        
            
            [%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] [%logger{50}] [%M] [%line] - %msg%n
            UTF-8
        
    

    
    
        ${LOG_HOME}/${PROJECT_NAME}/info.log
        
        
            INFO
            ACCEPT
            DENY
        
        
            
            ${LOG_HOME}/${PROJECT_NAME}/%d{yyyy-MM-dd}/info.%i.zip
            
            3650
            
            100MB
        
        
            
            [%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] [%logger{50}] [%M] [%line] - %msg%n
            UTF-8
        
    
    
    
    
        ${LOG_HOME}/${PROJECT_NAME}/sql.log
           
               
               ${LOG_HOME}/${PROJECT_NAME}/%d{yyyy-MM-dd}/sql.%i.zip
               
              3650
               
               100MB
           
           
            
               [%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] [%logger{50}] [%M] [%line] - %msg%n
            UTF-8
        
    

    
    
        ${LOG_HOME}/${PROJECT_NAME}/request.log
        
            
               ${LOG_HOME}/${PROJECT_NAME}/%d{yyyy-MM-dd}/request.%i.zip
               
              3650
               
               100MB
        
        
               
               [%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] [%logger{50}] [%M] [%line]- %msg%n
            UTF-8
        
    

    
    
        
        256
        
        0
        
        
    

    
    
        
        256
        
        0
        
        
    

    
    
        
        256
        
        0
        
        
    

    
    
        
        256
        
        0
        
        
    

    
    
        
    
    
    
    
        
    
    
    
    
        
    

    
    
        
        
    

   
    
        
        
    

    
    
        
            
            
            
        
    

    
    
        
            
            
            
        
    

    
    
        
            
            
            
        
    

标签说明

标签,必填标签,用来指定最基础的日志输出级别

标签,添加 append

标签,通过使用该标签指定日志的收集策略

标签,通过使用该标签指定过滤策略

标签指定过滤的类型

标签,使用该标签下的 标签指定日志输出格式

标签指定收集策略,比如基于时间进行收集

标签指定生成日志保存地址,通过这样配置已经实现了分类分日期收集日志的目标了

name 属性指定 appender 命名

class 属性指定输出策略,通常有两种, 控制台输出文件输出 ,文件输出就是将日志进行一个持久化

ConsoleAppender

将日志输出到控制台

部分截图展示:

目录:

error.log

info.log

sql.log

request.log

2、logback 高级特性异步输出日志

如果不配置异步输出规则,那么默认日志配置方式是基于同步的,每次日志输出到文件都会进行一次磁盘 IO

采用异步写日志的方式而不让此次写日志发生磁盘 IO ,阻塞线程从而造成不必要的性能损耗。

异步输出日志的方式很简单,添加一个基于异步写日志的 appender ,并指向原先配置的 appender 即可。

异步输出配置:


    
        
        256
        
        0
        
        
    

    
    
        
        256
        
        0
        
        
    

    
    
        
        256
        
        0
        
        
    

    
    
        
        256
        
        0
        
        
    

参数配置:

参数名称 参数类型 建议值 说明
queueSize int queueSize计算
example:假设IO影响30s,日志和qps比例是1:1,单容器压测值1500 qps则可以推算出queue size的值,queueSize的设置公式:30 *1500=45000。
阻塞队列的最大容量。默认情况下,queueSize设置为256。
discardingThreshold int

使用默认值20,或者设置大于0。

如果设置discardingThreshold=0,表示queue 满了,不丢弃,block线程。

默认情况下,当阻塞队列剩余20%的容量时,它将丢弃级别跟踪、调试和信息事件,只保留级别警告和错误事件。要保留所有事件,请将discardingThreshold设置为0。
neverBlock boolean true 如果为false(默认值),则追加程序将阻止追加到完整队列,而不是丢失消息。设置为true时,附加程序只会丢弃消息,不会阻止您的应用程序。

官方文档链接: http://logback.qos.ch/manual/appenders.html#AsyncAppender

3、异步日志输出原理

异步输出日志中最关键的就是配置文件中 ch.qos.logback.classic 包下 AsyncAppenderBase 类中的 append 方法,查看该方法的源码:

@Override
protected void append(E eventObject) {
    if (isQueueBelowDiscardingThreshold() && isDiscardable(eventObject)) {
        return;
    }
    preprocess(eventObject);
    put(eventObject);
}

通过队列情况判断是否需要丢弃日志,不丢弃的话将它放到阻塞队列中,通过查看代码,这个阻塞队列为 queueSize ,默认大小为256,可以通过配置文件进行修改。

/**
 * The default buffer size.
 */
public static final int DEFAULT_QUEUE_SIZE = 256;
int queueSize = DEFAULT_QUEUE_SIZE;

Logger.info(…)append(…) 就结束了,只做了将日志塞入到阻塞队列的事,然后继续执行 Logger.info(…) 下面的语句了。在 AsyncAppenderBase 类中定义了一个 Worker 线程, run() 方法中的代码如下:

Worker worker = new Worker();
class Worker extends Thread {

    public void run() {
        AsyncAppenderBase parent = AsyncAppenderBase.this;
        AppenderAttachableImpl aai = parent.aai;

        // loop while the parent is started
        while (parent.isStarted()) {
            try {
                E e = parent.blockingQueue.take();
                aai.appendLoopOnAppenders(e);
            } catch (InterruptedException ie) {
                break;
            }
        }

        addInfo("Worker thread will flush remaining events before exiting. ");

        for (E e : parent.blockingQueue) {
            aai.appendLoopOnAppenders(e);
            parent.blockingQueue.remove(e);
        }

        aai.detachAndStopAllAppenders();
    }
}

从阻塞队列中取出一个日志,并调用 AppenderAttachableImpl 类中的 appendLoopOnAppenders 方法维护一个 Append 列表。

最主要的两个方法就是 encodewrite 方法,前一个法方会根据配置文件中 encode 指定的方式转化为字节码,后一个方法将转化成的字节码写入到文件中去。

所以写文件是通过新起一个线程去完成的,主线程将日志放到阻塞队列中,然后又去执行其他任务。