當前位置：首頁 > 科技 > 軟件

日志打印的這10個坑，你至少踩過一個...

來源：責編：時間：2024-06-27 07:57:17 113觀看

導讀前言大家好,我是撿田螺的小男孩.我們日常開發中,經常需要打印日志.但是不當的日志使用可能會導致各種問題。整理了日志打印的10個坑,希望大家都能避坑~~1.忽視日志級別,反手就是INFO常見的日志級別有5種，分別是error、

前言

大家好,我是撿田螺的小男孩.

我們日常開發中,經常需要打印日志.但是不當的日志使用可能會導致各種問題。整理了日志打印的10個坑,希望大家都能避坑~~

1.忽視日志級別,反手就是INFO

常見的日志級別有5種，分別是error、warn、info、debug、trace。日常開發中，我們需要選擇恰當的日志級別，不要反手就是打印info哈~

ERROR：錯誤日志，指比較嚴重的錯誤，對正常業務有影響，需要運維配置監控的；
WARN：警告日志，一般的錯誤，對業務影響不大，但是需要開發關注；
INFO：信息日志，記錄排查問題的關鍵信息，如調用時間、出參入參等等；
DEBUG：用于開發DEBUG的，關鍵邏輯里面的運行時數據；
TRACE：最詳細的信息，一般這些信息只記錄到日志文件中

2.過度日志記錄

問題：記錄了過多的日志信息，導致日志文件過大，難以管理和分析。

比如這個例子(過度記錄DEBUG級別的日志):

// 過度記錄DEBUG級別的日志public void processData() {    logger.debug("Entering processData method.");    // 業務邏輯    logger.debug("Exiting processData method.");}

正例應該這樣(僅記錄必要的日志信息)

// 僅在異常和重要步驟中記錄日志public void processData() {    try {        logger.info("Start processing data.");        // 業務邏輯        logger.info("Finished processing data.");    } catch (Exception e) {        logger.error("Error occurred while processing data: ", e);    }}

我們應當根據日志的重要性設置不同的日志級別（如ERROR、WARN、INFO、DEBUG），只記錄必要的日志信息,避免日志打印處理成流水賬.

3.將debug日志直接帶到生產環境

有些伙伴亂用日志級別,甚至將DEBUG級別的日志用于生產環境。

反例(將DEBUG級別的日志直接用于生產環境):

logger.debug("This is a debug message,should not be logged in production");

正例 (debug日志級別,最好判斷一下是否開啟):

if(log.isDebugEnable()){  logger.debug("This is a debug message,should not be logged in production"); }

4.日志缺少上下文信息

大家可以看下這行日志,覺得有啥問題

logger.info("User login request");

很明顯,日志缺少上下文信息,并不方便排查.比如說,你想知道是哪個用戶的登錄請求嘛? 至少把userId 打印出來吧,如下:

logger.info("User login request,userId:{}",userId);

5.同步IO導致性能問題

同步日志記錄會阻塞主線程，影響系統性能。因此使用異步日志框架（比如Log4j 2的異步日志記錄器）來減少對性能的影響。

// 使用Log4j 2的異步日志<Configuration status="WARN">    <Appenders>        <Console name="Console" target="SYSTEM_OUT">            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>        </Console>        <Async name="AsyncConsole">            <AppenderRef ref="Console"/>        </Async>    </Appenders>    <Loggers>        <Root level="info">            <AppenderRef ref="AsyncConsole"/>        </Root>    </Loggers></Configuration>

6.日志配置不合理：

有些日志配置文件復雜，難以維護；配置文件中存在硬編碼路徑。如下:

// log4j.properties 示例log4j.rootLogger=INFO, filelog4j.appender.file=org.apache.log4j.RollingFileAppenderlog4j.appender.file.File=/var/log/tianluoboy.log

應當使用靈活的配置

// logback.xml 示例<configuration>    <property name="LOG_HOME" value="${LOG_HOME:-/var/log/myapp}"/>    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">        <file>${LOG_HOME}/tianluoboy.log</file>        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">            <fileNamePattern>${LOG_HOME}/tianluoboy.%d{yyyy-MM-dd}.log</fileNamePattern>            <maxHistory>30</maxHistory>        </rollingPolicy>        <encoder>            <pattern>%d{yyyy-MM-dd HH:mm:ss} - %msg%n</pattern>        </encoder>    </appender>    <root level="info">        <appender-ref ref="FILE"/>    </root></configuration>

7.日志內容泄露敏感信息

日志中記錄了用戶的敏感信息（如密碼、信用卡號），存在安全風險。

logger.info("User password: {}", password);

這都把用戶的密碼打印出來了...解決方法就是，不能打印密碼這些關鍵信息，如果是手機號、郵箱等敏感信息，則可以脫敏、或者掩碼處理。

8.日志文件輪轉和歸檔配置不當。

如果日志文件過大時未能及時輪轉,就很坑.

// 簡單的日志配置，沒有輪轉策略log4j.appender.file.File=tianluoboy.log

日志要配置合理的輪轉和歸檔策略,避免文件過大.

// logback.xml 示例<configuration>    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">        <file>tianluoboy.logg</file>        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">            <fileNamePattern>tianluoboy.%d{yyyy-MM-dd}.log</fileNamePattern>            <maxHistory>30</maxHistory>        </rollingPolicy>        <encoder>            <pattern>%d{yyyy-MM-dd HH:mm:ss} - %msg%n</pattern>        </encoder>    </appender>    <root level="info">        <appender-ref ref="FILE"/>    </root></configuration>

9.日志框架漏洞的問題

有些日志框架,在低版本,可能會存在安全漏洞問題.甚至有些可能會存在漏洞還沒被發現.

我們如何做呢? 如果是低版本存在安全漏洞的日志框架,我們要盡快升級到最新版本.

比如Log4Shell 是Log4j 2.x中一個嚴重的遠程代碼執行（RCE）漏洞。攻擊者可以通過特制的日志消息來觸發JNDI查找請求，從而在受影響的系統上執行任意代碼。

可以升級到Log4j 2.17.0或更高版本，這些版本已經修復了該漏洞。

尚未被發現的漏洞，也可能潛在地影響應用程序的安全性。我們要使用成熟的日志框架,并且要定時更新和維護.

10.錯誤配置LevelFilter造成日志重復記錄

錯誤配置LevelFilter可能導致日志重復記錄的問題.比如你這樣配置:

<Configuration status="WARN">    <Appenders>        <Console name="ConsoleAppender" target="SYSTEM_OUT">            <PatternLayout pattern="%d [%t] %-5level: %msg%n%throwable"/>            <Filters>                <LevelFilter level="INFO" notallow="ACCEPT" notallow="DENY"/>            </Filters>        </Console>        <File name="FileAppender" fileName="app.log">            <PatternLayout pattern="%d [%t] %-5level: %msg%n%throwable"/>            <Filters>                <LevelFilter level="INFO" notallow="ACCEPT" notallow="DENY"/>            </Filters>        </File>    </Appenders>    <Loggers>        <Root level="INFO">            <AppenderRef ref="ConsoleAppender"/>            <AppenderRef ref="FileAppender"/>        </Root>    </Loggers></Configuration>

在上述配置中，由于兩個appender的LevelFilter條件相同，導致每條INFO級別的日志都會同時被兩個appender記錄，產生了重復日志。

可以使用不同的過濾器策略來確保日志只被一個appender記錄：

<Configuration status="WARN">    <Appenders>        <Console name="ConsoleAppender" target="SYSTEM_OUT">            <PatternLayout pattern="%d [%t] %-5level: %msg%n%throwable"/>            <Filters>                <LevelFilter level="INFO" notallow="ACCEPT" notallow="DENY"/>            </Filters>        </Console>        <File name="FileAppender" fileName="app.log">            <PatternLayout pattern="%d [%t] %-5level: %msg%n%throwable"/>            <Filters>                <LevelFilter level="DEBUG" notallow="ACCEPT" notallow="DENY"/>                <LevelFilter level="INFO" notallow="DENY" notallow="DENY"/>            </Filters>        </File>    </Appenders>    <Loggers>        <Root level="DEBUG">            <AppenderRef ref="ConsoleAppender"/>            <AppenderRef ref="FileAppender"/>        </Root>    </Loggers></Configuration>

在這個配置中，ConsoleAppender只記錄INFO級別及以上的日志，而FileAppender記錄DEBUG級別但排除INFO級別的日志。這樣可以避免INFO級別的日志被兩個appender同時記錄。

本文鏈接：http://www.tebozhan.com/showinfo-26-96759-0.html日志打印的這10個坑，你至少踩過一個...

聲明：本網頁內容旨在傳播知識，若有侵權等問題請及時與本網聯系，我們將在第一時間刪除處理。郵件：2376512515@qq.com

上一篇：避免消息積壓的終極指南：四個關鍵技巧

下一篇：一文搞懂大廠商品中心設計！

標簽：

熱門焦點

7月安卓手機性價比榜：努比亞+紅魔兩款新機入榜

7月登場的新機有努比亞Z50S Pro和紅魔8S Pro，除了三星之外目前唯二的兩款搭載超頻版驍龍8Gen2處理器的產品，而且努比亞和紅魔也一貫有著不錯的性價比，所以在本次的性價比榜單
5月iOS設備性能榜：M1 M2依舊是榜單前五

和上個月一樣，沒有新品發布的iOS設備性能榜的上榜設備并沒有什么更替，僅僅只有跑分變化而產生的排名變動，剛剛開始的蘋果WWDC2023，推出的產品也依舊是新款Mac Pro、新款Mac Stu
Golang 中的 io 包詳解：組合接口

io.ReadWriter// ReadWriter is the interface that groups the basic Read and Write methods.type ReadWriter interface { Reader Writer}是對Reader和Writer接口的組合，
三言兩語說透設計模式的藝術-單例模式

寫在前面單例模式是一種常用的軟件設計模式，它所創建的對象只有一個實例，且該實例易于被外界訪問。單例對象由于只有一個實例，所以它可以方便地被系統中的其他對象共享，從而減少
如何正確使用:Has和:Nth-Last-Child

我們可以用CSS檢查，以了解一組元素的數量是否小于或等于一個數字。例如，一個擁有三個或更多子項的grid。你可能會想，為什么需要這樣做呢？在某些情況下，一個組件或一個布局可能會
WebRTC.Net庫開發進階，教你實現屏幕共享和多路復用！

WebRTC.Net庫：讓你的應用更親民友好，實現視頻通話無痛接入！除了基本用法外，還有一些進階用法可以更好地利用該庫。自定義 STUN/TURN 服務器配置WebRTC.Net 默認使用 Google 的
零售大模型“干中學”，攀爬數字化珠峰

文/侯煜編輯/cc來源/華爾街科技眼對于絕大多數登山愛好者而言，攀爬珠穆朗瑪峰可謂終極目標。攀登珠峰的商業路線有兩條，一是尼泊爾境內的南坡路線，一是中國境內的北坡路線。相
四年持續更迭堅持探索行業無人之境，HarmonyOS 4帶來五大升級多項創新

除了華為每年新發布的旗艦手機系列，上億花粉更加期待鴻蒙系統每次的跨版本大更新。8月4日，HarmonyOS 4于HDC 2023正式發布，這也是該系統歷經四年的再
Windows 11發布，微軟一改往常對老機型開放的態度

距離 Windows 11 發布已經過去一周，在過去一周里，很多數碼愛好者圍繞其對 Android 應用的支持、對老機型的升級問題展開了激烈討論。與以往不同的是，在這次大

AVt天堂网手机版,亚洲va久久久噜噜噜久久4399,天天综合亚洲色在线精品,亚洲一级Av无码毛片久久精品

日志打印的這10個坑，你至少踩過一個...

前言

1.忽視日志級別,反手就是INFO

2.過度日志記錄

3.將debug日志直接帶到生產環境

4.日志缺少上下文信息

5.同步IO導致性能問題

6.日志配置不合理：

7.日志內容泄露敏感信息

8.日志文件輪轉和歸檔配置不當。

9.日志框架漏洞的問題

10.錯誤配置LevelFilter造成日志重復記錄

7月安卓手機性價比榜：努比亞+紅魔兩款新機入榜

5月iOS設備性能榜：M1 M2依舊是榜單前五

Golang 中的 io 包詳解：組合接口

三言兩語說透設計模式的藝術-單例模式

如何正確使用:Has和:Nth-Last-Child

WebRTC.Net庫開發進階，教你實現屏幕共享和多路復用！

零售大模型“干中學”，攀爬數字化珠峰

四年持續更迭堅持探索行業無人之境，HarmonyOS 4帶來五大升級多項創新

Windows 11發布，微軟一改往常對老機型開放的態度

最新推薦

猜你喜歡

熱門推薦

相關資訊

日志打印的這10個坑，你至少踩過一個...

前言

1.忽視日志級別,反手就是INFO

2.過度日志記錄

3.將debug日志直接帶到生產環境

4.日志缺少上下文信息

5.同步IO導致性能問題

6.日志配置不合理：

7.日志內容泄露敏感信息

8.日志文件輪轉和歸檔配置不當。

9.日志框架漏洞的問題

10.錯誤配置LevelFilter造成日志重復記錄

最新推薦

猜你喜歡

熱門推薦

相關資訊

日志打印的這10個坑，你至少踩過一個...

8.日志文件輪轉和歸檔配置不當。