您的位置:首頁技術文章
文章詳情頁

spring boot使用logback日志級別打印控制操作

瀏覽:2日期:2023-07-21 13:31:40

因為公司業務需要,需要把性能日志和業務日志分開打印,用elk收集處理,所以需要對不同的業務的日志,打印到不同文件。

使用的是spring boot自帶的logback。

首先在yml文件配置logback.xml文件,默認會從resources下找logback.xml文件,找不到會從yml文件中找logging.config下的指定文件。

logging: level: DEBUG config: classpath:logback.xml

logback.xml是logback的配置文件,可以設置打印文件的路徑,格式,過濾打印的級別等等,我們來看一下logback.xml文件。

<?xml version='1.0' encoding='UTF-8'?><!--根標簽--><configuration> <!--設置變量,name為變量名,value為值,可以使用${變量名}方式使用--> <property name='APPDIR' value='log' /> <property name='LOG_HOME' value='/var/app/logs' /> <property name='APPNAME' value='app_test' /> <property name='MDC_LOG_PATTERN' value='%d{yyyy-MM-dd’T’HH:mm:ss.SSS} %p app_test %t %logger{50} [line:%L %msg]%n'></property> <!-- 性能日志記錄器,日期滾動記錄 --> <!--當一個記錄日志的事件被發起時,logback 會將這個事件發送給 appender--> <!--RollingFileAppender,滾動記錄文件,先將日志記錄到指定文件,當符合某個條件時,將日志記錄到其他文件--> <appender name='performanceAppender' class='ch.qos.logback.core.rolling.RollingFileAppender'> <!-- 記錄的日志文件的路徑及文件名 --> <file>${LOG_HOME}/${APPNAME}/performanceLog/${APPNAME}.log</file> <!-- 日志記錄器的滾動策略,按日期,按大小記錄 --> <!--TimeBasedRollingPolicy 實現的是基于時間的分包策略,分包間隔是根據fileNamePattern中指定的事件最小單位--> <rollingPolicy class='ch.qos.logback.core.rolling.TimeBasedRollingPolicy'> <!-- 歸檔的日志文件的路徑,例如今天是2018-12-19日志,當前寫的日志文件路徑為file節點指定,可以將此文件與file指定文件路徑設置為不同路徑,從而將當前日志文件或歸檔日志文件置不同的目錄。而2018-12-01的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式,%i指定索引 --> <fileNamePattern>${LOG_HOME}/${APPNAME}/performanceLog/${APPNAME}-%d{yyyyMMdd}.%i.log</fileNamePattern> <!-- 除按日志記錄之外,還配置了日志文件不能超過50Mb,若超過50Mb,日志文件會以索引0開始, 命名日志文件,例如app_test-20181219.0.log --> <timeBasedFileNamingAndTriggeringPolicy class='ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP'><!--最大50mb--><maxFileSize>50MB</maxFileSize> </timeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <!-- 追加方式記錄日志 --> <append>true</append> <!-- 日志文件的格式和編碼 --> <encoder class='ch.qos.logback.classic.encoder.PatternLayoutEncoder'> <pattern>%d{yyyy/MM/dd’ ’HH:mm:ss.SSS} %X{req.requestId}[line:%L %msg] %n</pattern> <charset>utf-8</charset> </encoder> <!--此日志文件只記錄info級別的--> <!--filter是日志過濾器--> <filter class='ch.qos.logback.classic.filter.LevelFilter'> <!--過濾級別--> <level>info</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- 運行日志記錄器,日期滾動記錄 --> <appender name='bizAppender' class='ch.qos.logback.core.rolling.RollingFileAppender'> <!-- 正在記錄的日志文件的路徑及文件名 --> <file>${LOG_HOME}/${APPNAME}/bizLog/${APPNAME}.log</file> <!-- 日志記錄器的滾動策略,按日期,按大小記錄--> <rollingPolicy class='ch.qos.logback.core.rolling.TimeBasedRollingPolicy'> <fileNamePattern>${LOG_HOME}/${APPNAME}/bizLog/${APPNAME}-%d{yyyy-MM-dd}.%i.log</fileNamePattern> <!-- 除按日志記錄之外,還配置了日志文件不能超過50M,若超過50M,日志文件會以索引0開始, 命名日志文件,例如bizlog-biz-20181219.0.log --> <timeBasedFileNamingAndTriggeringPolicy class='ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP'><maxFileSize>50MB</maxFileSize><!--保存時間3天--><!--<MaxHistory>3</MaxHistory>--> </timeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <!-- 追加方式記錄日志 --> <append>true</append> <!-- 日志文件的格式 --> <encoder class='ch.qos.logback.classic.encoder.PatternLayoutEncoder'> <pattern>%d{yyyy/MM/dd’ ’HH:mm:ss.SSS} %X{req.requestId}[line:%L %msg] %n</pattern> <charset>utf-8</charset> </encoder> <!-- 此日志文件只記錄info級別的 --> <filter class='ch.qos.logback.classic.filter.LevelFilter'> <level>info</level> <level>error</level> <!--<onMatch>ACCEPT</onMatch>--> <!--<onMismatch>DENY</onMismatch>--> </filter> </appender> <!--ConsoleAppender是打印到控制臺的--> <appender name='STDOUT' class='ch.qos.logback.core.ConsoleAppender'> <!--encoder 默認配置為PatternLayoutEncoder--> <encoder> <pattern>${MDC_LOG_PATTERN}</pattern> <charset>utf-8</charset> </encoder> <!--此日志appender是為開發使用,只配置最底級別,控制臺輸出的日志級別是大于或等于此級別的日志信息--> <filter class='ch.qos.logback.classic.filter.ThresholdFilter'> <level>all</level> </filter> </appender> <!--使用LoggerFactory.getLogger('performanceLogger') 使用這個logger--> <logger name='performanceLogger' additivity='false'> <!--使用哪一個Appender--> <appender-ref ref='performanceAppender' /> </logger> <!--根loger。只有一個level屬性,應為已經被命名為'root'.--> <root level='info'> <appender-ref ref='bizAppender' /> <appender-ref ref='STDOUT' /> </root> </configuration>

<configuration>:根標簽,所有標簽都在里面。

<property>:屬性標簽,設置變量,name為變量名,value為值,可以使用${變量名}方式使用。

<appender>:當一個記錄日志的事件被發起時,logback 會將這個事件發送給 appender,經常使用的有ch.qos.logback.core.ConsoleAppender和ch.qos.logback.core.rolling.RollingFileAppender,ConsoleAppender是打印到控制臺的,RollingFileAppender是滾動記錄文件,先將日志記錄到指定文件,當符合某個條件時,將日志記錄到其他文件。

<file>:在<appender>中使用,記錄的日志文件的路徑及文件名。

<rollingPolicy>:分包策略,就是前一天日志的存儲文件名,大小,壓縮格式,存放天數。ch.qos.logback.core.rolling.TimeBasedRollingPolicy:實現的是基于時間的分包策略,分包間隔是根據<fileNamePattern>中指定的事件最小單位。

<fileNamePattern>:存放日志的路徑和名稱。

<maxFileSize>:每個文件最大文件。

<encoder>:日志文件的格式和編碼。

<charset>:日志編碼格式。

<pattern>:設置日志打印格式。

<filter>:日志過濾器。

<level>:日志過濾級別,TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF。

<logger>:使用LoggerFactory.getLogger('performanceLogger') 使用這個logger。

<root>:根loger。只有一個level屬性,應為已經被命名為'root'。

%d{yyyy/MM/dd’ ’HH:mm:ss.SSS}:是對時間格式化,2018/12/19 17:31:17.126

%X{ req.requestId}:在MDC類中添加req.requestId參數,即可在logback.xml中使用,后面講MDC類。

%p:打印出日志級別信息,如:INFO,ERROR等錯誤級別。

%t:是打印出線程或者哪個類打印出的日志。

%L:打印出當前行數。

%msg:就是日志信息啦。就是logger.info('xxx'),xxx就是%msg。

%n:換行。

MDC

是為了便于我們診斷線上問題而出現的方法工具類。

public class MDC { //Put a context value as identified by key //into the current thread’s context map. public static void put(String key, String val); //Get the context identified by the key parameter. public static String get(String key); //Remove the context identified by the key parameter. public static void remove(String key); //Clear all entries in the MDC. public static void clear();}

基本使用

MDC.put('req.requestId', uuid);MDC.put('req.remoteHost', request.getRemoteHost());<pattern>%d{yyyy/MM/dd’ ’HH:mm:ss.SSS} %X{req.requestId}[line:%L %msg] %n</pattern>

在logback.xml中可使用%X{req.requestId},得到uuid。

打印到不同文件

private final static Logger performanceLogger = LoggerFactory.getLogger('performanceLogger');

這樣就可以使用logback.xml里<logger>里的performanceLogger,performanceLogger引用的是performanceAppender。

private static final Logger logger = LoggerFactory.getLogger(Class.class);

這樣使用的就是logback.xml里的<root>標簽里的bizAppender。

這樣就基本實現了分不同業務邏輯打印到不同文件了。

補充:Springboot 使用logback將各級別日志分別輸出到不同路徑

SpringBoot默認已經依賴了部分日志框架(如Logback),且其中推薦使用的也是Logback,所以本次項目中我們將通過新增Logback日志的配置,將各級別日志分別輸出到不同路徑。

SpringBoot已經依賴了Logback,所以不需要手動添加依賴。

SpringBoot會自動識別和讀取resources目錄下新建logback-spring.xml,所以不需要在application.yml進行其他的配置了。

配置文件具體如下:

<?xml version='1.0' encoding='UTF-8'?><configuration> <!-- 項目名稱 --> <property name='PROJECT_NAME' value='XXXXX' /> <!-- 文件輸出格式 --> <property name='PATTERN' value='%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n'/> <!-- 輸出文件路徑 --> <property name='OPEN_FILE_PATH' value='logs/manager'/> <appender name='STDOUT' class='ch.qos.logback.core.ConsoleAppender'> <encoder> <pattern>${PATTERN}</pattern> <charset>UTF-8</charset> </encoder> </appender> <!-- ch.qos.logback.core.rolling.RollingFileAppender 文件日志輸出 --> <appender name='OPEN-FILE' class='ch.qos.logback.core.rolling.RollingFileAppender'> <!--不能有這項配置?。。。。?-> <!--<Encoding>UTF-8</Encoding>--> <!--<File>${OPEN_FILE_PATH}/zqread.log</File>--> <rollingPolicy class='ch.qos.logback.core.rolling.TimeBasedRollingPolicy'> <!--日志文件輸出的文件名--> <FileNamePattern>${OPEN_FILE_PATH}/all/zqread.%d{yyyy-MM-dd}-%i.log</FileNamePattern> <!--日志文件保留天數--> <MaxHistory>30</MaxHistory> <TimeBasedFileNamingAndTriggeringPolicy class='ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP'><!--日志文件最大的大小--><MaxFileSize>10MB</MaxFileSize> </TimeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <layout class='ch.qos.logback.classic.PatternLayout'> <pattern>${PATTERN}</pattern> </layout> </appender> <!--輸出到debug--> <appender name='debug' class='ch.qos.logback.core.rolling.RollingFileAppender'> <rollingPolicy class='ch.qos.logback.core.rolling.TimeBasedRollingPolicy'> <FileNamePattern>${OPEN_FILE_PATH}/debug/zqread.%d{yyyy-MM-dd}-%i.log</FileNamePattern> <MaxHistory>30</MaxHistory> <TimeBasedFileNamingAndTriggeringPolicy class='ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP'><MaxFileSize>10MB</MaxFileSize> </TimeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <append>true</append> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern> <charset>utf-8</charset> </encoder> <filter class='ch.qos.logback.classic.filter.LevelFilter'><!-- 只打印DEBUG日志 --> <level>DEBUG</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!--輸出到info--> <appender name='info' class='ch.qos.logback.core.rolling.RollingFileAppender'> <rollingPolicy class='ch.qos.logback.core.rolling.TimeBasedRollingPolicy'> <FileNamePattern>${OPEN_FILE_PATH}/info/zqread.%d{yyyy-MM-dd}-%i.log</FileNamePattern> <MaxHistory>30</MaxHistory> <TimeBasedFileNamingAndTriggeringPolicy class='ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP'><MaxFileSize>10MB</MaxFileSize> </TimeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <append>true</append> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern> <charset>utf-8</charset> </encoder> <filter class='ch.qos.logback.classic.filter.LevelFilter'><!-- 只打印INFO日志 --> <level>INFO</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!--輸出到error--> <appender name='error' class='ch.qos.logback.core.rolling.RollingFileAppender'> <rollingPolicy class='ch.qos.logback.core.rolling.TimeBasedRollingPolicy'> <FileNamePattern>${OPEN_FILE_PATH}/error/zqread.%d{yyyy-MM-dd}-%i.log</FileNamePattern> <MaxHistory>30</MaxHistory> <TimeBasedFileNamingAndTriggeringPolicy class='ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP'><MaxFileSize>10MB</MaxFileSize> </TimeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <append>true</append> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern> <charset>utf-8</charset> </encoder> <filter class='ch.qos.logback.classic.filter.LevelFilter'><!-- 只打印ERROR日志 --> <level>ERROR</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <!--輸出到warn--> <appender name='warn' class='ch.qos.logback.core.rolling.RollingFileAppender'> <rollingPolicy class='ch.qos.logback.core.rolling.TimeBasedRollingPolicy'> <FileNamePattern>${OPEN_FILE_PATH}/warn/zqread.%d{yyyy-MM-dd}-%i.log</FileNamePattern> <MaxHistory>30</MaxHistory> <TimeBasedFileNamingAndTriggeringPolicy class='ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP'><MaxFileSize>10MB</MaxFileSize> </TimeBasedFileNamingAndTriggeringPolicy> </rollingPolicy> <append>true</append> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern> <charset>utf-8</charset> </encoder> <filter class='ch.qos.logback.classic.filter.LevelFilter'><!-- 只打印WARN日志 --> <level>WARN</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> </appender> <root level='info'> <appender-ref ref='STDOUT'/> <appender-ref ref='OPEN-FILE'/> <appender-ref ref='debug' /> <appender-ref ref='info' /> <appender-ref ref='error' /> <appender-ref ref='warn' /> </root></configuration>

以上為個人經驗,希望能給大家一個參考,也希望大家多多支持好吧啦網。如有錯誤或未考慮完全的地方,望不吝賜教。

標簽: Spring
相關文章:
国产综合久久一区二区三区