日志规范之 logback日志

最新推荐文章于 2024-09-25 08:36:41 发布

原创最新推荐文章于 2024-09-25 08:36:41 发布 · 5k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#架构

本文详细介绍了日志记录的重要性及规范，涵盖了日志分类、记录准则、配置规范等内容，旨在帮助开发者有效提升系统质量和性能。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

目的

为了规范应用日志，方便系统问题分析跟查，特制订本规范。

适用范围

适用 Lifeix 所有后台应用。

内容

日志记录准则

在代码中嵌入 log 代码信息，主要记录下列信息：

1、记录系统运行异常信息。
2、记录系统运行状态信息。
3、记录系统运行性能指标。

通过对上述信息分析和诊断，我们能采取正确的手段来提高系统质量和提升系统性能。

日志主要分三大类：

安全类信息：记录系统边界交互行为和信息
业务类信息：记录系统内部业务处理行为和信息
性能类信息：记录系统硬件对业务处理的支撑能力

	ERROR	WARN	INFO	DEBUG
安全类信息		合法拒绝	正常	其它
业务类信息	重要模块类异常	一般模块异常	正常	其它
性能类信息		超越指标信息	正常	其它

日志中的相关约定

序号	约定内容
1	简化info级别的日志，去掉framework框架中的action跟踪日志，info级别日志中只保留主要的操作日志，将已有的一些用于定位问题的日志（如sql）调整为debug级别。
2	启用mybatis层的日志，用debug级别输出。
3	强化operation日志接口，使operation日志接口具备既能输出日志到文件，也能将操作日志输出到数据库的功能。
4	清除开发过程中用于调试的日志，清理所有拼音、无意义的字符、程序中的System.out.println等内容,日志中不要使用感叹号，使用英文句号结尾
5	不可以讲敏感业务信息记录入日志文件
6	为保证日志的连续，可以讲不同包下面的日志记录到单独的日志文件方便问题跟踪，例如 LoggerFactory.getLogger("AUTHORITY_APPENDER")
7	logback.xml 文件放在 classpath 目录下。

目录及命名规范

文件名	日志描述
${LOG_DIR}/${SYSTEM_NAME}/system.log	系统日志
${LOG_DIR}/${SYSTEM_NAME}/system.%d{yyyy-MM-dd}.%i.log	历史系统日志
${LOG_DIR}/${SYSTEM_NAME}/%modulename%/%initialism%.log	业务日志
${LOG_DIR}/%modulename%/%initialism%.%d{yyyy-MM-dd}.%i.log	历史业务日志

logback配置规范

<appender>规范

1、日志输出文件目录及文件名

<file>${LOG_DIR}/${SYSTEM_NAME}/system.log</file>

<file>${LOG_DIR}/${SYSTEM_NAME}/%modulename%/%initialism%.log</file>

root日志通常记录在${LOG_DIR}/${SYSTEM_NAME}/system.log 文件中

其它需要特别记录的日志按照 ${LOG_DIR}/${SYSTEM_NAME}/%modulename%/%initialism%.log 的路径和文件名记录，其中%modulename%需要将实际的模块名替换之，%initialism%需要使用实际的缩略语替换之

2、日志按天记录，单个日志文件最大不超过5000MB

<rollingPolicy

class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

    <!--
 日志每天进行rotate -->

    <fileNamePattern>${LOG_DIR}/${SYSTEM_NAME}/system.%d{yyyy-MM-dd}.%i.log</fileNamePattern>

    <timeBasedFileNamingAndTriggeringPolicy

class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">

        <!--
 每个日志文件大小不超过5GB -->

        <maxFileSize>5000MB</maxFileSize>

    </timeBasedFileNamingAndTriggeringPolicy>

 </rollingPolicy>

fileNamePattern还可以为 <fileNamePattern>${LOG_DIR}/%modulename%/%initialism%.%d{yyyy-MM-dd}.%i.log</fileNamePattern>，其中%modulename%需要将实际的模块名替换之，%initialism%需要使用实际的缩略语替换之

3、日志输出格式为

<encoder>

    <pattern>%-20(%d{yyy-MM-dd
 HH:mm:ss.SSS} [%X{requestId}]) %-5level - %logger{80} - %msg%n</pattern>

</encoder>

4、一个完整的Appender配置如下

<appender

name="ROOT_APPENDER"

class="ch.qos.logback.core.rolling.RollingFileAppender">

   <file>${LOG_DIR}/${SYSTEM_NAME}/system.log</file>

   <rollingPolicy

class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

       <!--
 日志每天进行rotate -->

       <fileNamePattern>${LOG_DIR}/${SYSTEM_NAME}/system.%d{yyyy-MM-dd}.%i.log</fileNamePattern>

       <timeBasedFileNamingAndTriggeringPolicy

class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">

           <!--
 每个日志文件大小不超过5GB -->

           <maxFileSize>5000MB</maxFileSize>

       </timeBasedFileNamingAndTriggeringPolicy>

   </rollingPolicy>

   <!--
 日志输出格式 -->

   <encoder>

       <pattern>%-20(%d{yyy-MM-dd
 HH:mm:ss.SSS} [%X{requestId}]) %-5level - %logger{80} - %msg%n</pattern>

   </encoder>

</appender>

<logger>规范

1、<logger>可以根据需要选择使用包路径还是名字的方式，当需要将某个包的所有日志记录到文件的时候可以配置包路径的方式，当需要纵向记录某个业务的日志的时候可以使用第二种方式

第一种方式：

    <logger

name="com.lifeix.apollo.authority.service.impl"

level="DEBUG">

         <appender-ref

ref="AUTHORITY_APPENDER"

/>

    </logger>

    private
 static Logger LOGGER = LoggerFactory.getLogger(ContextPhotoServiceImpl.class);

第二种方式：

    <logger

name="AUTHORITY"

level="DEBUG">

         <appender-ref

ref="AUTHORITY_APPENDER"

/>

    </logger>

    private
 static Logger AUTHORITY_LOGGER = LoggerFactory.getLogger("AUTHORITY_APPENDER");

2、不要使用 additivity="false"

system.log 需要完整记录该系统所有的日志，为调试跟踪方便，部分日志重复记录到单独的文件里面去。

<root>规范

1、root的配置如下，root 的日志级别要求为ERROR，不可将无用的信息输出到日志文件，appender只可以配置ROOT_APPENDER和logstash。

<root

level="ERROR">

<appender-ref

ref="ROOT_APPENDER"

/>

<appender-ref

ref="logstash"

/>

</root>

logstash规范

1、logstash记录到 ${LOG_DIR}/${SYSTEM_NAME}/logstash.json 文件，每天记录到不同文件，单个文件大小不超过5000MB。

<appender

name="logstash"

class="ch.qos.logback.core.rolling.RollingFileAppender">

    <file>${LOG_DIR}/${SYSTEM_NAME}/logstash.json</file>

    <rollingPolicy

class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

        <fileNamePattern>${LOG_DIR}/${SYSTEM_NAME}/logstash.%d{yyyy-MM-dd}.%i.json

        </fileNamePattern>

        <timeBasedFileNamingAndTriggeringPolicy

class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">

            <!--
 or whenever the file size reaches 2MB -->

            <maxFileSize>5000MB</maxFileSize>

        </timeBasedFileNamingAndTriggeringPolicy>

    </rollingPolicy>

    <encoding>UTF-8</encoding>

    <encoder

class="net.logstash.logback.encoder.LogstashEncoder"

/>

</appender>