logback.xml文件配置

本文详细介绍了Logback日志框架的配置方法,包括不同输出渠道的设置、日志级别过滤及滚动文件策略等,为开发者提供了一份实用的日志配置指南。

logback.xml文件配置

<?xml version="1.0" encoding="UTF-8"?>
<!-- Logback Configuration. -->
<configuration debug="true">
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <target>System.out</target>
        <encoding>UTF-8</encoding>
        <filter class="com.alibaba.citrus.logconfig.logback.LevelRangeFilter">
            <levelMax>INFO</levelMax>
        </filter>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern><![CDATA[
			 [%d{yyyy-MM-dd HH:mm:ss}]  %-5level %logger{0} - %m%n
            ]]></pattern>
        </layout>
    </appender>

    <appender name="STDERR" class="ch.qos.logback.core.ConsoleAppender">
        <target>System.err</target>
        <encoding>UTF-8</encoding>
        <filter class="com.alibaba.citrus.logconfig.logback.LevelRangeFilter">
            <levelMin>WARN</levelMin>
        </filter>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern><![CDATA[
[%d{yyyy-MM-dd HH:mm:ss} ] - %X{method} %X{requestURIWithQueryString} [ip=%X{remoteAddr}, ref=%X{referrer}, ua=%X{userAgent}, sid=%X{cookie.JSESSIONID}]%n  %-5level %logger{35} - %m%n
            ]]></pattern>
        </layout>
    </appender>

    <!-- 生成日志文件 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日志文件输出的文件名 -->
        <file>${app.output}/logs/app.log</file>

        <!-- 固定数量的日志文件,防止将磁盘占满 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>${app.output}/logs/app.%i.log
            </fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>10</maxIndex>
        </rollingPolicy>

        <!--日志文件最大的大小 -->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>500MB</MaxFileSize>
        </triggeringPolicy>

        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符 -->
            <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] %-5level %logger{20} -%msg%n</pattern>
        </encoder>
    </appender>

    <appender name="thirdApiCallAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日志文件输出的文件名 -->
        <file>${app.output}/logs/third_api_call.log</file>

        <!-- 固定数量的日志文件,防止将磁盘占满 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>${app.output}/logs/third_api_call.%i.log
            </fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>10</maxIndex>
        </rollingPolicy>

        <!--日志文件最大的大小 -->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>500MB</MaxFileSize>
        </triggeringPolicy>

        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符 -->
            <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] %-5level %logger{20} -%msg%n</pattern>
        </encoder>
    </appender>

    <!-- redis日志 -->
    <appender name="redisAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${app.output}/logs/redis.log</file>

        <!-- 固定数量的日志文件,防止将磁盘占满 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>${app.output}/logs/redis.%i.log</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>10</maxIndex>
        </rollingPolicy>

        <!--日志文件最大的大小 -->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>100MB</MaxFileSize>
        </triggeringPolicy>

        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符 -->
            <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] %-5level %logger{20} -%msg%n</pattern>
        </encoder>
    </appender>

    <logger name="profiler" level="DEBUG" additivity="false">
        <appender-ref ref="profilerAppender"/>
        <appender-ref ref="STDOUT"/>
    </logger>

    <logger name="thirdApiCall" level="DEBUG" additivity="false">
        <appender-ref ref="thirdApiCallAppender"/>
        <appender-ref ref="STDOUT"/>
    </logger>
    
    <logger name="redisLogger" level="DEBUG" additivity="false">
        <appender-ref ref="redisAppender"/>
        <appender-ref ref="STDOUT"/>
    </logger>

    <root>
        <level value="${app.logging.level}" />
        <appender-ref ref="STDOUT" />
        <appender-ref ref="STDERR" />
        <appender-ref ref="FILE" />
    </root>
</configuration>


### 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、付费专栏及课程。

余额充值