Log4j 配置详解

1. Log4j 简介

Log4j 有三个主要的组件:
Loggers(记录器):日志类别和级别
Appenders(输出源):日志要输出的地方
Layouts(布局):日志以何种形式输出

1.1 Loggers

Loggers 组件在此系统中被分为五个级别:(输出信息的重要程度依次递增)

  • DEBUG
  • INFO
  • WARN
  • ERROR
  • FATAL

1.2 Appenders

Log4j 日志系统允许把日志输出到不同的地方,如控制台(Console), 文件(Files)等,可以根据天数或者文件大小产生新的文件,可以以流的形式发送到其它地方等等。
常用的类如下:
org.apache.log4j.ConsoleAppender --> 控制台
org.apache.log4j.FileAppender --> 文件
org.apache.log4j.DailyRollingFileAppender --> 每天产生一个日志文件
org.apache.log4j.RollingFileAppender --> 文件大小到达指定尺寸的时候产生一个新的文件
org.apache.log4j.WriteAppender --> 将日志信息以流格式发送到任意指定的地方

1.3 Layouts

Log4j 可以在 Appenders 的后面附加 Layouts 来完成这个功能。
Layouts 提供 4 种日志输出样式,如根据 HTML 样式、自由指定样式、包含日志级别与信息的样式、包含日志时间、线程、类别等信息的样式。

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

2. 配置详解

配置文件实际上就是对 Logger, Appender 以及 Layout 进行相应的设定。
Log4j 支持两种配置文件格式:

  • XML
  • 格式 properties 文件

2.1 配置 Logger:

log4j.rootLogger=[Level], appenderName1, appenderName2, ...
log4j.additivity.org.apache=false  # 表示 Logger 不会在父 Logger 的 Appender 里输出,默认为 true;
  1. Level: 设定日志记录的最低级别,可设的值有 OFF, FATAL, ERROR, WARN, INFO, DEBUG, ALL 或者自定义的级别,Log4j 建议只使用中间的四个级别。
  2. appenderName: 即指定日志信息要输出到哪里,可以同时指定多个输出目的地,用逗号隔开。例如:log4j.rootLogger=INFO,A,B,C

2.2 配置 Appender(日志信息输出目的地)

log4j.appender.appenderName=className

appenderName: 自定义的 appenderName, 在 log4j.rootLogger 设置中使用。
className 可设置如下值:
org.apache.log4j.ConsoleAppender --> 控制台
org.apache.log4j.FileAppender --> 文件
org.apache.log4j.DailyRollingFileAppender --> 每天产生一个日志文件
org.apache.log4j.RollingFileAppender --> 文件大小达到指定尺寸的时候产生一个新的文件
org.apache.log4j.WriterAppender --> 将日志信息以流格式发送到任意指定的地方

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

  2. FileAppender 选项
    Threshold=WARN --> 指定日志信息的最低输出级别,默认为 DEBUG
    ImmediateFlush=true --> 表示所有消息都会被立即输出,设为 false 则不输出,默认值是 true
    Append=false --> true 表示消息增加到指定文件中,false 则将消息覆盖指定的文件内容,默认值是 true
    File=D:/logs/logging.log4j --> 指定消息输出到 D:/logs/logging.log4j 文件中

  3. DailyRollingFileAppender 选项
    Threshold=WARN --> 指定日志消息的最低输出级别,默认为 DEBUG
    ImmediateFlush=true --> 表示所有消息都会被立即输出,设为 false 则不输出,默认值为 true
    Append=false --> true 表示消息增加到指定文件中,false 则将消息覆盖指定的文件内容,默认值为 true
    File=D:/logs/logging.log4j --> 指定当前消息输出到 D:/logs/logging.log4j 文件中
    DatePattern='.'yyyy-MM --> 每月滚动一次日志文件,即每月产生一个新的日志文件。当前月的日志文件名为 logging.log4j, 前一个月的日志文件名为 logging.log4j.yyyy-MM.
    此外,也可以指定按周、天、时、分等来滚动日志文件,对应的格式如下:
    (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 --> 每分钟

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

2.3 配置 Layout (日志信息的输出格式)

log4j.appender.appenderName.layout=className
className 可设置如下值:

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

  1. HTMLLayout 选项
    LocationInfo=true --> 输出 Java 文件名称和行号,默认值是 false
    Title=My Logging --> 默认值是 Log4j Log Messages

  2. PatternLayout 选项
    ConversionPattern=%m%n --> 设定以怎样的格式显示消息
    格式化符号说明:
    %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 平台为 “\r\n”,Unix 平台为 “\n”
    %x --> 输出和当前线程相关联的 NDC(嵌套诊断环境),尤其用到像 java servlets 这样的多客户多线程的应用中
    %% --> 输出一个 “%” 字符

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

附:Log4j 比较全面的配置

Log4j配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能

log4j.rootLogger=DEBUG,console,dailyFile,im
log4j.additivity.org.apache=true
# 控制台(console)
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.ImmediateFlush=true
log4j.appender.console.Target=System.err
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 日志文件(logFile)
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=D:/logs/log.log4j
log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
log4j.appender.logFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 回滚文件(rollingFile)
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=D:/logs/log.log4j
log4j.appender.rollingFile.MaxFileSize=200KB
log4j.appender.rollingFile.MaxBackupIndex=50
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
log4j.appender.rollingFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 定期回滚日志文件(dailyFile)
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=D:/logs/log.log4j
log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd
log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout
log4j.appender.dailyFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 应用于socket
log4j.appender.socket=org.apache.log4j.RollingFileAppender
log4j.appender.socket.RemoteHost=localhost
log4j.appender.socket.Port=5001
log4j.appender.socket.LocationInfo=true
# Set up for Log Factor 5
log4j.appender.socket.layout=org.apache.log4j.PatternLayout
log4j.appender.socket.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# Log Factor 5 Appender
log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender
log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000
# 发送日志到指定邮件
log4j.appender.mail=org.apache.log4j.net.SMTPAppender
log4j.appender.mail.Threshold=FATAL
log4j.appender.mail.BufferSize=10
log4j.appender.mail.From = xxx@mail.com
log4j.appender.mail.SMTPHost=mail.com
log4j.appender.mail.Subject=Log4J Message
log4j.appender.mail.To= xxx@mail.com
log4j.appender.mail.layout=org.apache.log4j.PatternLayout
log4j.appender.mail.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 应用于数据库
log4j.appender.database=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.database.URL=jdbc:mysql://localhost:3306/test
log4j.appender.database.driver=com.mysql.jdbc.Driver
log4j.appender.database.user=root
log4j.appender.database.password=
log4j.appender.database.sql=INSERT INTO LOG4J (Message) VALUES('=[%-5p] %d(%r) --> [%t] %l: %m %x %n')
log4j.appender.database.layout=org.apache.log4j.PatternLayout
log4j.appender.database.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 自定义Appender
log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender
log4j.appender.im.host = mail.cybercorlin.net
log4j.appender.im.username = username
log4j.appender.im.password = password
log4j.appender.im.recipient = corlin@cybercorlin.net
log4j.appender.im.layout=org.apache.log4j.PatternLayout
log4j.appender.im.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

文章出处: https://www.jianshu.com/p/ccafda45bcea 内容有改动

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值