当前位置：首页 > 科技 > 软件

日志打印的这10个坑，你至少踩过一个...

来源：责编：时间：2024-06-27 07:57:17 281观看

导读前言大家好,我是捡田螺的小男孩.我们日常开发中,经常需要打印日志.但是不当的日志使用可能会导致各种问题。整理了日志打印的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.28at.com/showinfo-26-96759-0.html日志打印的这10个坑，你至少踩过一个...

声明：本网页内容旨在传播知识，若有侵权等问题请及时与本网联系，我们将在第一时间删除处理。邮件：2376512515@qq.com

上一篇：避免消息积压的终极指南：四个关键技巧

下一篇：一文搞懂大厂商品中心设计！

标签：

热门焦点

5月iOS设备性能榜：M1 M2依旧是榜单前五

和上个月一样，没有新品发布的iOS设备性能榜的上榜设备并没有什么更替，仅仅只有跑分变化而产生的排名变动，刚刚开始的苹果WWDC2023，推出的产品也依旧是新款Mac Pro、新款Mac Stu
Raft算法：保障分布式系统共识的稳健之道

1. 什么是Raft算法？Raft 是英文”Reliable、Replicated、Redundant、And Fault-Tolerant”（“可靠、可复制、可冗余、可容错”）的首字母缩写。Raft算法是一种用于在分布式系统
线程通讯的三种方法！通俗易懂

线程通信是指多个线程之间通过某种机制进行协调和交互，例如，线程等待和通知机制就是线程通讯的主要手段之一。在 Java 中，线程等待和通知的实现手段有以下几种方式：Object 类下
服务存储设计模式：Cache-Aside模式

Cache-Aside模式一种常用的缓存方式，通常是把数据从主存储加载到KV缓存中，加速后续的访问。在存在重复度的场景，Cache-Aside可以提升服务性能，降低底层存储的压力，缺点是缓存和底
一篇聊聊Go错误封装机制

%w 是用于错误包装（Error Wrapping）的格式化动词。它是用于 fmt.Errorf 和 fmt.Sprintf 函数中的一个特殊格式化动词，用于将一个错误（或其他可打印的值）包装在一个新的错误中。使
之家push系统迭代之路

前言在这个信息爆炸的互联网时代，能够及时准确获取信息是当今社会要解决的关键问题之一。随着之家用户体量和内容规模的不断增大，传统的靠"主动拉"获取信息的方式已不能满足用
东方甄选单飞：有些鸟注定是关不住的

作者：彭宽鸿来源：华尔街科技眼&zwj;&zwj;&zwj;&zwj;&zwj;&zwj;&zwj;&zwj;&zwj;&zwj;东方甄选创始人俞敏洪带队的“7天甘肃行”直播活动已在近日顺利收官。成立后一
Windows 11发布，微软一改往常对老机型开放的态度

距离 Windows 11 发布已经过去一周，在过去一周里，很多数码爱好者围绕其对 Android 应用的支持、对老机型的升级问题展开了激烈讨论。与以往不同的是，在这次大
电博会与软博会实现"线下+云端"的双线融合

在本次“电博会”与“软博会”双展会利好条件的加持下，既可以发挥展会拉动人流、信息流、资金流实现快速交互流动的作用，继而推动区域经济良性发展；又可以聚

日志打印的这10个坑，你至少踩过一个...

前言

1.忽视日志级别,反手就是INFO

2.过度日志记录

3.将debug日志直接带到生产环境

4.日志缺少上下文信息

5.同步IO导致性能问题

6.日志配置不合理：

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

8.日志文件轮转和归档配置不当。

9.日志框架漏洞的问题

10.错误配置LevelFilter造成日志重复记录

5月iOS设备性能榜：M1 M2依旧是榜单前五

Raft算法：保障分布式系统共识的稳健之道

线程通讯的三种方法！通俗易懂

服务存储设计模式：Cache-Aside模式

一篇聊聊Go错误封装机制

之家push系统迭代之路

东方甄选单飞：有些鸟注定是关不住的

Windows 11发布，微软一改往常对老机型开放的态度

电博会与软博会实现"线下+云端"的双线融合

最新推荐

猜你喜欢

热门推荐

相关资讯