Spring Boot与logback的那XX件事

前言

    套用网络流行的标题,开始了这篇文章。之前使用Spring Boot,日志一直都是nohup再把标准输出重定向到一个文件里,这样毫无疑问是很low的。于是趁着项目的间歇,照着网上的教程哼哧哼哧的把logback配起来。配完之后,再想想怎么用起来更高大上一点,就给自己提了下面几个问题:

  • 不同级别的日志怎么输出到不同的文件?
  • 不同服务的日志怎么输出到不同的文件?
  • 怎么通过一个traceId把同一次请求里的多条日志串起来?
  • 日志的配置怎么在打包时能根据不同的环境去调整?
  • 运行中的服务可以动态的调整日志级别么?

    为了解决这些问题,就有了文章标题所说的那XX件事。下面将大概介绍下各个问题的解决方案。最终的成果在代码中:
    logtest

1.Filter

    第一个问题的解决方案,就是使用appender中的Filter。logback支持多种Filter,对于日志级别的过滤使用LevelFilter。

<appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <encoder>
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{requestId}] [%-5level] [%logger{36}:%line] - [%msg]%n
        </pattern>
        <charset>UTF-8</charset>
    </encoder>
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <FileNamePattern>${LOG_HOME}/${APP_NAME}/debug.log.%d{yyyy-MM-dd}</FileNamePattern>
        <MaxHistory>${LOG_KEEP_TIME}</MaxHistory>
    </rollingPolicy>
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>DEBUG</level>
        <onMatch>ACCEPT</onMatch>
        <onMismatch>DENY</onMismatch>
    </filter>
 </appender>

2.logger

    之前配置日志总是喜欢把appender都配置在root下,这个是一种全局的配置,其实可以通过logger进一步细化。

<logger name="tactics" additivity="false" level="INFO">
    <appender-ref ref="tactics"/>
</logger>

    对应的获取logger方法为:

private final Logger tacticsLogger = LoggerFactory.getLogger("tactics");

    也可以按照我们惯用的方式:

<logger name="com.qcd.logtest.TacticsLogger" additivity="false" level="INFO">
    <appender-ref ref="tactics"/>
</logger>

    对应的获取logger方法为:

private final Logger tacticsLogger = LoggerFactory.getLogger(getClass());

    logger里面有个很重要的属性additivity,这个属性决定了日志里的内容是否会向上一级日志传递。

3.MDC

    对于第三个问题想过自己去封装一个日志工具类,通过ThreadLocal的方式来提供uuid,但是总觉得没那么自然。也看到有人用Spring Cloud Sleuth来达到目的,又觉得太重。后面发现了MDC这个好东西,觉得很满意。
    MDC(Mapped Diagnostic Context,映射调试上下文)是 logback 提供的一种方便在多线程条件下记录日志的功能。MDC 可以看成是一个与当前线程绑定的哈希表,可以往其中添加键值对。
    具体的使用代码可以参考LogInterceptor.java
    其中比较关键的两处如下:

MDC.put("requestId", uuid);
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{requestId}] [%-5level] [%logger{36}:%line] - [%msg]%n

    在pattern中使用的[%X{requestId}]就是来自在MDC中存储的uuid。

4.logback-spring.xml

    既然加上了spring这么个后缀,肯定会给你好处的。

  • 可以拿到application.properties里的配置:
<springProperty scope="context" name="logPath" source="logging.path"/>
<property name="LOG_HOME" value="${logPath}"/>
  • 可以拿到使用的profile
<springProfile name="test,dev">
     <logger name="com.qcd.logtest.TacticsLogger" level="INFO" />
</springProfile>
<springProfile name="pro">
     <logger name="com.qcd.logtest.TacticsLogger" level="ERROR" />
</springProfile>

5.actuator

    spring1.5.X版本引入的一个新的控制端点:/loggers,这个端点非常强大,可以查看当前的日志级别,还可以动态修改日志级别。比如要修改LogtestController的日志级别,通过发送POST请求到:

http://localhost:9011/manage/loggers/com.qcd.logtest.controller.LogtestController

    请求体为:

{
    "configuredLevel": "DEBUG"
}

最后

    感谢强大的开源社区,感谢互联网上那些无私奉献的同道!!!

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

推荐阅读更多精彩内容