AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

log4j介绍以及使用教程

2016-05-12 1189
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
日志服务 SLS，月写入数据量 50GB 1个月
简介： 一、介绍 　　Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接 口服务 器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。

一、介绍

　　Log4j是Apache的一个开放源代码项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接 口服务 器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。 
　　Log4j由三个重要的组件构成：日志信息的优先级，日志信息的输出目的地，日志信息的输出格式。

　　日志信息的优先级从高到低有ERROR、 WARN、 INFO、DEBUG，分别用来指定这条日志信息的重要程度；

　　日志信息的输出目的地指定了日志将打印到控制台还是文件中；

　　日志的输出格式则控制了日志信息的显 示内容。

二、配置文件详解

　　首先声明：log4j可以有两种方式进行配置，一种基于log4j.properties(本文重点讲解)，另一种基于log4j.xml.(不作讲解，有需要的自行研究)

　　其实我们也可以完全不使用配置文件，而是在代码中配置Log4j环境。但是，使用配置文件将使我们的应用程序更加灵活。

　　下面我们介绍使用properties格式做为配置文件的方法：

　　　　示例： 
　　　　　　log4j.rootLogger=INFO, D 
　　　　　　log4j.appender.D=org.apache.log4j.ConsoleAppender 
　　　　　　log4j.appender.D.layout=org.apache.log4j.PatternLayout 
　　　　　　log4j.appender.D.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n 

　　　　rootLogger：日志的根

　　　　appender:日志的输出方式

1. 配置根Logger，其语法为：
　　log4j.rootLogger = [ level ] , appenderName, appenderName, … 
其中，level 是日志记录的优先级，分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定义的级别。Log4j建议只使用四个级别，优 先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定 义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来。 
appenderName就是指定日志信息输出到哪个地方。您可以同时指定多个输出目的地。 

2. 配置日志信息输出目的地Appender，其语法为：
log4j.appender.appenderName = fully.qualified.name.of.appender.class 
log4j.appender.appenderName.option1 = value1 
… 
log4j.appender.appenderName.option = valueN 
其中，Log4j提供的appender有以下几种： 
　　org.apache.log4j.ConsoleAppender（控制台）， 
　　org.apache.log4j.FileAppender（文件）， 
　　org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）， 
　　org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）， 
　　org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方） 
(1).ConsoleAppender选项 
　　Threshold=WARN:指定日志消息的输出最低层次。 
　　ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。 
　　Target=System.err：默认情况下是：System.out,指定输出控制台 
(2).FileAppender 选项 
　　Threshold=WARN:指定日志消息的输出最低层次。 
　　ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。 
　　File=mylog.txt:指定消息输出到mylog.txt文件。 
　　Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。 
(3).DailyRollingFileAppender 选项 
　　Threshold=WARN:指定日志消息的输出最低层次。 
　　ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。 
　　File=mylog.txt:指定消息输出到mylog.txt文件。 
　　Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。 
　　DatePattern='.'yyyy-ww:每周滚动一次文件，即每周产生一个新的文件。当然也可以指定按月、周、天、时和分。即对应的格式如下： 
  　　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:指定日志消息的输出最低层次。 
　　ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。 
　　File=mylog.txt:指定消息输出到mylog.txt文件。 
　　Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。 
　　MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件。 
　　MaxBackupIndex=2:指定可以产生的滚动文件的最大数。 

3. 配置日志信息的布局，其语法为：
　　log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class 
　　log4j.appender.appenderName.layout.option1 = value1 
　　… 
　　log4j.appender.appenderName.layout.option = valueN 
　　其中，Log4j提供的layout有以下几种： 
　　　　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：设定以怎样的格式显示消息。
　　在配置文件中可以通过log4j.appender.A1.layout.ConversionPattern设置日志输出格式。  

各种格式化说明如下：

 
　　-X: X信息输出时左对齐
　　%p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL, 
　　%d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921 
　　%r: 输出自应用启动到输出该log信息耗费的毫秒数 
　　%c: 输出日志信息所属的类目，通常就是所在类的全名 
　　%t: 输出产生该日志事件的线程名 
　　%l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10) 
　　%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。 
　　%%: 输出一个”%”字符 
　　%F: 输出日志消息产生时所在的文件名称 
　　%L: 输出代码中的行号 
　　%m: 输出代码中指定的消息,产生的日志具体信息 
　　%n: 输出一个回车换行符，Windows平台为”\r\n”，Unix平台为”\n”输出日志信息换行 
　　可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如： 
　　　　1)%20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。 
　　　　2)%-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，”-”号指定左对齐。 
　　　　3)%.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。 
　　　　4)%20.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边交远销出的字符截掉。 
三、在程序中的使用
在程序中使用Log4j之前，首先要将commons-logging.jar和logging-log4j-1.2.9.jar导入到classpath中，并将log4j.properties放于src根目录中。接下来就可以使用了。 
与springmvc进行集成的时候，也可以在web.xml中配置以下代码来指定配置文件的位置(默认是在classpath下面)
<!-- Log4j配置 -->
<context-param>
        <param-name>log4jConfigLocation</param-name>
        <param-value>classpath:log4j.properties</param-value>
</context-param>
<!-- 加载log4j配置文件 -->
<listener>
        <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>

1.得到记录器
使用Log4j，第一步就是获取日志记录器，这个记录器将负责控制日志信息。其语法为： 
public static Logger getLogger( String name)， 
通过指定的名字获得记录器，如果必要的话，则为这个名字创建一个新的记录器。Name一般取本类的名字，比如： 
static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () ) ; 
注：推荐使用commons-logging结合log4j进行日志记录 
private static Log logger = LogFactory.getLog(Yourclass.class);

2.插入记录信息（格式化日志信息）
当上两个必要步骤执行完毕，您就可以轻松地使用不同优先级别的日志记录语句插入到您想记录日志的任何地方，其语法如下： 
Logger.debug ( Object message ) ; 
Logger.info ( Object message ) ; 
Logger.warn ( Object message ) ; 
Logger.error ( Object message ) ; 
四、Log4j比较全面的配置
LOG4J的配置之简单使它遍及于越来越多的应用中了：Log4J配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。择其一二使用就够用了。
 
log4j.rootLogger=DEBUG,CONSOLE,A1,im
log4j.addivity.org.apache=true
# 应用于控制台
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.Threshold=DEBUG
log4j.appender.CONSOLE.Target=System.out
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
#log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[thread] n%c[CATEGORY]%n%m[MESSAGE]%n%n
#应用于文件
log4j.appender.FILE=org.apache.log4j.FileAppender
log4j.appender.FILE.File=file.log
log4j.appender.FILE.Append=false
log4j.appender.FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
# Use this layout for LogFactor 5 analysis
# 应用于文件回滚
log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender
log4j.appender.ROLLING_FILE.Threshold=ERROR
log4j.appender.ROLLING_FILE.File=rolling.log //文件位置,也可以用变量${java.home}、rolling.log
log4j.appender.ROLLING_FILE.Append=true //true:添加 false:覆盖
log4j.appender.ROLLING_FILE.MaxFileSize=10KB //文件最大尺寸
log4j.appender.ROLLING_FILE.MaxBackupIndex=1 //备份数
log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%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 Facter 5
log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout
log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[thread]%n%c[CATEGORY]%n%m[MESSAGE]%n%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= web@www.wuset.comwww.wuset.com www.wuset.com
log4j.appender.MAIL.SMTPHost= www.wusetu.com
log4j.appender.MAIL.Subject=Log4J Message
log4j.appender.MAIL.To= web@www.wusetu.comwww.wusetu.com www.wusetu.com
log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout
log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%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 (’[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n’)
log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout
log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender
log4j.appender.A1.File=SampleMessages.log4j
log4j.appender.A1.DatePattern=yyyyMMdd-HH’.log4j’
log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout
#自定义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 =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
文章标签：
日志服务
Java
监控
Apache
数据库
Windows
关键词：
日志服务教程
Log4j教程
Log4j使用教程
相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
阿豪聊干货
目录
相关文章
dream_ready
|
2月前
|
数据采集 监控 Java
SpringBoot日志全方位超详细手把手教程，零基础可学习 日志如何配置及SLF4J的使用......
本文是关于SpringBoot日志的详细教程，涵盖日志的定义、用途、SLF4J框架的使用、日志级别、持久化、文件分割及格式配置等内容。
dream_ready
188 0
SpringBoot日志全方位超详细手把手教程，零基础可学习 日志如何配置及SLF4J的使用......
北京-宏哥
|
5月前
|
存储 Web App开发 Java
《手把手教你》系列基础篇（九十五）-java+ selenium自动化测试-框架之设计篇-java实现自定义日志输出（详解教程）
【7月更文挑战第13天】这篇文章介绍了如何在Java中创建一个简单的自定义日志系统，以替代Log4j或logback。
北京-宏哥
302 5
北京-宏哥
|
5月前
|
XML Java 测试技术
《手把手教你》系列基础篇（九十一）-java+ selenium自动化测试-框架设计基础-Logback实现日志输出-下篇（详解教程）
【7月更文挑战第9天】在Java项目中，使用Logback配置可以实现日志按照不同包名输出到不同的文件，并且根据日志级别分开记录。
北京-宏哥
99 4
北京-宏哥
|
5月前
|
XML 测试技术 数据格式
《手把手教你》系列基础篇（八十五）-java+ selenium自动化测试-框架设计基础-TestNG自定义日志-下篇（详解教程）
【7月更文挑战第3天】TestNG教程展示了如何自定义日志记录。首先创建一个名为`TestLog`的测试类，包含3个测试方法，其中一个故意失败以展示日志。使用`Assert.assertTrue`和`Reporter.log`来记录信息。接着创建`CustomReporter`类，继承`TestListenerAdapter`，覆盖`onTestFailure`, `onTestSkipped`, 和 `onTestSuccess`，在这些方法中自定义日志输出。
北京-宏哥
53 6
北京-宏哥
|
5月前
|
Java 测试技术 Apache
《手把手教你》系列基础篇（八十六）-java+ selenium自动化测试-框架设计基础-Log4j实现日志输出（详解教程）
【7月更文挑战第4天】Apache Log4j 是一个广泛使用的 Java 日志框架，它允许开发者控制日志信息的输出目的地、格式和级别。Log4j 包含三个主要组件：Loggers（记录器）负责生成日志信息，Appenders（输出源）确定日志输出的位置（如控制台、文件、数据库等），而 Layouts（布局）则控制日志信息的格式。通过配置 Log4j，可以灵活地定制日志记录行为。
北京-宏哥
60 4
北京-宏哥
|
5月前
|
Java 关系型数据库 测试技术
《手把手教你》系列基础篇（八十九）-java+ selenium自动化测试-框架设计基础-Logback实现日志输出-上篇（详解教程）
【7月更文挑战第7天】Apache Log4j2的安全漏洞促使考虑使用logback作为替代的日志框架。Logback由log4j创始人设计，提供更好的性能，更低的内存使用，并且能够自动重载配置文件。它分为logback-core、logback-classic（实现了SLF4J API）和logback-access（用于Servlet容器集成）三个模块。配置涉及Logger、Appender（定义日志输出目的地）和Layout（格式化日志）。
北京-宏哥
58 1
北京-宏哥
|
5月前
|
XML Java 测试技术
《手把手教你》系列基础篇（九十）-java+ selenium自动化测试-框架设计基础-Logback实现日志输出-中篇（详解教程）
【7月更文挑战第8天】这篇教程介绍了如何使用Logback将Java应用的日志输出到文件中。首先，通过创建`logback.xml`配置文件，设置`FileAppender`来指定日志文件路径和格式。然后，提供了一个`RollingFileAppender`的例子，用于每日生成新的日志文件并保留一定天数的历史记录。文中包含配置文件的XML代码示例，并展示了控制台输出和生成的日志文件内容。教程最后提到了一些可能遇到的问题及解决建议。
北京-宏哥
46 0
《手把手教你》系列基础篇（九十）-java+ selenium自动化测试-框架设计基础-Logback实现日志输出-中篇（详解教程）
北京-宏哥
|
5月前
|
XML Java 测试技术
《手把手教你》系列基础篇（八十八）-java+ selenium自动化测试-框架设计基础-Log4j 2实现日志输出-下篇（详解教程）
【7月更文挑战第6天】本文介绍了如何使用Log4j2将日志输出到文件中，重点在于配置文件的结构和作用。配置文件包含两个主要部分：`appenders`和`loggers`。`appenders`定义了日志输出的目标，如控制台（Console）或其他文件，如RollingFile，设置输出格式和策略。`loggers`定义了日志记录器，通过`name`属性关联到特定的类或包，并通过`appender-ref`引用`appenders`来指定输出位置。`additivity`属性控制是否继承父logger的配置。
北京-宏哥
45 0
北京-宏哥
|
5月前
|
XML Java 测试技术
《手把手教你》系列基础篇（八十七）-java+ selenium自动化测试-框架设计基础-Log4j 2实现日志输出-上篇（详解教程）
【7月更文挑战第5天】Apache Log4j 2是一个日志框架，它是Log4j的升级版，提供了显著的性能提升，借鉴并改进了Logback的功能，同时修复了Logback架构中的问题。Log4j2的特点包括API与实现的分离，支持SLF4J，自动重新加载配置，以及高级过滤选项。它还引入了基于lambda表达式的延迟评估，低延迟的异步记录器和无垃圾模式。配置文件通常使用XML，但也可以是JSON或YAML，其中定义了日志级别、输出目的地（Appender）和布局(Layout)。
北京-宏哥
51 0
北京-宏哥
|
5月前
|
Java 测试技术 Android开发
《手把手教你》系列基础篇（八十四）-java+ selenium自动化测试-框架设计基础-TestNG日志-上篇（详解教程
【7月更文挑战第2天】TestNG是一个用于自动化测试的Java框架，提供日志记录功能。日志有两种模式：底层级详细记录每个步骤，高层级仅记录关键事件。示例代码展示了如何在测试方法中使用`Reporter.log()`记录信息，这些信息会显示在TestNG HTML报告中。文章还提及了日志显示时可能出现的编码问题及解决办法。
北京-宏哥
63 0

热门文章

最新文章

  • 1
    为什么阿里巴巴禁止工程师直接使用日志系统(Log4j、Logback)中的 API
  • 2
    从Log4j迁移到LogBack的理由
  • 3
    log4j配置与说明
  • 4
    Springboot整合slf4j搭配log4j2
  • 5
    Log4j官方文档翻译(七、日志格式化)
  • 6
    log4j学习
  • 7
    Eclipse的log4j插件log4e的用法
  • 8
    Log4j_学习_03_自己动手封装log工具
  • 9
    log4j 的使用和配置简介
  • 10
    MyBatis3 用log4j在控制台输出 SQL
  • 1
    mongoDB查看数据的插入日志
    461
  • 2
    修改开发板内核启动日志输出级别
    114
  • 3
    【MongoDB 专栏】MongoDB 的日志管理与分析
    176
  • 4
    编程日志01:个人网站更新用户头像
    51
  • 5
    编程日记02：个人站优化数据库和日志
    50
  • 6
    oracle11g SAP测试机归档日志暴增排查（二）
    333
  • 7
    oracle11g SAP测试机归档日志暴增排查（一）
    82
  • 8
    log4j:WARN Please initialize the log4j system prop
    61
  • 9
    LabVIEW崩溃后所产生的错误日志文件的位置
    199
  • 10
    关于日志的清理
    64

    • 相关课程

    更多
  • 基于MongoDB构建实时日志分析平台
  • 日志服务SLS实现云产品可观测
  • 日志服务 SLS 可观测数据分析平台介绍
  • 大数据知识图谱系列—基于ELK+Flink日志全观测最佳实践
  • 场景实践-基于阿里云Quick BI 对MOOC网站日志分析

    • 相关电子书

    更多
  • PostgresChina2018_赖思超_PostgreSQL10_hash索引的WAL日志修改版final
  • Kubernetes下日志实时采集、存储与计算实践
  • 日志数据采集与分析对接

    • 相关实验场景

    更多
  • 使用CloudLens管理SLS日志采集
  • 使用CloudLens采集PolarDB日志并进行审计分析
  • 使用CloudLens采集RDS日志并进行审计分析
  • 使用日志服务SLS进行OSS可观测分析
  • 多账号体系下使用日志服务中心化的管理日志
  • 日志服务之告警接入与管理
    • 下一篇
    阿里云对象存储OSS收费标准：存储、流量和请求等多个计费项详解