`
随枫霏
  • 浏览: 135415 次
  • 性别: Icon_minigender_1
  • 来自: 杭州
社区版块
存档分类
最新评论

log4j学习笔记

阅读更多

 


官方文档

参考

log4j中3个重要的概念——Logger Appender Layout

1.Logger

1.1 Logger
Logger是我们打印日志之前去的的控制日志打印的对象
Logger具有自己的名称,根据名称的可包含关系具有继承性
例如: 名字为com.foo的Logger是com.foo.Bar的Logger的祖先,因为它们2个之间只相差一个.后面的字符,因此com.foo的Logger是com.foo.Bar的Logger的父亲
root是所有Logger的祖先,除了root之外,所有Logger获取的方式都是通过名称获取

1.2日志的等级
获取Logger打印日志的时候,需要指定日志的Level,log4j中日志的等级有
FATAL>ERROR>WARN>INFO>DEBUG>TRACE>ALL
每一个和Logger上都会预定义一个defaultLevel,只有>=defaultLevel的日志才会输出,如果该Logger上没有指定defaultlevel,那么它会继承自它的父Logger的defaultLevel,以此类推,直到root


2. Appender 

2.1 appender
appender是控制输出日志的位置,可以是控制台,也可以是文件,也可以是远程的一个IO流
Logger需要与appedner继续关联,这样Logger就直到自己的日志内容应该输出到什么地方。需要指出的是,一个Logger可以关联多个appender,而且这种关联关系式具有继承性的,也就是说子Logger会继承父Logger关联的appender,如果不加控制的话,叶子appedner会继承自它上层的每一级Logger关联的所有appender,为了避免这种事情的发生,额可以在一个Logger上指定additivity="false",这样,它以及它的子Logger不会继承它祖先Logger的appender了。

2.2 appender的输出方式
             org.apache.log4j.RollingFileAppender(滚动文件,自动记录最新日志)
             org.apache.log4j.ConsoleAppender (控制台)  
             org.apache.log4j.FileAppender (文件)
             org.apache.log4j.DailyRollingFileAppender (每天产生一个日志文件)
             org.apache.log4j.WriterAppender (将日志信息以流格式发送到任意指定的地方)


3. Layouts

3.1 layout
appender用来控制输出日志的格式,每个appedner关联一个appender。

3.2 输出格式定义
appender输出的格式的参数必须以%开头,
               %c        输出所属类的全名,可在修改为 %d{Num} ,Num类名输出的维(如:"org.apache.elathen.ClassName",%C{2}将输出          elathen.ClassName)
                %d       输出日志时间其格式为 %d{yyyy-MM-dd HH:mm:ss,SSS},可指定格式 如 %d{HH:mm:ss}
                %l        输出日志事件发生位置,包括类目名、发生线程,在代码中的行数
                %n       换行符
                %m      输出代码指定信息,如info(“message”),输出message
                %p       输出优先级,即 FATAL ,ERROR 等
                %r        输出从启动到显示该log信息所耗费的毫秒数
                %t        输出产生该日志事件的线程名

4.配置和使用

log4j的初始化需要读取一个配置文件,这个配置文件的名称存放在log4j.configuration 系统属性当中。
如果没有的话,默认会先寻找 classapth下的 log4j.xml ,如果找不到再寻找classpath下的 log4j.properties

4.1  log4j.properties配置文件示例
log4j.rootLogger=DEBUG, stdout, R
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L %M) %m%n

log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=example.log
log4j.appender.R.MaxFileSize=100KB
log4j.appender.R.MaxBackupIndex=1
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n
 

4.2 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="D:/output.log" /><!-- 设置日志输出文件名 -->
		<!-- 设置是否在重新启动服务时,在原有日志的基础添加新日志 -->
		<param name="Append" value="true" />
		<param name="MaxBackupIndex" value="10" />
		<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="E:/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.mytest" additivity="false">
		<level value="info"></level>
		<appender-ref ref="activexAppender" />
	</logger>

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

4.3 使用
log4j的使用是非常简单的

public class BasicTest {
     // 获取到Logger对象
    static Logger logger = Logger.getLogger(BasicTest.class);

    public static void main(String[] args) {
      //打印日志
        logger.info("Entering application.");
        logger.info("Entering application.");
    }

}

5. 关于日志使用的几点建议

5.1 对于异常的日志最好打印堆栈
故障排查是,查看线上日志时一个最直接的途径,我们希望在日志中打印出来一场堆栈
例如 logger.error("error msg", e);

5.2 打印的日志消息内容最好可以有业务场景信息
打印出来的日志最好有业务场景的上下文内容
例如 logger.error("消息推送过程中发生异常, message:" + mesage.toString() , e);

5.3 最好在输出日志的方法上进行判断
只有输出日志的级别>=Logger预定级别的时候,这条日志才会被输出
看下面一行代码:
logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i]));
如果 输出日志的级别<Logger预定级别,日志不会输出,但是却进行了输入字符串的拼接,应该将上面的代码修改为
if(logger.isDebugEnabled() {
        logger.debug("Entry number: " + i + " is " + String.valueOf(entry[i]));
 }
进一步修改,可以使用StringBuilder替代String的直接拼接

分享到:
评论

相关推荐

    log4J学习笔记

    ### log4J学习笔记 #### 一、Apache Commons Logging与log4j及JDK Logger的关系 **Apache Commons Logging** 的设计初衷是为了提供一个简洁统一的日志接口,它并不直接实现日志功能,而是通过桥接的方式支持多种...

    log4j 学习笔记

    "log4j 学习笔记" log4j 是一个流行的 Java 日志记录工具, logger 是记录日志信息的基本单元。在 log4j 中, logger 的级别越低,记录的日志信息越详细。 Logger 的级别从低到高依次是:ALL 。 log4j 的日志记录...

    Log4j学习笔记和一套完整定义实例

    **Log4j学习笔记** Log4j是一款广泛应用于Java编程中的日志记录框架,由Apache软件基金会开发。它提供了一套灵活的日志记录系统,帮助开发者在开发过程中追踪应用程序的行为,便于调试、性能分析和问题排查。Log4j...

    log4j 学习 笔记

    ### Log4j 学习笔记知识点详解 #### 一、Log4j 概述与架构 **Log4j** 是 **Apache** 组织提供的一个开源日志框架,旨在简化应用开发中的日志记录工作。它能够灵活地记录程序运行时的信息,并允许用户自定义日志的...

    Log4J学习笔记

    ### Log4J学习笔记 #### 一、Log4J配置文件的学习 在深入理解Log4J之前,我们先从配置文件入手。Log4J支持多种配置文件格式,其中包括XML和Java特性文件(键=值)。这里我们将重点介绍如何使用Java特性文件作为...

    Log4j学习笔记

    ### Log4j学习笔记 #### 一、Log4j简介 Log4j是Apache的一个开源项目,用于实现日志功能的Java库。它允许开发者控制日志信息的生成、格式和输出目标。Log4j的强大之处在于它的灵活性和扩展性,能够适应不同层次的...

    Log4j 学习笔记

    ### Log4j 学习笔记 #### Apache Log4j 简介 Log4j 是一个基于 Java 的开源日志框架,由 Apache 软件基金会维护。它为 Java 应用程序提供了一种灵活的方式来记录日志信息,并且允许用户自定义日志输出的目的地、...

    日志管理Log4j学习笔记

    ### Log4j学习笔记知识点详解 #### 一、Log4j概述 - **定义与功能**:Log4j是Apache组织推出的一个开源日志框架,主要用于控制和管理应用程序中的日志记录过程。它允许开发者非常灵活地配置日志输出的目的地(如...

    log4j学习笔记及写入数据库配置

    在学习Log4j的过程中,阅读“log4j学习笔记及写入数据库配置”这份资料将有助于深入理解Log4j的使用,包括具体的配置步骤、常见问题以及最佳实践。通过实践,你可以更好地掌握如何利用Log4j来提升你的应用程序的可...

    Log4j学习笔记,个人整理

    Log4j学习笔记 在软件开发中,日志记录是一个至关重要的部分,它不仅帮助开发者监控程序运行状态,追踪错误,还可以为系统维护提供宝贵的审计信息。Log4j,一个由Apache开发的Java日志框架,是日志记录工具中的佼佼...

    Log4j的学习笔记

    **Log4j学习笔记** Log4j是一款广泛应用于Java编程中的日志记录工具,由Apache软件基金会开发。它提供了一种灵活且强大的机制来记录应用的运行情况,这对于调试、性能分析、问题追踪以及系统监控至关重要。这篇学习...

    Log4j 学习笔记.doc

    Log4j 是一款广泛使用的日志记录框架,它允许开发者以高效、灵活的方式记录应用程序的日志信息。在本文中,我们将深入...在学习过程中,参考官方文档和其他开发者的经验分享,可以进一步提升对Log4j的理解和应用能力。

    不错的 log4j 学习 笔记

    log4j的学习笔记,网上找到的,写的很不错

    log4j学习笔记.

    例如,`log4j.appender.stdout=org.apache.log4j.ConsoleAppender`指定了一个控制台输出器,而`log4j.appender.R=org.apache.log4j.RollingFileAppender`则指定了一个滚动文件输出器,用于当文件大小达到指定尺寸时...

    *Log4j 学习笔记

    Log4j 是一个广泛使用的 Java 日志框架,它允许开发者方便地记录应用程序的日志信息。这个框架的核心组件包括 Logger、Appender 和 Layout,它们协同工作以实现灵活的日志管理。 1. **Logger** - 日志写出器 ...

    log4j的学习笔记

    **Apache Log4j 学习笔记** Apache Log4j 是一个广泛使用的开源日志记录框架,主要用于Java应用程序。它的核心功能是提供灵活的日志记录控制,帮助开发者在开发过程中跟踪和记录程序运行时的事件,从而提高调试效率...

    Apache_Log4j_学习笔记

    ### Apache Log4j 学习笔记精要 #### 一、Apache Log4j 概览 **Apache Log4j** 是一款开源的日志框架,由Apache软件基金会所提供,旨在简化Java应用程序中的日志记录过程。它允许开发者在代码中加入日志记录功能,...

    Log4j入门学习笔记

    【Log4j入门学习笔记】 Log4j是一个广泛使用的Java日志框架,旨在解决程序开发中日志记录的复杂性和可维护性问题。它提供了一种灵活的方式来控制日志信息的输出格式、输出级别和输出位置,使得在调试、监控和故障...

Global site tag (gtag.js) - Google Analytics