Java

Java 教程 | 日志收集工具之Log4j

Posted by Aiden on November 22, 2018

1. log4j 使用介绍:

Log4j有三个主要的组件：Logger(输出源) ，Appender (输出方式 ) 和 Layout(布局) 。 这里可简单理解为日志类别，日志要输出的地方和日志以何种形式输出。 综合使用这三个组件可以轻松地记录信息的类型和级别，并可以在运行时控制日志输出的样式和位置。

1.1 Logger (负责控制输出源) :

Loggers组件在此系统中被分为五个级别：DEBUG 、INFO 、WARN , ERROR 和 FATAL 。 这五个级别是有顺序的，DEBUG < INFO < WARN < ERROR < FATAL ， 分别用来指定这条日志信息的重要程度，明白这一点很重要.

Log4j有一个规则：只输出级别不低于设定级别的日志信息 ，假设Loggers级别设定为INFO，则INFO、WARN、ERROR 和FATAL级别的日志信息都会输出，而级别比INFO低的DEBUG则不会输出。

不仅日志本身具有层次级别关系, 日志来源也同样具有日志关系. 日志来源层次类似于树状结构, 最下层的是根路径.然后逐层递增. com.test 可以理解成 /com/test . 上层定义的输出方式将继承下层定义的输出方式(但不继承日志级别).

1.2 Appender (负责控制输出方式):

禁用和使用日志请求只是Log4j的基本功能，Log4j日志系统还提供许多强大的功能，比如允许把日志输出到不同的地方， 如控制台（Console）、文件（Files）等，可以根据天数或者文件大小产生新的文件，可以以流的形式发送到其它地方等等。

常用的输出方式(类):

org.apache.log4j.ConsoleAppender           # 控制台

    Threshold=WARN       ：指定日志信息的最低输出级别，默认为DEBUG。
    ImmediateFlush=true  ：表示所有消息都会被立即输出，设为false则不输出，默认值是true。
    Target=System.err    ：默认值是System.out。

org.apache.log4j.FileAppender              # 文件

    Threshold=WARN         ：指定日志信息的最低输出级别，默认为DEBUG。
    ImmediateFlush=true    ：表示所有消息都会被立即输出，设为false则不输出，默认值是true。
    Append=false           ：true表示消息追加到指定文件中，false则将消息覆盖指定的文件内容，默认值是true。
    File=log/logging.log4j ：指定消息输出到logging.log4j文件中。


org.apache.log4j.DailyRollingFileAppender  # 每天产生一个日志文件

    Threshold=WARN             ：指定日志信息的最低输出级别，默认为DEBUG。
    ImmediateFlush=true        ：表示所有消息都会被立即输出，设为false则不输出，默认值是true。
    Append=false               ：true表示消息增加到指定文件中，false则将消息覆盖指定的文件内容，默认值是true。
    File=log/logging.log4j     ：指定当前消息输出到logging.log4j文件中。
    DatePattern='.'yyyy-MM     ：每月滚动一次日志文件，即每月产生一个新的日志文件。当前月的日志文件名为logging.log4j，前一个月的日志文件
        1) '.'yyyy-MM：每月
　　　　 2) '.'yyyy-ww：每周
　　　　 3) '.'yyyy-MM-dd：每天
　　　　 4) '.'yyyy-MM-dd-a：每天两次
　　　　 5) '.'yyyy-MM-dd-HH：每小时
　　　　 6) '.'yyyy-MM-dd-HH-mm：每分钟

org.apache.log4j.RollingFileAppender       # 文件大小到达指定尺寸的时候产生一个新的文件

Threshold=WARN             ：指定日志信息的最低输出级别，默认为DEBUG。
　ImmediateFlush=true        ：表示所有消息都会被立即输出，设为false则不输出，默认值是true。
　Append=false               ：true表示消息增加到指定文件中，false则将消息覆盖指定的文件内容，默认值是true。
　File=D:/logs/logging.log4j ：指定消息输出到logging.log4j文件中。
　MaxFileSize=100KB          ：后缀可以是KB, MB 或者GB。在日志文件到达该大小时，将会自动滚动，即将原来的内容移到logging.log4j.1文件中。
　MaxBackupIndex=2           ：指定可以产生的滚动文件的最大数，例如，设为2则可以产生logging.log4j.1，logging.log4j.2两个滚动文件和一个logging.log4j文件。

1.3 Layout (负责控制输出内容的样式) :

有时用户希望根据自己的喜好格式化自己的日志输出，Log4j可以在Appenders的后面附加Layouts来完成这个功能。 Layouts提供四种日志输出样式，如根据HTML样式、自由指定样式、包含日志级别与信息的样式和 包含日志时间、线程、类别等信息的样式。

log4j.appender.appenderName.layout=className
ConversionPattern=%m%n：设定以怎样的格式显示消息。

常用的样式选择 (类) :

org.apache.log4j.HTMLLayout      # 以HTML表格形式布局
org.apache.log4j.PatternLayout   # 可以灵活地指定布局模式
org.apache.log4j.SimpleLayout    # 包含日志信息的级别和信息字符串
org.apache.log4j.TTCCLayout      # 包含日志产生的时间、线程、类别等信息

ConversionPattern 格式化符号说明 :

%p  ：输出日志信息的优先级，即DEBUG，INFO，WARN，ERROR，FATAL。
%d  ：输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，如：%d{yyyy/MM/dd HH:mm:ss,SSS}。
%r  ：输出自应用程序启动到输出该log信息耗费的毫秒数。
%t  ：输出产生该日志事件的线程名。
%l  ：输出日志事件的发生位置，相当于%c.%M(%F:%L)的组合，包括类全名、方法、文件名以及在代码中的行数。例如：test.TestLog4j.main(TestLog4j.java:10)。
%c  ：输出日志信息所属的类目，通常就是所在类的全名。
%M  ：输出产生日志信息的方法名。
%F  ：输出日志消息产生时所在的文件名称。
%L  ：输出代码中的行号。
%m  ：输出代码中指定的具体日志信息。
%n  ：输出一个回车换行符，Windows平台为"rn"，Unix平台为"n"。
%x  ：输出和当前线程相关联的NDC(嵌套诊断环境)，尤其用到像java servlets这样的多客户多线程的应用中。
%%  ：输出一个"%"字符。

另外，还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如：
1)  c     ：指定输出category的名称，最小的长度是20，如果category的名称长度小于20的话，默认的情况下右对齐。
2)  %-20c ："-"号表示左对齐。
3)  %.30c ：指定输出category的名称，最大的长度是30，如果category的名称长度大于30的话，就会将左边多出的字符截掉，但小于30的话也不会补空格。

2. log4j.properties

# Logger

#  设置日志的输出级别跟输出地方
log4j.rootLogger=DEBUG,dailyFile
log4j.logger.azkaban.webapp=INFO, console
log4j.additivity.org.apache=true

# 输出到控制台
# Appender
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.ImmediateFlush=true
log4j.appender.console.Target=System.out
# Layout
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%p] %d{yyyy-MM-dd HH:mm:ss} - [%c] : %m %n


# 输出到文件
# Appender
log4j.appender.logFile=org.apache.log4j.FileAppender
log4j.appender.logFile.Threshold=DEBUG
log4j.appender.logFile.ImmediateFlush=true
log4j.appender.logFile.Append=true
log4j.appender.logFile.File=log/log4j-study.log
# Layout
log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%p] %d{yyyy-MM-dd HH:mm:ss} - [%c] : %m %n

# 输出文件分钟分割
# Appender
log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.dailyFile.Threshold=DEBUG
log4j.appender.dailyFile.ImmediateFlush=true
log4j.appender.dailyFile.Append=true
log4j.appender.dailyFile.File=log/log4j-study
log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd-HH-mm
# Layout
log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout
log4j.appender.dailyFile.layout.ConversionPattern=[%p] %d{yyyy-MM-dd HH:mm:ss} - [%c] : %m %n

# 输出文件按大小回滚
# Appender
log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
log4j.appender.rollingFile.Threshold=DEBUG
log4j.appender.rollingFile.ImmediateFlush=true
log4j.appender.rollingFile.Append=true
log4j.appender.rollingFile.File=log/log4j-study.log
log4j.appender.rollingFile.MaxFileSize=10KB
log4j.appender.rollingFile.MaxBackupIndex=5
# Layout
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
log4j.appender.rollingFile.layout.ConversionPattern=[%p] %d{yyyy-MM-dd HH:mm:ss} - [%c] : %m %n

3. log4j.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/' >

    <!-- 控制台输出的方式 -->
    <appender name="myConsole" class="org.apache.log4j.ConsoleAppender">
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="[%d{dd HH:mm:ss,SSS\\} %-5p] [%t] %c{2\\} - %m%n" />
        </layout>
        <!--过滤器设置输出的级别-->
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <param name="levelMin" value="debug" />
            <param name="levelMax" value="warn" />
            <param name="AcceptOnMatch" value="true" />
        </filter>
    </appender>


    <appender name="myFile" class="org.apache.log4j.RollingFileAppender">
        <param name="File" value="log/output.log" /><!-- 设置日志输出文件名 -->
        <!-- 设置是否在重新启动服务时，在原有日志的基础添加新日志 -->
        <param name="Append" value="true" />
        <param name="MaxBackupIndex" value="10" />
        <param name="MaxFileSize" value="1kg">
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%p (%c:%L)- %m%n" />
        </layout>
    </appender>


    <appender name="activexAppender" class="org.apache.log4j.DailyRollingFileAppender">
        <param name="File" value="log/activex.log" />
        <param name="DatePattern" value="'.'yyyy-MM-dd'.log'" />
        <layout class="org.apache.log4j.PatternLayout">
        <param name="ConversionPattern" value="[%d{MMdd HH:mm:ss SSS\\} %-5p] [%t] %c{3\\} - %m%n" />
        </layout>
    </appender>


    <!-- 指定logger的设置，additivity指示是否遵循缺省的继承机制-->
    <logger name="com.runway.bssp.activeXdemo" additivity="false">
        <priority value ="info"/>
        <appender-ref ref="activexAppender" />
    </logger>

    <!-- 根logger的设置-->
    <root>
        <priority value ="debug"/>
        <appender-ref ref="myConsole"/>
        <appender-ref ref="myFile"/>
    </root>
</log4j:configuration>
CATALOG
    ABOUT ME

    天行健,君子以自强不息!

    FEATURED TAGS
    算法 Java 设计模式 Spring web Linux 系统工具 cpp 网络 消息队列 spark kubernetes 机器学习 olap datalake