Java日志

Java日志的使用笔记。

现在流行的日志库通常包含Log Facade和Log Implementation两部分,可以理解为上层抽象和底层实现。

具体的组合用法为:

  • SLF4J(Simple Logging Facade for Java) + Logback
  • Log4j2 (2.x版本) : log4j-api + log4j-core

背景介绍:SLF4J,Logback是log4j 1.x版本的重新实现,作者为同一人。

日志简介

记录日志的三个原因:

  • 记录操作轨迹
  • 监控系统运行状况
  • 回溯系统故障

日志级别从低到高: TRACE、DEBUG、INFO、WARN、ERROR、FATAL

Appender 主要职责:

  • 接受日志事件
  • 使用Layout格式化日志
  • 转发到指定目标输出

SLF4J

SLF4J 是Java日志框架的抽象接口和门面实现。

最常见的日志使用方式:

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Log4jExample {

    // 定义为static,与当前类绑定,避免每次都new一个新对象
    private static final Logger logger = LoggerFactory.getLogger(Log4jExample.class);

    public static void main(String[] args) {
        logger.debug("Debug log message");
        logger.info("Info log message");
        logger.error("Error log message");
    }
}

添加依赖

		<dependency>
			<groupId>org.slf4j</groupId>
			<artifactId>slf4j-api</artifactId>
			<version>1.7.28</version>
		</dependency>

Log4J 2

添加库依赖log4j-api和log4j-core:

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-api</artifactId>
    <version>2.12.1</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.12.1</version>
</dependency>
<!-- 异步日志依赖 -->
<dependency>
    <groupId>com.lmax</groupId>
    <artifactId>disruptor</artifactId>
    <version>3.4.2</version>
</dependency>

配置文件log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="INFO">
    <Appenders>
        # Console appender
        <Console name="stdout" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %p %m%n"/>
        </Console>

        # File appender
        <File name="fout" fileName="logs/log4j2.log"
            immediateFlush="false" append="false">
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss} %p %m%n"/>
        </File>
    </Appenders>

    <Loggers>
        # Override log level for specified package
        <Logger name="com.xulizhao.logging" level="TRACE"/>
        <AsyncRoot level="DEBUG">
            <AppenderRef ref="stdout"/>
            <AppenderRef ref="fout"/>
        </AsyncRoot>
    </Loggers>
</Configuration>

Logback

  1. 依赖
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
</dependency>
<!-- 会自动下载依赖的logback-core 和 slf4j-api-->
  1. 配置文件logback.xml
<configuration>
    # Console appender
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <Pattern>%d{yyyy-MM-dd HH:mm:ss} %p %m%n</Pattern>
        </layout>
    </appender>

    # File appender
    <appender name="fout" class="ch.qos.logback.core.FileAppender">
        <file>logs/logback.log</file>
        <append>false</append>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %p %m%n</pattern>
        </encoder>
    </appender>

    <appender name="roll-by-time-and-size"
        class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>logs/roll-by-time-and-size/app.log</file>
        <rollingPolicy
            class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>logs/roll-by-time-and-size/app.%d{yyyy-MM-dd-mm}.%i.log.zip
            </fileNamePattern>
            <maxFileSize>5KB</maxFileSize>
            <maxHistory>20</maxHistory>
            <totalSizeCap>1MB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %p %m%n</pattern>
        </encoder>
    </appender>
    # Override log level for specified package
    <logger name="com.xulizhao.logging" level="TRACE">
        <appender-ref ref="roll-by-time-and-size"/>
    </logger>

    <root level="INFO">
        <appender-ref ref="stdout"/>
        <appender-ref ref="fout"/>
    </root>

使用规范

  • 日志文件命名:appName_logType_logName.log。类型可以有stats,monitor,visit等,logName为日志描述
  • 对DEBUG,INFO级别日志必须使用条件输出或使用占位符方式{}打印。
  • 使用 additivity=“false” 避免打印重复日志(appender累积)
  • ERROR级别只记录系统逻辑错误,异常或违反重要业务规则,其他错误对归为WARN
  • 记录日志一定要输出异常堆栈信息,例如logger.error(“xxx”+e.getMesssage(),e)

日志性能优化

  • 关闭不必要的日志

logging.level.org.apache.zookeeper=OFF

<configuration>
  <include resource="org/springframework/boot/logging/logback/basic.xml"/>
  <logger name="org.apache.zookeeper" level="WARN"/></configuration>
  • 设置高过滤级别
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>ERROR</level>
</filter>
  • 异步处理日志事件

NDC (Nested Diagnostic Context)和MDC (Mapped Diagnostic Context)是基于线程级的,两者的区别是MDC使用map而NDC使用stack。

其他日志和冲突解决

这块历史包袱太重了,经常遇到冲突问题或slf4j多个绑定的问题。

先解释几个名词:

  • jcl : 代表commons-logging
  • jul : 代表JDK自带的jdk-logging

解决冲突

如果遇到SLF4J: Class path contains multiple SLF4J bindings 或Could not initialize class org.apache.logging.log4j.util.PropertiesUtil 错误,需要删除其一

  • jcl-over-slf4j和slf4j-jcl互相委托,删除其一
  • log4j-over-slf4j和slf4j-log4j12互相委托,删除其一
  • jul-to-slf4j和slf4j-jdk14互相委托,删除其一

资源