• 微服务项目：尚融宝（11）（后端接口：统一日志处理）

    认清现实，放弃幻想，准备斗争

    一、Logback日志 

    1、什么是日志

    通过日志查看程序的运行过程，运行信息，异常信息等

    2、日志级别

    日志记录器（Logger）的行为是分等级的。如下表所示：

    分为：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF

    默认情况下，spring boot从控制台打印出来的日志级别只有INFO及以上级别，可以配置日志级别

     # 设置日志级别
    logging:
      level:
        root: ERROR

    这种方式能将ERROR级别以及以上级别的日志输出到控制台上，其他级别将不会输出

    3、创建日志文件

    spring boot内部使用Logback作为日志实现的框架。

    先删除前面在application.yml中的日志级别配置

    resources 中创建 logback-spring.xml （默认日志文件的名字）

    1. "1.0" encoding="UTF-8"?>
    2. <configuration>
    3.  
    4. configuration>

    4、创建测试日志输出

    将以下日志输出到任意controller的方法中即可，例如list方法中

    1. @ApiOperation("积分等级列表")
    2. @GetMapping("/list")
    3. public R listAll(){
    4.  
    5.     log.info("hi i'm helen");
    6.     log.warn("warning!!!");
    7.     log.error("it's a error");
    8.  
    9.     List list = integrationService.list();
    10.     return R.ok().data("list", list);
    11. }

    二、基本配置说明

    1、configuration

    日志配置的根节点 
    <configuration>configuration>

    2、contextName

    是的子节点。

    每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用设置成其他名字，用于区分不同的应用程序。

    <contextName>atguiguSrbcontextName>

    3、property

    是的子节点，用来定义变量。

    有两个属性，name和value：name的值是变量的名称，value是变量的值。

    通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。

    2. <property name="log.path" value="D:/project/finance/srb_log/core" />
    3.  
    10. <property name="CONSOLE_LOG_PATTERN"
    11.           value="%yellow(%date{yyyy-MM-dd HH:mm:ss}) %highlight([%-5level]) %green(%logger) %msg%n"/>
    12.  
    14. <property name="FILE_LOG_PATTERN"
    15.           value="%date{yyyy-MM-dd HH:mm:ss} [%-5level] %thread %file:%line %logger %msg%n" />
    16.  
    18. <property name="ENCODING"
    19.           value="UTF-8" />

    4、appender

    是的子节点，是负责写日志的组件

    有两个必要属性name和class：name指定appender名称，class指定appender的全限定名

    对日志进行格式化

    定义日志的具体输出格式

    编码方式

    控制台日志配置

    2. <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    3.     <encoder>
    4.         <pattern>${CONSOLE_LOG_PATTERN}pattern>
    5.         <charset>${ENCODING}charset>
    6.     encoder>
    7. appender>

    文件日志配置 

    表示日志文件的位置，如果上级目录不存在会自动创建，没有默认值。

    默认 true，日志被追加到文件结尾，如果是 false，服务重启后清空现存文件。

    2. <appender name="FILE" class="ch.qos.logback.core.FileAppender">
    3.     <file>${log.path}/log.logfile>
    4.     <append>trueappend>
    5.     <encoder>
    6.         <pattern>${FILE_LOG_PATTERN}pattern>
    7.         <charset>${ENCODING}charset>
    8.     encoder>
    9. appender>

    5、logger

    可以是的子节点，用来设置某一个包或具体某一个类的日志打印级别、指定

    name：用来指定受此logger约束的某一个包或者具体的某一个类

    level：用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF。默认继承上级的级别

    可以包含零个或多个元素，标识这个appender将会添加到这个logger

    2. <logger name="com.atguigu" level="INFO">
    3.     <appender-ref ref="CONSOLE" />
    4.     <appender-ref ref="FILE" />
    5. logger>

    三、多环境配置

    springProfile

    在一个基于Spring boot开发的项目里，常常需要有多套环境的配置：开发，测试以及产品。使用springProfile 可以分别配置开发（dev），测试（test）以及生产（prod）等不同的环境

    2. <springProfile name="dev,test">
    3.     <logger name="com.atguigu" level="INFO">
    4.         <appender-ref ref="CONSOLE" />
    5.     logger>
    6. springProfile>
    7.  
    9. <springProfile name="prod">
    10.     <logger name="com.atguigu" level="ERROR">
    11.         <appender-ref ref="CONSOLE" />
    12.         <appender-ref ref="FILE" />
    13.     logger>
    14. springProfile>

    四、滚动日志

    问题：生产环境下，如果系统长时间运行，那么日志文件会变得越来越大，系统读取和写入日志的时间会越来越慢，严重的情况会耗尽系统内存，导致系统宕机。

    解决方案：可以设置滚动日志。

    1、设置时间滚动策略

    RollingFileAppender是Appender的另一个实现，表示滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将旧日志备份到其他文件

    是的子节点，用来定义滚动策略。

    TimeBasedRollingPolicy：最常用的滚动策略，根据时间来制定滚动策略。

    ：包含文件名及转换符， “%d”可以包含指定的时间格式，如：%d{yyyy-MM-dd}。如果直接使用 %d，默认格式是 yyyy-MM-dd。

    ：可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。

    1. <appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    2.  
    3.     
    4.     <file>${log.path}/log-rolling.logfile>
    5.     <encoder>
    6.         <pattern>${FILE_LOG_PATTERN}pattern>
    7.         <charset>${ENCODING}charset>
    8.     encoder>
    9.  
    10.  
    11.     
    12.     <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    13.         
    14.         <fileNamePattern>${log.path}/info/log-rolling-%d{yyyy-MM-dd}.logfileNamePattern>
    15.         
    16.         <maxHistory>15maxHistory>
    17.     rollingPolicy>
    18.  
    19. appender>

    2、设置触发滚动时机

    放在的子节点的位置，基于实践策略的触发滚动策略

    设置触发滚动条件：单个文件大于100M时生成新的文件

    注意：修改日志文件名 此时 ${log.path}/info/log-rolling-%d{yyyy-MM-dd}.%i.log

    1. <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    2.     <maxFileSize>1KBmaxFileSize>
    3. timeBasedFileNamingAndTriggeringPolicy>

    五、完整的日志配置文件

    1. "1.0" encoding="UTF-8"?>
    2. <configuration>
    3.  
    4.     <contextName>atguiguSrbcontextName>
    5.  
    6.     
    7.     <property name="log.path" value="D:/project/test/srb_log/core" />
    8.  
    9.     
    10.     
    11.     
    12.     
    13.     
    14.     
    15.     <property name="CONSOLE_LOG_PATTERN"
    16.               value="%yellow(%date{yyyy-MM-dd HH:mm:ss}) %highlight([%-5level]) %green(%logger) %msg%n"/>
    17.  
    18.     
    19.     <property name="FILE_LOG_PATTERN"
    20.               value="%date{yyyy-MM-dd HH:mm:ss} [%-5level] %thread %file:%line %logger %msg%n" />
    21.  
    22.     
    23.     <property name="ENCODING"
    24.               value="UTF-8" />
    25.  
    26.     
    27.     <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    28.         <encoder>
    29.             <pattern>${CONSOLE_LOG_PATTERN}pattern>
    30.             <charset>${ENCODING}charset>
    31.         encoder>
    32.     appender>
    33.  
    34.     
    35.     <appender name="FILE" class="ch.qos.logback.core.FileAppender">
    36.         <file>${log.path}/log.logfile>
    37.         <append>trueappend>
    38.         <encoder>
    39.             <pattern>${FILE_LOG_PATTERN}pattern>
    40.             <charset>${ENCODING}charset>
    41.         encoder>
    42.     appender>
    43.  
    44.     <appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    45.  
    46.         
    47.         <file>${log.path}/log-rolling.logfile>
    48.         <encoder>
    49.             <pattern>${FILE_LOG_PATTERN}pattern>
    50.             <charset>${ENCODING}charset>
    51.         encoder>
    52.  
    53.  
    54.         
    55.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    56.             
    57.             <fileNamePattern>${log.path}/info/log-rolling-%d{yyyy-MM-dd}.%i.logfileNamePattern>
    58.             
    59.             <maxHistory>15maxHistory>
    60.  
    61.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    62.                 <maxFileSize>1KBmaxFileSize>
    63.             timeBasedFileNamingAndTriggeringPolicy>
    64.         rollingPolicy>
    65.  
    66.     appender>
    67.  
    68.  
    69.     
    70.     
    71.     
    72.     
    73.  
    74.     
    75.     <springProfile name="dev,test">
    76.         <logger name="com.atguigu" level="INFO">
    77.             <appender-ref ref="CONSOLE" />
    78.         logger>
    79.     springProfile>
    80.  
    81.     
    82.     <springProfile name="prod">
    83.         <logger name="com.atguigu" level="ERROR">
    84.             <appender-ref ref="CONSOLE" />
    85.             <appender-ref ref="ROLLING_FILE" />
    86.         logger>
    87.     springProfile>
    88. configuration>

  • 相关阅读:
    【D3.js】2.2-给 Circle 元素添加属性
    十一、做高并发内存池项目过程中遇到的bug以及调试bug的方法和心得
    docker搭建本地私有仓库
    Hive的相关操作
    【IDEA配置】IDEA配置
    关于遍历，递归，Divide and Conque，回溯，Memorization和DP的一个小结
    计算机毕业设计Python+Django的高考志愿填报辅助系统(源码+系统+mysql数据库+Lw文档）
    keil和proteus联动要点
    【LeetCode-数组】--搜索插入位置
    任务调度线程池-应用定时任务
  • 原文地址：https://blog.csdn.net/m0_62436868/article/details/126654478