Java日志管理-slf4j,logback,MDC

企业级应用中,日志可以帮助我们监控分析系统行为,收集诊断性信息,定位问题。

Java的世界里有很多log框架

一、slf4j

SLF4J的全称是Simple Logging Facade for Java,基于外观模式,它为常用的日志框架如Java util logging,logback,log4j提供了一个统一外观接口。开发者通过调用slf4j可以实现与具体日志框架的解耦。slf4j最佳实践如下,推荐使用Logger factory基于工厂模式获取logger实例,传入参数推荐使用class,如this.getClass()。当我们需要在日志中引用变量时,推荐使用参数化日志,即下图中的大括号{}。

sfl4j最佳实践

使用参数化日志的优点在于性能。针对下图第一种写法,花销在于无论是否要打印该日志,都需要构造字符串参数。针对第二种写法,只有需要打印时,才需要构造字符串,花销在于判断是否需要打印。更好的写法是上图中的花括号,只有确认需要打印时,才需要把花括号替代为参数值并构造字符串。

第一种写法
第二种写法

二、Logback

logback

2.1 logback组件

(1)logger:logger获取日志数据并通过appender存储到目的地;有多种日志级别。

(2)appender:用于指示存储日志数据的目的地。

(3)layout:Layout用于把日志事件转化为字符串。通常使用PatternLayout,这里的pattern和C语言中printf的pattern相同,以%开头。具体的pattern可查询:https://logback.qos.ch/manual/layouts.html

layout
输出消息

2.2 logback配置

logback支持基于XML和基于Groovy的配置,项目中常用的是XML配置,即通过classpath下面的logback.xml和logback-test.xml进行配置,也可以通过下列参数指定配置文件的路径。

通过参数指定配置文件路径

文章最后附logback xml配置文件。常用的一种file appender是rolling file appender,且可以指定具体的rolling policy,常用的是timeBasedRollingPolicy和SizeBasedTriggeringPolicy。

2.3 logback和spring boot

尽管Java的世界里有很多log框架,但spring boot选择logback作为他的默认log框架,无须额外声明logback和slf4j的依赖。可以通过application.properties来进行配置,对于更高级的配置,可以通过logback-spring.xml进行配置。

通过application.properties配置logback
通过logback-spring.xml配置logback

2.4 MDC(Mapped Diagnostic Contexts)

MDC本质上是一个Map,基于线程用于存储任意键值对,通常是调用的上下文(context)信息,由应用代码存储键值对,并由日志框架应用到日志消息中。比如,当系统接收到请求时,系统会把请求ID,请求发起方ID,请求发起方IP地址和请求参数放在MDC。目前支持MDC的日志框架包括log4j和logback。

logback配置文件

其中%X{key}就是在引用MDC中的内容,key即为MDC中存储键值对的key。

三、ELK与Splunk

ELK包含三个开源组件:Elastic search,Logstash,Kibana。Elastic用于搜索和分析;Logstash用于接收来自多个数据源的数据,进行转换并发送到Elastic search;Kibana提供图表对Elastic search的结果进行可视化。

附:logback配置文件

<?xml version="1.0" encoding="UTF-8"?>

<configuration debug="true" scan="true" scanPeriod="30 seconds">

    <property name="LOG_PATH" value="logs" />

    <property name="LOG_ARCHIVE" value="${LOG_PATH}/archive" />

    <timestamp key="timestamp-by-second" datePattern="yyyyMMdd'T'HHmmss"/>

    <appender name="Console-Appender" class="ch.qos.logback.core.ConsoleAppender">

        <layout>

            <pattern>%msg%n</pattern>

        </layout>

    </appender>

    <appender name="File-Appender" class="ch.qos.logback.core.FileAppender">

        <file>${LOG_PATH}/logfile-${timestamp-by-second}.log</file>

        <encoder>

            <pattern>%msg%n</pattern>

            <outputPatternAsHeader>true</outputPatternAsHeader>

        </encoder>

    </appender>

    <appender name="RollingFile-Appender" class="ch.qos.logback.core.rolling.RollingFileAppender">

        <file>${LOG_PATH}/rollingfile.log</file>

        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

            <fileNamePattern>${LOG_ARCHIVE}/rollingfile.log%d{yyyy-MM-dd}.log</fileNamePattern>

            <maxHistory>30</maxHistory>

            <totalSizeCap>1KB</totalSizeCap>

        </rollingPolicy>

        <encoder>

            <pattern>%msg%n</pattern>

        </encoder>

    </appender>

    <appender name="Async-Appender" class="ch.qos.logback.classic.AsyncAppender">

        <appender-ref ref="RollingFile-Appender" />

    </appender>

    <logger name="guru.springframework.blog.logbackxml"  level="info" additivity="false">

        <appender-ref ref="Console-Appender" />

        <appender-ref ref="File-Appender" />

        <appender-ref ref="Async-Appender" />

    </logger>

    <root>

        <appender-ref ref="Console-Appender" />

    </root>

</configuration

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 在项目开发过程中,我们可以通过 debug 查找问题。而在线上环境我们查找问题只能通过打印日志的方式查找问题。因此...
    Java架构阅读 8,802评论 2 41
  • 说在之前的话 本次交流所有的信息都是个人感受,有其他意见大家可以一起交流。正所谓文无第一,武无第二。在没有严格的规...
    丁逸阅读 5,193评论 3 2
  • Log Java日志:(slf4j、log4j、logback、common-logging ) slf4j 是规...
    年少懵懂丶流年梦阅读 17,798评论 1 11
  • 一:根节点包含的属性: scan: 当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为tru...
    把爱放下会走更远阅读 3,826评论 0 0
  • 作为Java开发人员,对于日志记录框架一定非常熟悉。而且几乎在所有应用里面,一定会用到各种各样的日志框架用来记录程...
    意识流丶阅读 14,779评论 0 13