SpringBoot日志logback配置

SpringBoot日志logback配置

在前一个项目simple-boot-demo项目中配置日志相关。

SpringBoot日志依赖为:spring-boot-starter-logging,不过对于web项目,已经引入了spring-boot-starter-web,默认已经自带了日志的spring-boot-starter-logging,已经默认引入了logback实现,只需要配置application.yml即可。

<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>${logback.version}</version>
</dependency>

Spring内部使用Commons Logging,SpringBoot项目日志实现可以用log4j2,logback,JDK (Java Util Logging)等。

参考文档:

https://docs.spring.io/spring-boot/docs/2.2.6.RELEASE/reference/html/howto.html#howto-logging

https://docs.spring.io/spring-boot/docs/2.2.6.RELEASE/reference/html/spring-boot-features.html#boot-features-logging

使用默认logback

配置日志级别

level是个map,配置不同的日志名称的级别,一般情况下都是配置些包名称就可以了,因为一般都是用类名作为日志名称,常见写法如下:

private static final Logger logger = LoggerFactory.getLogger(SomeClass.class);
logging:
  level: # level是个map,配置不同的日志名称的级别
    root: error
    org.springframework: debug

配置文件日志

默认配置下只会在控制台输出日志,没有文件日志,可以配置文件名来控制文件输出。

日志文件配置:

logging.file.name logging.file.path 示例 描述
(none) (none) 只有控制台日志
指定文件名 (none) my.log 指定文件名,相对路径的话在当前目录,也可以是绝对路径
(none) 指定文件目录 /var/log 指定相对或绝对目录,默认文件名为:spring.log

日志配置示例:

logging:
  file:
    name: C:/simple-logs/simple-boot-demo.log

文件日志详情

另外一些文件日志配置如下,主要配置文件大小分隔、历史记录、输出格式等,这些配置在IDE中都有提示输入:

logging:
  file:
    name: C:/simple-logs/simple-boot-demo.log
    max-size: 10MB # 单个文件大小
    max-history: 7 # 最大历史天数7天
    total-size-cap: 0B # 总文件大小限制0MB,无限制
  patten:
    file: %d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}
  level: # level是个map,配置不同的日志名称的级别
    root: error
    org.springframework: debug

注意:这些配置在使用自定义的配置文件logging.config=classpath:logback-spring.xml时,如果include引入sping-boot项目中的logback配置xml片段,这些application.yml中的配置也是有效的,而且level配置还是优先于配置文件

日志分组配置

日志可以分组配置,针对部分日志名称定义一个分组,可以统一配置此分组的级别:

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

SpringBoot内置的日志分组:

Name Loggers
web org.springframework.core.codec, org.springframework.http, org.springframework.web, org.springframework.boot.actuate.endpoint.web, org.springframework.boot.web.servlet.ServletContextInitializerBeans
sql org.springframework.jdbc.core, org.hibernate.SQL, org.jooq.tools.LoggerListener

使用自定义logback

SpringBoot如果要使用自定义的logback作为日志实现,需要编写logback.xml,但是引入logback之后,logback会自动查找logback.xml,因此不能把名字定义为logback.xml,否则可能早于SpringBoot初始化,造成一些配置无效问题。

自定义配置文件

使用logback-spring.xml或者使用loging.config来指定配置文件(默认名字为logback-spring.xml的文件springboot会自动获取到,自定义名字需要手动配置):

logging:
  config: classpath:demo-logback.xml

logback配置文件

在spring-boot项目的jar包中,spring为了简化配置,已经在项目中内置了一些logback的配置片段,方便使用include方式引入,打开可以看到内容是用<included></include>包裹,因此自定义配置文件logback.xml的时候直接include即可。

配置片段路径:org/springframework/boot/logging/logback/

文件名 说明
defaults.xml 默认的一些日志配置
console-appender.xml 控制台输出appender等
file-appender.xml 文件输出appender等
base.xml 基础配置,包含上面的三个配置文件,兼容老版本springboot的配置

典型logback.xml配置文件如下,其中引用了spring-boot提供的xml片段:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />
    <include resource="org/springframework/boot/logging/logback/console-appender.xml" />
    <include resource="org/springframework/boot/logging/logback/file-appender.xml" />
    <root level="debug">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE" />
    </root>
    <logger name="org.springframework.web" level="ERROR"/>
</configuration>

上面的配置是文件取名为demo-logback.xml,方便引入。

配置application.yml:

logging:
  file:
    name: C:/simple-logs/simple-boot-demo.log
    max-size: 100KB # 可以改大小测试生成多个带时间信息的文件
    max-history: 7
    total-size-cap: 0MB
  config: classpath:demo-logback.xml

总结

  1. SpringBoot项目在通常情况下不需要用自定义的logback.xml配置,除非还需要为日志做一些定制(如需要append到logstash等),否则直接使用application.yml配置就足够了。
  2. 自定义logback.xml,最好自定义一个名称或者使用logback-spring.xml
  3. 使用include方式引入spring-boot.jar中的xml的时候,application.yml中很多配置也是有效的。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,047评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,807评论 3 386
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,501评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,839评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,951评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,117评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,188评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,929评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,372评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,679评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,837评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,536评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,168评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,886评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,129评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,665评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,739评论 2 351

推荐阅读更多精彩内容