Logback配置企业生产环境最佳实践（供参考）

在企业生产环境中，Logback 配置文件应该考虑到日志的可维护性、性能和安全性。下面给出一个符合企业生产环境最佳实践的 Logback 配置文件示例。

Logback 配置文件 (logback.xml)

<configuration scan="true" scanPeriod="30 seconds">

    <!-- 定义属性 -->
    <property name="LOG_DIR" value="${LOG_PATH:-./logs}" />

    <!-- 控制台输出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <charset>UTF-8</charset>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 输出所有级别的日志 -->
    <appender name="FILE_ALL" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_DIR}/application-all.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- 日志文件名格式 -->
            <fileNamePattern>${LOG_DIR}/application-all-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- 最大单个文件大小 -->
            <maxFileSize>10MB</maxFileSize>
            <!-- 最多保留 30 天的日志文件 -->
            <maxHistory>30</maxHistory>
            <!-- 总共最多保留 1GB 的日志文件 -->
            <totalSizeCap>1GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <charset>UTF-8</charset>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <!-- 输出 ERROR 级别及以上的日志 -->
    <appender name="FILE_ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_DIR}/application-error.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!-- 日志文件名格式 -->
            <fileNamePattern>${LOG_DIR}/application-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- 最大单个文件大小 -->
            <maxFileSize>10MB</maxFileSize>
            <!-- 最多保留 30 天的日志文件 -->
            <maxHistory>30</maxHistory>
            <!-- 总共最多保留 1GB 的日志文件 -->
            <totalSizeCap>1GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <charset>UTF-8</charset>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
    </appender>

    <!-- 异步日志记录 -->
    <appender name="ASYNC_FILE_ALL" class="ch.qos.logback.classic.AsyncAppender">
        <queueSize>256</queueSize>
        <discardingThreshold>0</discardingThreshold>
        <appenderRef ref="FILE_ALL" />
    </appender>

    <appender name="ASYNC_FILE_ERROR" class="ch.qos.logback.classic.AsyncAppender">
        <queueSize>256</queueSize>
        <discardingThreshold>0</discardingThreshold>
        <appenderRef ref="FILE_ERROR" />
    </appender>

    <!-- 根 logger 配置 -->
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="ASYNC_FILE_ALL" />
        <appender-ref ref="ASYNC_FILE_ERROR" />
    </root>

    <!-- 特定包的日志级别配置 -->
    <logger name="com.yourcompany" level="DEBUG" additivity="false">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="ASYNC_FILE_ALL" />
        <appender-ref ref="ASYNC_FILE_ERROR" />
    </logger>

</configuration>

解释

1. 属性定义：

• <property name="LOG_DIR" value="${LOG_PATH:-./logs}" />：定义了一个 LOG_DIR 属性，用于指定日志文件的存储目录。如果没有设置 LOG_PATH 环境变量，则默认使用 ./logs 目录。

2. 控制台输出 (CONSOLE)：

• 将日志输出到控制台，方便开发和调试。
• 使用 UTF-8 编码。
• 日志格式包含时间戳、线程名、日志级别、日志来源类和日志消息。

3. 所有级别日志文件 (FILE_ALL)：

• 使用 RollingFileAppender 进行日志滚动。
• 每天生成一个新的日志文件，并按文件大小限制进行分割。
• 最大单个文件大小为 10MB。
• 最多保留 30 天的日志文件。
• 总共最多保留 1GB 的日志文件。

4. 错误级别日志文件 (FILE_ERROR)：

• 仅记录 ERROR 级别及以上的日志。
• 使用 ThresholdFilter 过滤器过滤出 ERROR 级别及以上的日志。

5. 日志文件命名规则同 FILE_ALL。

• 异步日志记录 (ASYNC_FILE_ALL 和 ASYNC_FILE_ERROR)：
• 使用 AsyncAppender 进行异步日志记录，提高性能。
• 设置队列大小为 256，丢弃阈值为 0，表示不丢弃任何日志。

6. 根 logger 配置：

• 设置根 logger 的日志级别为 INFO。
• 将日志输出到控制台、所有级别日志文件和错误级别日志文件。

7. 特定包的日志级别配置：

• 对于 com.yourcompany 包下的日志，设置日志级别为 DEBUG。
• additivity="false" 表示不继承父 logger 的 appender，避免重复日志。 

最佳实践总结

• 日志文件滚动：使用 RollingFileAppender 和 SizeAndTimeBasedRollingPolicy 进行日志滚动，防止日志文件过大。
• 异步日志记录：使用 AsyncAppender 进行异步日志记录，减少对应用性能的影响。
• 日志级别配置：合理设置不同包的日志级别，平衡日志详细程度和性能。
• 环境变量支持：通过环境变量动态配置日志目录，便于部署和管理。
• 字符编码：使用 UTF-8 编码，确保日志文件的兼容性和正确性。

这个配置文件可以帮助你在企业生产环境中更好地管理和监控日志，确保日志的完整性和可用性。