SpringBoot中的日志管理

4. ־

Spring Bootڲ־ʹ Commons Logging Եײ־ʵֱֿš Ϊ Java Util Logging Log4j2 Logback ṩĬá ÿһ£¼loggerԤΪʹÿ̨Ҳѡļ

Ĭ£ʹ StarterĬʹLogback ʵLogback·ҲڣȷʹJava Util LoggingCommons LoggingLog4JSLF4Jⶼȷ

4.1. ־ʽ

Spring BootĬϵ־ʽӡ

2023-03-03T21:18:18.827+08:00 INFO 19388 --- [ main] o.s.b.d.f.s.MyApplication : Starting MyApplication using Java 17 with PID 19388 (/opt/apps/myapp.jar started by myuser in /opt/apps/) 2023-03-03T21:18:18.834+08:00 INFO 19388 --- [ main] o.s.b.d.f.s.MyApplication : No active profile set, falling back to 1 default profile: "default" 2023-03-03T21:18:20.439+08:00 INFO 19388 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 8080 (http) 2023-03-03T21:18:20.461+08:00 INFO 19388 --- [ main] o.apache.catalina.core.StandardService : Starting service [Tomcat] 2023-03-03T21:18:20.461+08:00 INFO 19388 --- [ main] o.apache.catalina.core.StandardEngine : Starting Servlet engine: [Apache Tomcat/10.1.5] 2023-03-03T21:18:20.600+08:00 INFO 19388 --- [ main] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded WebApplicationContext 2023-03-03T21:18:20.602+08:00 INFO 19388 --- [ main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 1685 ms 2023-03-03T21:18:21.078+08:00 INFO 19388 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path '' 2023-03-03T21:18:21.093+08:00 INFO 19388 --- [ main] o.s.b.d.f.s.MyApplication : Started MyApplication in 2.998 seconds (process running for 3.601)

Ŀ¡

• DateʱTimeȷ룬

• ־: ERROR, WARN, INFO, DEBUG, TRACE.

• ID

• һ --- ָʵ־ϢĿʼ

• ߳ƣڷУڿ̨ܻᱻضϣ

• ¼ƣͨԴƣͨд

• ־Ϣ

4.2. ̨

Ĭ£־ ERROR``WARN INFO Ϣ̨ Ҳͨ --debug ־Ӧó debug ģʽ

$ java -jar myapp.jar --debug

debugģʽʱһЩļ¼ǶʽHibernateSpring BootΪϢ debugģʽζŽӦóΪ DEBUG ¼Ϣ

⣬ͨӦóʱʹ --trace ־ application.properties ʹ trace=true trace ģʽ ԶһЩļ¼ǶʽHibernate schemaɺSpringϣиټ¼

4.2.1. ɫ

ն֧ANSIͻʹòɫĶ Խ spring.output.ansi.enabled Ϊ ֵֵ֧ԸԶ⡣

ɫͨʹ %clr תؼõġ 򵥵ʽУת־ɫʾ

%clr(%5p)

±־ɫӳϵ

⣬ҲͨΪתṩһѡָӦʹõɫʽ 磬ҪʹıΪɫʹá

%clr(%d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX}){yellow}

֧ɫʽ

• blue

• cyan

• faint

• green

• magenta

• red

• yellow

4.3. ļ

Ĭ£Spring Bootֻ̨¼־д־ļ ڿ̨֮д־ļҪ logging.file.name logging.file.path ԣ磬 application.properties У

±ʾ logging.* αһʹá

־ļڴﵽ10MBʱͻֻ̨һĬ»¼ ERROR WARN INFO Ϣ

4.4. ļֻ־

ʹLogbackʹ application.properties application.yaml ļ΢־ֻá ־ϵͳ㽫ҪԼֱֻã磬ʹLog4J2ôһ log4j2.xml log4j2-spring.xml ļ

ֻ֧ԡ

4.5. ־

ֵ֧־ϵͳͨʹ logging.level.<logger-name>=<level> Spring Environment磬 application.properties־ level TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF ֮һ root ¼loggerļͨ logging.level.root á

ʾ application.properties DZڵ־á

Properties

Yaml

logging.level.root=warn
logging.level.org.springframework.web=debug
logging.level.org.hibernate=error

Ҳʹû־ 磬LOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=DEBUG org.springframework.web Ϊ DEBUG

4.6. ־飨Log Groups

ܹص־¼飬Աͬʱǽãͨá 磬ܾı __ Tomcatصļ¼ļ¼𣬵㲻׼ס߼İ

Ϊ˰⣬Spring BootSpring Environment ж־顣 磬ͨ application.properties м tomcat group

Properties

Yaml

logging.group.tomcat=org.apache.catalina,org.apache.coyote,org.apache.tomcat

һú󣬾Ϳһдıloggerļ

Properties

Yaml

logging.level.tomcat=trace

Spring BootԤ־飬Կ伴á

4.7. ʹ־ Shutdown Hook

ΪӦóֹʱͷ־ԴṩһShutdown HookJVM˳ʱ־ϵͳ ӦówarļʽģShutdown HookԶעᡣ ӦóиӵIJνṹShutdown Hook޷ ܣùػӣоײ־ϵͳֱṩѡ 磬Logbackṩ context selectorsÿ¼Լб ʹ logging.register-shutdown-hook Shutdown Hook Ϊ false עᡣ application.properties application.yaml ļøԡ

Properties

Yaml

logging.register-shutdown-hook=false

4.8. Զ־

־ϵͳͨclasspathϰʵĿҿͨclasspathĸĿ¼» Spring Environment ָλṩһʵļһƣ logging.config

ͨʹ org.springframework.boot.logging.LoggingSystem ϵͳԣǿSpring Bootʹض־ϵͳ ֵӦ LoggingSystem ʵֵȫ Ҳͨʹ none ֵȫSpring Boot־á

־ϵͳļ

Ϊ˰ƣһЩԴSpring Environment תƵSystem properties±ʾ

ʹLogbackҲᱻתơ

ֵ֧־ϵͳڽļʱԴ System properties лȡԡ Ӽ spring-boot.jar еĬá

• Logback

• Log4j 2

• Java Util logging

4.9. Logback չ

Spring BootһЩLogbackչ԰и߼á logback-spring.xml ļʹЩչ

ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for [springProperty], current ElementPath is [[configuration][springProperty]] ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for [springProfile], current ElementPath is [[configuration][springProfile]]

4.9.1. ضļ

<springProfile> ǩԸݻSpringļѡԵذųõIJ֣ ֧ <configuration> Ԫصκεط ʹ name ָõļ <springProfile> ǩ԰һļƣ staging һļʽ ļʽӵļ߼ production & (eu-central | eu-west) 鿴 Spring ܲοָ ˽ϸڡ бʾļ

<springProfile name="staging">
    <!-- configuration to be enabled when the "staging" profile is active -->
</springProfile>

<springProfile name="dev | staging">
    <!-- configuration to be enabled when the "dev" or "staging" profiles are active -->
</springProfile>

<springProfile name="!production">
    <!-- configuration to be enabled when the "production" profile is not active -->
</springProfile>

4.9.2. ԣEnvironment Properties

<springProperty> ǩԷ Spring Environment еԣԱLogbackʹá Logbackз application.properties ļеֵá ñǩĹʽLogbackı׼ <property> ǩơ Ȼ㲻ֱָһ value ָԵ source Environment Ҫ local Χĵط洢ԣʹ scope ԡ ҪһֵĬֵһû Environment ãʹ defaultValue ԡ ʾιԱLogbackʹá

<springProperty scope="context" name="fluentHost" source="myapp.fluentd.host"
        defaultValue="localhost"/>

    <remoteHost>${fluentHost}</remoteHost>
    ...

4.10. Log4j2 չ

Spring BootһЩLog4j2չ԰и߼áκ log4j2-spring.xml ļʹЩչ

4.10.1. ضļ

<SpringProfile> ǩԸݻSpringļѡԵذųõIJ֡ļֱ֧ <Configuration> Ԫصκεطʹ name ָĸļá <SpringProfile> ǩ԰һļƣ stagingһļʽ ļʽӵļ߼ production & (eu-central | eu-west)鿴 Springܲοָ ˽ϸڡ бʾļ

<SpringProfile name="staging">
    <!-- configuration to be enabled when the "staging" profile is active -->
</SpringProfile>

<SpringProfile name="dev | staging">
    <!-- configuration to be enabled when the "dev" or "staging" profiles are active -->
</SpringProfile>

<SpringProfile name="!production">
    <!-- configuration to be enabled when the "production" profile is not active -->
</SpringProfile>

4.10.2. EnvironmentԲ

Log4j2Spring Environment еԣʹ spring: ǰ׺ Log4j2з application.properties ļеֵá

ʾһΪ applicationName Log4j2ԣSpring Environment жȡ spring.application.name

<Properties>
    <Property name="applicationName">${spring:spring.application.name}</Property>
</Properties>

4.10.3. Log4j2 ϵͳԣSystem Properties

Log4j2֧һЩ System PropertiesøĿ磬log4j2.skipJansi ϵͳԿ ConsoleAppender ǷWindowsϳʹ Jansi

Log4j2 ʼصϵͳԶԴSpring Environment лá磬 application.properties ļ log4j2.skipJansi=false ConsoleAppender WindowsʹJansi