spring-boot2 config logging

Posted on In Disqus:

需求说明

  • 需求如下
    1
    2
    3
    - 配置spring boot logging 
         自定义配置日志 pattern/logger-level/file

实现

  • maven pom 
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    <?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>

        <groupId>org.example</groupId>
        <artifactId>springboot-schedule-shade-lock</artifactId>
        <version>1.0-SNAPSHOT</version>

        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.3.1.RELEASE</version>
            <relativePath/> <!-- lookup parent from repository -->
        </parent>
        <properties>
            <shedlock.version>4.29.0</shedlock.version>
            
            <mysql-connector.version>5.1.49</mysql-connector.version>
        </properties>

        <dependencies>
            <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            </dependency>

            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>

            <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
            </dependency>
        </dependencies>
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    </project>
  • application.yml 
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    logging:
      pattern:
        console: "%magenta(%date{ISO8601}) %blue([%thread]) %highlight([%level]) %cyan(%logger{15}:%line) - %green(%msg %n)"
        file: "%date{ISO8601} [%thread] [%level] %logger{15}:%line %msg%n"
      level:
        org.springframework.web: DEBUG
        org.apahe: ERROR
      file:
        path: ./logs
        name: ./logs/logger.log
  • main class
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14

    import lombok.extern.slf4j.Slf4j;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;

    @SpringBootApplication
    @Slf4j
    public class ScheduleApp {

        public static void main(String[] args) {
            SpringApplication.run(ScheduleApp.class, args);
            log.info(" start app ==== SUCCESS ===== ");
        }
    }

结果

  • console 日志效果： console pattern 配置color 让日志查看更加友好.

  • file 日志效果： file pattern 保证了日志个是的统一，便于ELK进行收集.

解读

spring-boot默认使用spring-boot-logging作为日志模块，在使用中以slf4j 作为日志标准接口，使用logback 作为日志实现模块。

  • 自定义配置file/console pattern console 使用 color layout 配置颜色，便于控制台高效查看日志
  • 指定logger level 在application.yml指定logger level
  • 更复杂的日志输出，比如指定特殊的logger需要通过配置spring-logback实现

参考