Log4j日志配置详解

一、Log4j简介

Log4j有三个主要的组件:

  • Loggers(写出器):日志写出器 ,供程序员输出日志信息。简单理解:配置日志写出的LevelAppenders
  • Appenders (输出源):日志目的地 ,把格式化好的日志信息输出到指定的地方去
  • Layouts(布局):日志格式化器 ,用来把程序员的 logging request 格式化成字符串

综合使用这三个组件能轻松地记录信息的类型和级别,并可以在运行时控制日志输出的样式和位置。

1、Loggers

  1. 说明:
    • Loggers组件在此系统中被分为五个级别:DEBUGINFOWARNERRORFATAL
    • 这五个级别是有顺序的,DEBUG < INFO < WARN < ERROR < FATAL,分别用来指定这条日志信息的重要程度,明白这一点很重要
    • Log4j有一个规则:只输出级别不低于设定级别的日志信息
      • 假设Loggers级别设定为INFO
      • INFOWARNERRORFATAL级别的日志信息都会输出
      • 而级别比INFO低的DEBUG不会输出
  2. 常用配置方法如下
    • 配置根 Logger
      • 语法为: log4j.rootLogger = [ level ] , appenderName, …
      • rootLogger:根Logger (日志写出器),可以理解为默认日志写出器
      • [level]:根Logger的写出日志的级别
      • appenderName:Appenders组件名
    • 配置包 Logger
      • 语法:log4j.logger.packageName= [ level ] , appenderName, …
      • logger.packageName:包下所有类都采用当前Logger(日志写出器)进行写出
    • 配置类 Logger
      • 语法:log4j.logger.全限定类名= [ level ] , appenderName, …
      • logger.全限定类名:指定类所使用的Logger

2、Appenders

  • 把日志输出到不同的地方,如控制台(Console)、文件(Files)等,可以根据天数或者文件大小产生新的文件,可以以流的形式发送到其它地方等等。

  • 常使用的类如下:

org.apache.log4j.ConsoleAppender // 控制台
org.apache.log4j.FileAppender // 文件
org.apache.log4j.DailyRollingFileAppender // 每天产生一个日志文件
org.apache.log4j.RollingFileAppender // 文件大小到达指定尺寸的时候产生一个新的文件
org.apache.log4j.WriterAppender // 将日志信息以流格式发送到任意指定的地方
  • 配置模式:
log4j.appender.appenderName = className
log4j.appender.appenderName.Option1 = value1
…
log4j.appender.appenderName.OptionN = valueN

3、Layouts

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

  • 常使用的类如下

org.apache.log4j.HTMLLayout // 以HTML表格形式布局
org.apache.log4j.PatternLayout // 灵活地指定布局模式
org.apache.log4j.SimpleLayout // 包含日志信息的级别和信息字符串
org.apache.log4j.TTCCLayout // 包含日志产生的时间、线程、类别等信息
  • 配置模式:
log4j.appender.appenderName.layout =className
log4j.appender.appenderName.layout.Option1 = value1
…
log4j.appender.appenderName.layout.OptionN = valueN

二、配置详解

1、配置Logger(日志写出器)

  • 常见配置参数:
    • level :设定日志记录的最低级别,可设的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别,Log4j建议只使用中间四个级别。通过在这里设定级别,您可以控制应用程序中相应级别的日志信息的开关,比如在这里设定了INFO级别,则应用程序中所有DEBUG级别的日志信息将不会被打印出来。
    • appenderName:指定日志信息要输出到哪里。可以同时指定多个输出目的地,用逗号隔开
    • logger.xx.xx:指定哪个包/类设定Logger
  • 配置根Logger
// 理解为:默认的Logger
log4j.rootLogger = [level] , appenderName1, appenderName2,// 表示Logger不会在父Logger的appender里输出,默认为true
log4j.additivity.org.apache=false
  • 配置包Logger
// 指定 com.gk.test.controller包下所有类使用的Logger
log4j.logger.com.gk.test.controller= [ level ] , appenderName
  • 配置指定类Logger
// 指定UserController类所使用的Logger
log4j.logger.com.gk.test.controller.UserController= [ level ] , appenderName

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

配置格式:log4j.appender.appenderName = className

  • appenderName:被Logger器使用的自定义标识符(,如:A1、bb、C123都可以)
    • 一般定义时都比较有意义,如:console(控制台)、rollFile(滚动文件)
  • className 可设值项:
    • org.apache.log4j.ConsoleAppender :控制台
    • org.apache.log4j.FileAppender:文件
    • org.apache.log4j.DailyRollingFileAppender:每天产生一个日志文件
    • org.apache.log4j.RollingFileAppender:文件大小到达指定尺寸的时候产生一个新的文件
    • org.apache.log4j.WriterAppender:将日志信息以流格式发送到任意指定的地方

ConsoleAppender选项

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

FileAppender选项

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

DailyRollingFileAppender选项

  • Threshold=WARN # 指定日志信息的最低输出级别,默认为DEBUG。
  • ImmediateFlush=true # 表示所有消息都会被立即输出,设为false则不输出,默认值是true
  • Append=false # true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
  • File=logs/system.log # 指定当前消息输出到logging.log4j文件中。
  • DatePattern='.'yyyy-MM #每月滚动一次日志文件,即每月产生一个新的日志文件,当前日志文件名为system.log,前一个月的日志文件名为system.log.yyyy-MM

另外:也可以指定按周、天、时、分等来滚动日志文件,对应的格式如下:

  • '.'yyyy-MM:每月
  • '.'yyyy-ww:每周
  • '.'yyyy-MM-dd:每天
  • '.'yyyy-MM-dd-a:每天两次
  • '.'yyyy-MM-dd-HH:每小时
  • '.'yyyy-MM-dd-HH-mm:每分钟

RollingFileAppender选项

  • Threshold=WARN # 指定日志信息的最低输出级别,默认为DEBUG
  • ImmediateFlush=true # 表示所有消息都会被立即输出,设为false则不输出,默认值是true
  • Append=false # true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true
  • File=logs/system.log # 指定消息输出到logging.log4j文件中
  • MaxFileSize=100KB # 在日志文件到达该大小时,将会自动滚动,即将原来的内容移到system.log.1文件中,后缀可以是KB, MB 或者GB
  • MaxBackupIndex=2 # 指定可以产生的滚动文件的最大数。设置为2,则会产生一个sytem.log的当前文件 和 sytem.log.1、sytem.log.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:包含日志产生的时间、线程、类别等等信息

HTMLLayout选项

  • LocationInfo=true # 输出java文件名称和行号,默认值是false。
  • Title=My Logging # 默认值是Log4J Log Messages。

PatternLayout选项

  • ConversionPattern=%m%n # 设定以怎样的格式显示消息,%m%n:是2个格式化符号
  • 格式化符号 说明:
  • %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:%-20c

  • [-]:表示左对齐,如果没有写 [-] 表示使用默认右对齐
  • [20]:最小长度为20个字符,最大长度使用 [.20] 表示
  • [c]:上面说的格式化符号%c(输出日志信息所属的类目,通常就是所在类的全名)

例2:%.30l

  • [.30]:最大的长度是30,如果长度大于30的话,就会将左边多出的字符截掉。但小于30不会补空
  • [l]:上面说的格式化符号%l
  • 注意:这个例子中没有使用 [-] ,故:默认右对齐

三、案例

# Log4j配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。
log4j.rootLogger=DEBUG,console,logFile,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=logs/logfile.log
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=logs/rollingfile.log
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=logs/dailyfile.log
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

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
log4j 是一个用于日志记录的 Java 库。它提供了灵活的配置选项,可以根据不同的需求来记录日志消息。下面是 log4j配置详解: 1. Logger 层次结构:log4j 使用 logger 层次结构来管理日志消息。根据需要,可以创建多个 logger,并设置不同的级别和输出目标。logger 继承了其父 logger 的所有设置。 2. 日志级别log4j 支持多种日志级别,包括 TRACE、DEBUG、INFO、WARN、ERROR 和 FATAL。可以根据需要设置不同的级别。例如,如果将日志级别设置为 WARN,那么仅记录 WARN、ERROR 和 FATAL 级别的消息。 3. Appender:Appender 用于指定日志消息的输出目标。log4j 提供了多种 Appender,包括 ConsoleAppender(将日志消息输出到控制台)、FileAppender(将日志消息输出到文件)、RollingFileAppender(将日志消息输出到滚动的文件)等。 4. 格式化器(Layout):格式化器用于定义日志消息的输出格式。log4j 提供了多种格式化器,例如 PatternLayout(按照指定的模式输出日志消息)、SimpleLayout(简单的输出格式)等。 5. 配置文件:log4j配置信息通常通过一个 XML 或属性文件进行配置。在配置文件中,可以设置 logger、appender、layout 等相关属性。 下面是一个简单的 log4j 配置示例: ```xml <?xml version="1.0" encoding="UTF-8"?> <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/"> <appender name="consoleAppender" class="org.apache.log4j.ConsoleAppender"> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"/> </layout> </appender> <logger name="com.example"> <level value="DEBUG"/> <appender-ref ref="consoleAppender"/> </logger> </log4j:configuration> ```

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值