logback配置文件 注释详细

官方文档:
http://logback.qos.ch/manual/configuration.html
主要关注右侧目录中的

  • configuration 跟节点
  • Appenders 日志滚动策略
  • Layouts 内容的格式化
  • Filters 过滤


我只对大家比较疑惑的内容进行说明
首先是滚动策略:
比较常用的应该就是按时间和文件大小滚动了,主要以日期进行滚动,但是在当日达到了指定的文件大小,就会按序列号滚动,所以FileNamePattern标签配置的文件生成策略必须含有%i

<!--
                %d{yyyy-MM-dd} 日期格式化 说明按日滚动
               %i:在这种滚动策略下,必须参数,当达到指定日志文件大小按序列号生成文件
                例:
                    error.2020-08-30_1.log
                    error.2020-08-30_2.log
            -->
            <FileNamePattern>${LOG_HOME}/error/error.%d{yyyy-MM-dd}_%i.log</FileNamePattern>

内容的格式化encoder

  • %ex:异常堆栈跟踪内容,格式有

    • short:打印堆栈跟踪的第一行
    • full:打印完整的堆栈跟踪
    • 任何整数:打印给定行数的堆栈跟踪


  • %c和%logger区别在于%c打印的是完整的类路径
    %logger打印的是简单类名

  • %highlight可以高亮()中的内容,如图


<!--
            %highlight : 以不同的颜色高亮
             %c:打印类的全限定名
        -->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %highlight(%-5level) %c : %n --- %msg%n</pattern>
        </encoder>

filter的作用

在日志文件滚动策略中配置后可以只记录指定等级的日志,比如error日志中只记录error,那么就需要配置filter,否则error日志中也会有其他级别日志

以下是完整配置,基本够用了

<!--
    scan : 自动热加载
    scanPeriod:加载时间间隔 可用的单位是 milliseconds,seconds,minutes 和 hours,这默认单位为 milliseconds。
    debug: 当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="30 seconds" debug="false">

    <!--可以自定义变量-->
    <property name="LOG_HOME" value="logs/" />

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">

        <!--
            %highlight : 以不同的颜色高亮
             %c:打印类的全限定名
        -->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %highlight(%-5level) %c : %n --- %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="error" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--写入的日志文件名-->
        <file>${LOG_HOME}/error/error.log</file>
        <!--
            只记录error级别日志
            配置该filter以后,在error.log文件中只有error级别日志
        -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!--如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。-->
        <append>true</append>

        <!--滚动行为 基于时间和大小-->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy" >
            <!--
                %d{yyyy-MM-dd} 日期格式化 说明按日滚动
               %i:在这种滚动策略下,必须参数,当达到指定日志文件大小按序列号生成文件
                例:
                    error.2020-08-30_1.log
                    error.2020-08-30_2.log
            -->
            <FileNamePattern>${LOG_HOME}/error/error.%d{yyyy-MM-dd}_%i.log</FileNamePattern>
            <maxFileSize>100MB</maxFileSize>
            <maxHistory>20</maxHistory>
        </rollingPolicy>

        <!--  %c:打印类的全限定名 -->
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %c - %msg%n</pattern>
        </encoder>
    </appender>

    <appender name="info" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--写入的日志文件名-->
        <file>${LOG_HOME}/info/info.log</file>
        <!--如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。-->
        <append>true</append>
        <!--滚动行为 基于时间和大小-->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy" >
            <!--error.2020-08-30_1.log-->
            <!--
                %i:在这种滚动策略下,必须参数,当达到指定日志文件大小按序列号生成文件
            -->
            <FileNamePattern>${LOG_HOME}/info/info.%d{yyyy-MM-dd}_%i.log</FileNamePattern>
            <maxFileSize>100MB</maxFileSize>
            <maxHistory>20</maxHistory>
        </rollingPolicy>

        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %c - %msg%n</pattern>
        </encoder>
    </appender>

    <!--
        additivity: 是否向上级logger传递打印信息。默认是true。
    -->
    <!--
        可以指定某个包,某个类的日志级别
        appender-ref 指定适用那种日志滚动策略
        additivity 是否继承root的级别
    -->
    <logger name="com.liyonglong.searchrecommond" level="ERROR" additivity="false">
        <appender-ref ref="error" />
        <appender-ref ref="STDOUT" />
    </logger>
    <logger name="com.liyonglong.searchrecommond" level="INFO" additivity="false">
        <appender-ref ref="info" />
    </logger>

    <root level="DEBUG">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容