个人笔记

ELK-02spring 打印json格式的数据

2025-05-09

spring 打印json格式的数据

创建spring项目

image-20220720152352192

只需要引入 spring-web、lombok即可

image-20220720152556103

示例项目结构

src
├── main
│   ├── java
│   │   └── com
│   │       └── example
│   │           └── elkb0demo
│   │               ├── Elkb0DemoApplication.java
│   │               └── controller
│   │                   └── TestController.java
│   └── resources
│       ├── application.yml
│       ├── logback-spring.xml
│       ├── static
│       └── templates
└── test
    └── java
        └── com
            └── example
                └── elkb0demo
                    └── Elkb0DemoApplicationTests.java
​

application.yml

server:
  port: 8081
logging:
  level:
    com.example.elkb0demo: debug
#  config: classpath:logback-spring.xml
spring:
  application:
    name: test
  profiles:
    active: dev

引入依赖

<dependency>
   <groupId>net.logstash.logback</groupId>
   <artifactId>logstash-logback-encoder</artifactId>
   <version>7.2</version>
</dependency>

配置logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,
如果设置为WARN,则低于WARN的信息都不会输出 -->
<!-- scan:当此属性设置为true时,配置文档如果发生改变,将会被重新加载,默认值为true -->
<!-- scanPeriod:设置监测配置文档是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。
                 当scan为true时,此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。
默认值为false。 -->
<configuration scan="true" scanPeriod="10 seconds">
    <property resource="application.yml"/>
​
    <!-- name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义后,可以使“${}”来使用变量。 -->
    <springProperty scop="context" name="spring.application.name" source="spring.application.name" defaultValue="test"/>
    <property name="log.path" value="${user.dir}/logs/${spring.application.name}"/>
​
​
    <!--输出到控制台-->
​
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        此日志appender是为开发使用,只配置最底级别,控制台输出的日志级别是大于或等于此级别的日志信息
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>info</level>
        </filter>
​
        <encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
            <providers class="net.logstash.logback.composite.loggingevent.LoggingEventJsonProviders">
                <arguments>
                    <includeNonStructuredArguments>false</includeNonStructuredArguments>
                </arguments>
                <pattern>
                    <pattern>
                        {
                        "date":"%date{"yyyy-MM-dd HH:mm:ss.SSS",UTC}",
                        "level":"%level",
                        "message":"%msg",
                        "traceId": "%mdc{traceId}",
                        "thread": "%thread",
                        "serverName": "${spring.application.name}"
                        }
                    </pattern>
                </pattern>
                <stackTrace>
                    <throwableConverter class="net.logstash.logback.stacktrace.ShortenedThrowableConverter">
                        <maxDepthPerThrowable>30</maxDepthPerThrowable>
                        <maxLength>2048</maxLength>
                        <shortenedClassNameLength>100</shortenedClassNameLength>
                        <!--                        <exclude>^sun.reflect..*.invoke</exclude>-->
                        <exclude>^net.sf.cglib.proxy.MethodProxy.invoke</exclude>
                        <!--                        <evaluator class="myorg.MyCustomEvaluator"/>-->
                        <rootCauseFirst>true</rootCauseFirst>
                    </throwableConverter>
                </stackTrace>
            </providers>
            <!--            <charset>UTF-8</charset>-->
        </encoder>
    </appender>
​
    <!--level为 INFO 日志,时间滚动输出  -->
    <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在记录的日志文档的路径及文档名 -->
        <file>${log.path}/${spring.application.name}_info.log</file>
        <!--日志文档输出格式-->
        <encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
​
            <providers class="net.logstash.logback.composite.loggingevent.LoggingEventJsonProviders">
                <arguments>
                    <includeNonStructuredArguments>false</includeNonStructuredArguments>
                </arguments>
                <pattern>
                    <pattern>
                        {
                        "date":"%date{"yyyy-MM-dd HH:mm:ss.SSS",UTC}",
                        "level":"%level",
                        "message":"%msg",
                        "traceId": "%mdc{traceId}",
                        "thread": "%thread"
                        }
                    </pattern>
                </pattern>
                <stackTrace>
                    <throwableConverter class="net.logstash.logback.stacktrace.ShortenedThrowableConverter">
                        <maxDepthPerThrowable>30</maxDepthPerThrowable>
                        <maxLength>2048</maxLength>
                        <shortenedClassNameLength>100</shortenedClassNameLength>
                        <!--                        <exclude>^sun.reflect..*.invoke</exclude>-->
                        <!--                        <exclude>^net.sf.cglib.proxy.MethodProxy.invoke</exclude>-->
                        <!--                        <evaluator class="myorg.MyCustomEvaluator"/>-->
                        <rootCauseFirst>true</rootCauseFirst>
                    </throwableConverter>
                </stackTrace>
            </providers>
​
            <!--            <charset>UTF-8</charset>-->
        </encoder>
        <!-- 日志记录器的滚动策略,按日期,按大小记录 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天日志归档路径以及格式 -->
            <fileNamePattern>${log.path}/${spring.application.name}-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文档保留天数-->
            <maxHistory>15</maxHistory>
        </rollingPolicy>
        <!-- 此日志文档只记录info级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
​
    <logger name="org.springframework" level="INFO"/>
    <!--开发环境:打印控制台-->
    <springProfile name="dev">
        <root level="info">
            <appender-ref ref="CONSOLE"/>
            <appender-ref ref="INFO_FILE"/>
        </root>
    </springProfile>
​
​
</configuration>
​

启动项目

​
  .   ____          _            __ _ _
 /\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )___ | '_ | '_| | '_ / _` | \ \ \ \
 \/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |___, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::               (v2.5.13)
​
{"date":"2022-07-20 07:22:37.863","level":"INFO","message":"The following 1 profile is active: "dev"","traceId":"","thread":"main","serverName":"test"}
{"date":"2022-07-20 07:22:38.721","level":"INFO","message":"BeanFactory id=78af57f2-3719-3e3e-8658-7353464f7be8","traceId":"","thread":"main","serverName":"test"}
{"date":"2022-07-20 07:22:39.276","level":"INFO","message":"Tomcat initialized with port(s): 8081 (http)","traceId":"","thread":"main","serverName":"test"}
{"date":"2022-07-20 07:22:39.336","level":"INFO","message":"Initializing ProtocolHandler ["http-nio-8081"]","traceId":"","thread":"main","serverName":"test"}
{"date":"2022-07-20 07:22:39.337","level":"INFO","message":"Starting service [Tomcat]","traceId":"","thread":"main","serverName":"test"}
{"date":"2022-07-20 07:22:39.338","level":"INFO","message":"Starting Servlet engine: [Apache Tomcat/9.0.62]","traceId":"","thread":"main","serverName":"test"}
{"date":"2022-07-20 07:22:39.503","level":"INFO","message":"Initializing Spring embedded WebApplicationContext","traceId":"","thread":"main","serverName":"test"}
{"date":"2022-07-20 07:22:39.503","level":"INFO","message":"Root WebApplicationContext: initialization completed in 1606 ms","traceId":"","thread":"main","serverName":"test"}
{"date":"2022-07-20 07:22:39.981","level":"WARN","message":"Spring Cloud LoadBalancer is currently working with the default cache. You can switch to using Caffeine cache, by adding it and org.springframework.cache.caffeine.CaffeineCacheManager to the classpath.","traceId":"","thread":"main","serverName":"test"}
{"date":"2022-07-20 07:22:40.081","level":"INFO","message":"Starting ProtocolHandler ["http-nio-8081"]","traceId":"","thread":"main","serverName":"test"}
{"date":"2022-07-20 07:22:40.106","level":"INFO","message":"Tomcat started on port(s): 8081 (http) with context path ''","traceId":"","thread":"main","serverName":"test"}
{"date":"2022-07-20 07:22:40.119","level":"INFO","message":"Started Elkb0DemoApplication in 3.654 seconds (JVM running for 4.409)","traceId":"","thread":"main","serverName":"test"}
​

为什么使用json格式的log?

1、方便filebeat转换数据到ES中、不需要写特别的pipeline转换。

2、省去写正则解析数据的麻烦,日志格式和正则不匹配无法存储数据。