企业级应用中,日志可以帮助我们监控分析系统行为,收集诊断性信息,定位问题。
Java的世界里有很多log框架
一、slf4j
SLF4J的全称是Simple Logging Facade for Java,基于外观模式,它为常用的日志框架如Java util logging,logback,log4j提供了一个统一外观接口。开发者通过调用slf4j可以实现与具体日志框架的解耦。slf4j最佳实践如下,推荐使用Logger factory基于工厂模式获取logger实例,传入参数推荐使用class,如this.getClass()。当我们需要在日志中引用变量时,推荐使用参数化日志,即下图中的大括号{}。
使用参数化日志的优点在于性能。针对下图第一种写法,花销在于无论是否要打印该日志,都需要构造字符串参数。针对第二种写法,只有需要打印时,才需要构造字符串,花销在于判断是否需要打印。更好的写法是上图中的花括号,只有确认需要打印时,才需要把花括号替代为参数值并构造字符串。
二、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
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进行配置。
2.4 MDC(Mapped Diagnostic Contexts)
MDC本质上是一个Map,基于线程用于存储任意键值对,通常是调用的上下文(context)信息,由应用代码存储键值对,并由日志框架应用到日志消息中。比如,当系统接收到请求时,系统会把请求ID,请求发起方ID,请求发起方IP地址和请求参数放在MDC。目前支持MDC的日志框架包括log4j和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