logback.xml 配置记录

本文详细介绍了Logback日志框架的配置方法,包括不同级别的日志文件设置、日志文件滚动策略、日志文件大小限制及归档配置。通过实例展示了如何实现DEBUG、INFO、WARN、ERROR级别的日志输出,并提供了日志监听配置。

<!--
    configuration 节点属性说明:
        scan: 开启自动扫描,扫描配置文件是否发生变化,变化后自动更新配置,默认1分钟扫描一次
        scanPeriod: 配置扫描频次,单位可以为:milliseconds(毫秒), seconds(秒), minutes (分),hours(时)
-->
<configuration debug="true" scan="true" scanPeriod="30 seconds">
    <!--引入spring boot 默认的logback配置-->
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />
    <!--引入spring boot logback控制台日志配置-->
    <include resource="org/springframework/boot/logging/logback/console-appender.xml" />
    <!--配置日志文件输出路径-->
    <property name="LOG_PATH" value="/data/logs/project/"/>
    <!--配置项目名称,为拼接日志文件名-->
    <property name="PROJECT_NAME" value="project"/>
    <!--配置时间格式化格式-->
    <timestamp key="DATE_TIME" datePattern="yyyy-MM-dd HH:mm:ss:S"/>
    <!--配置日期格式化格式-->
    <timestamp key="DATE" datePattern="yyyy-MM-dd"/>
    <!-- DEBUG级别日志文件配置-->
    <appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--配置过滤器,只输出DEBUG级别日志-->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>DEBUG</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!--日志输出格式,此处引用spring boot 默认logback配置格式-->
        <encoder>
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <!--日志文件输出配置-->
        <file>${LOG_PATH}${PROJECT_NAME}-DEBUG.log</file>
        <!--以下为日志文件归档配置-->
        <!--配置归档文件名及索引范围-->
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>${LOG_PATH}${PROJECT_NAME}-DEBUG-${DATE}-%i.log.zip</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>10</maxIndex>
        </rollingPolicy>
        <!--配置归档大小,当日志文件超过10MB时触发归档-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>10MB</maxFileSize>
        </triggeringPolicy>
    </appender>

    <!-- INFO级别日志文件-->
    <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <encoder>
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <file>${LOG_PATH}${PROJECT_NAME}-INFO.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>${LOG_PATH}${PROJECT_NAME}-INFO-${DATE}-%i.log.zip</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>10</maxIndex>
        </rollingPolicy>

        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>10MB</maxFileSize>
        </triggeringPolicy>
    </appender>

    <!-- WARN级别日志文件-->
    <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>WARN</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <encoder>
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <file>${LOG_PATH}${PROJECT_NAME}-WARN.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>${LOG_PATH}${PROJECT_NAME}-WARN-${DATE}-%i.log.zip</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>10</maxIndex>
        </rollingPolicy>

        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>10MB</maxFileSize>
        </triggeringPolicy>
    </appender>

    <!-- ERROR级别日志文件-->
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <encoder>
            <pattern>${FILE_LOG_PATTERN}</pattern>
        </encoder>
        <file>${LOG_PATH}${PROJECT_NAME}-ERROR.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>${LOG_PATH}${PROJECT_NAME}-ERROR-${DATE}-%i.log.zip</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>10</maxIndex>
        </rollingPolicy>

        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>10MB</maxFileSize>
        </triggeringPolicy>
    </appender>
    <!--
        logback 日志监听配置:
            level: 配置日志监听级别,当前配置为DEBUG
    -->
    <root level="DEBUG">
        <!--控制台日志输出,引用的是console-appender.xml中定义的CONSOLE appender-->
        <appender-ref ref="CONSOLE" />
        <!--以下为各日志级别文件输出,为上边定义的各日志级别的appender-->
        <appender-ref ref="DEBUG"/>
        <appender-ref ref="INFO"/>
        <appender-ref ref="WARN"/>
        <appender-ref ref="ERROR"/>
    </root>
</configuration>
 

参考资料:http://logback.qos.ch/manual/index.html

### Logback.xml 文件命名规范及配置示例 Logback 是一个流行的 Java 日志框架,其配置文件通常命名为 `logback.xml` 或 `logback-test.xml`。以下是关于这些文件的命名规范及其配置的相关说明。 #### 命名规范 Logback 会在应用程序启动时自动查找类路径下的特定文件来加载日志配置。如果存在多个可能的日志配置文件,则优先级如下: 1. **logback-test.xml**: 当测试环境中需要特殊的日志配置时,此文件会被优先加载[^1]。 2. **logback.xml**: 如果未找到 `logback-test.xml`,则会尝试加载名为 `logback.xml` 的文件作为默认配置。 为了确保正确的功能实现,建议将这两个文件放置于项目的资源目录中(通常是 `src/main/resources/` 和 `src/test/resources/`)。例如,在 Maven 项目结构中,生产环境使用的 `logback.xml` 应位于 `src/main/resources/` 下,而用于单元测试的 `logback-test.xml` 则应位于 `src/test/resources/` 下。 #### 配置示例 下面是一个典型的 `logback.xml` 配置文件示例,展示了如何设置不同的 Appenders 和 Logger 层次结构: ```xml <configuration> <!-- 定义控制台输出 --> <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender> <!-- 定义文件输出 --> <appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>logs/application.log</file> <append>true</append> <encoder> <pattern>%date %level [%thread] %logger{10} [%file:%line] %msg%n</pattern> </encoder> </appender> <!-- 设置根 logger 级别并关联 appender --> <root level="info"> <appender-ref ref="CONSOLE"/> <appender-ref ref="FILE"/> </root> <!-- 动态引入 Spring Boot 配置中的变量 --> <springProperty scope="context" name="applicationName" source="spring.application.name"/> <!-- 自定义 logger 示例 --> <logger name="${applicationName}" level="debug" additivity="false"> <appender-ref ref="FILE"/> </logger> </configuration> ``` 上述配置实现了以下几点: - 使用 `<appender>` 元素定义了两个日志记录器:一个是控制台输出 (`ConsoleAppender`),另一个是文件输出 (`FileAppender`) [^3]。 - 控制台和文件输出均通过自定义模式指定了详细的日志格式。 - 根级别的日志级别被设定为 `INFO` 并附加到两个 Appenders 上。 - 引入了来自外部配置源 (如 `application.properties` 或 `application.yml`) 的动态属性 `${spring.application.name}`,以便更灵活地管理多模块项目中的日志输出[^2]。 #### 注意事项 - 若同时存在 `logback-test.xml` 和 `logback.xml`,前者具有更高的优先级,适用于开发阶段或运行测试用例期间。 - 正确的 XML 结构对于解析至关重要;任何语法错误都可能导致初始化失败。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值