企業(yè)級應(yīng)用中学歧,日志可以幫助我們監(jiān)控分析系統(tǒng)行為罩引,收集診斷性信息,定位問題枝笨。
Java的世界里有很多l(xiāng)og框架
一袁铐、slf4j
SLF4J的全稱是Simple Logging Facade for Java,基于外觀模式横浑,它為常用的日志框架如Java util logging昭躺,logback,log4j提供了一個統(tǒng)一外觀接口伪嫁。開發(fā)者通過調(diào)用slf4j可以實現(xiàn)與具體日志框架的解耦领炫。slf4j最佳實踐如下,推薦使用Logger factory基于工廠模式獲取logger實例张咳,傳入?yún)?shù)推薦使用class帝洪,如this.getClass()。當(dāng)我們需要在日志中引用變量時脚猾,推薦使用參數(shù)化日志葱峡,即下圖中的大括號{}。
使用參數(shù)化日志的優(yōu)點在于性能龙助。針對下圖第一種寫法砰奕,花銷在于無論是否要打印該日志,都需要構(gòu)造字符串參數(shù)提鸟。針對第二種寫法军援,只有需要打印時,才需要構(gòu)造字符串称勋,花銷在于判斷是否需要打印胸哥。更好的寫法是上圖中的花括號,只有確認(rèn)需要打印時赡鲜,才需要把花括號替代為參數(shù)值并構(gòu)造字符串空厌。
二、Logback
2.1 logback組件
(1)logger:logger獲取日志數(shù)據(jù)并通過appender存儲到目的地银酬;有多種日志級別嘲更。
(2)appender:用于指示存儲日志數(shù)據(jù)的目的地。
(3)layout:Layout用于把日志事件轉(zhuǎn)化為字符串揩瞪。通常使用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進(jìn)行配置,也可以通過下列參數(shù)指定配置文件的路徑琳拨。
文章最后附logback xml配置文件瞭恰。常用的一種file appender是rolling file appender,且可以指定具體的rolling policy狱庇,常用的是timeBasedRollingPolicy和SizeBasedTriggeringPolicy惊畏。
2.3 logback和spring boot
盡管Java的世界里有很多l(xiāng)og框架,但spring boot選擇logback作為他的默認(rèn)log框架密任,無須額外聲明logback和slf4j的依賴颜启。可以通過application.properties來進(jìn)行配置浪讳,對于更高級的配置缰盏,可以通過logback-spring.xml進(jìn)行配置。
2.4 MDC(Mapped Diagnostic Contexts)
MDC本質(zhì)上是一個Map,基于線程用于存儲任意鍵值對,通常是調(diào)用的上下文(context)信息衔掸,由應(yīng)用代碼存儲鍵值對,并由日志框架應(yīng)用到日志消息中济炎。比如,當(dāng)系統(tǒng)接收到請求時辐真,系統(tǒng)會把請求ID须尚,請求發(fā)起方ID,請求發(fā)起方IP地址和請求參數(shù)放在MDC侍咱。目前支持MDC的日志框架包括log4j和logback耐床。
其中%X{key}就是在引用MDC中的內(nèi)容,key即為MDC中存儲鍵值對的key放坏。
三咙咽、ELK與Splunk
ELK包含三個開源組件:Elastic search,Logstash淤年,Kibana。Elastic用于搜索和分析蜡豹;Logstash用于接收來自多個數(shù)據(jù)源的數(shù)據(jù)麸粮,進(jìn)行轉(zhuǎn)換并發(fā)送到Elastic search;Kibana提供圖表對Elastic search的結(jié)果進(jìn)行可視化镜廉。
附: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