log4j xml 配置

最新推荐文章于 2024-07-24 10:02:46 发布
最新推荐文章于 2024-07-24 10:02:46 发布
阅读量531 收藏
点赞数
分类专栏： Java 文章标签： log4j xml layout 配置

Log4j XML Configuration Primer

Basic example

Below is a basic xml configuration file for log4j that will get you started:

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
  <appender name="console" class="org.apache.log4j.ConsoleAppender"> 
    <param name="Target" value="System.out"/> 
    <layout class="org.apache.log4j.PatternLayout"> 
      <param name="ConversionPattern" value="%-5p %c{1} - %m%n"/> 
    </layout> 
  </appender> 

  <root> 
    <priority value ="debug" /> 
    <appender-ref ref="console" /> 
  </root>
  
</log4j:configuration>

This will print all debug or higher messages to the console/screen. Items of note:

  • The appender is defined first, with a name (in this case "console"). A layout is defined for the appender (in this case  PatternLayout ), and a pattern is defined for the layout. What is required for the layout is layout specific, so check the javadoc description for the layout class you choose to use ( PatternLayout  is used most commonly).

  • No loggers are defined in this example, but the configuration for the "root" logger is defined. It is configured to level debug, and the appender named "console" is attached to it. All loggers inherit from root, so in this example, all debug or higher messages from all loggers will be printed to the console appender.

XML Configuration Format

In order to better understand the more detailed examples, it is useful to understand the expected format for the xml configuration files. This is defined by the log4j.dtd which is located in the log4j distribution jar in the package org.apache.log4j.xml. The contents of this file will not be listed in its entirety, so please feel free to open/print the file yourself. If you are not familiar with xml dtd file formats, then you should go find a good book on that subject first.

Near the beginning of the file is the following declaration:

<!ELEMENT log4j:configuration (renderer*, appender*,(category|logger)*,root?, categoryFactory?)>

This element defines the expected structure of the xml configuration file: 0 or more renderer elements, followed by 0 or more appender elements, followed by 0 or more logger elements, followed by 0 or 1 root element, followed by 0 or 1 categoryFactory element. If this order is not followed, then errors will be printed by the xml parser at the time the xml file is read in. Also, as a note, the "category" element is the same as the logger element. Prior to log4j version 1.2, loggers were known as category. Much of the documentation still refers to category. Just understand that they are the same thing.

Further along in the log4j.dtd is the following declaration which defines the allowed attributes:

<!ATTLIST log4j:configuration
  xmlns:log4j              CDATA #FIXED "http://jakarta.apache.org/log4j/"  
  threshold                (all|debug|info|warn|error|fatal|off|null) "null" 
  debug                    (true|false|null)  "null" 
>

  • debug - Probably the most important attribute for log4:configuration, setting it to "true" will print out information as the configuration file is read and used to configure the log4j environment. Very useful when trying to fiure out why your configuration file is not doing what you expect.

  • threshold - <yet to be described>

Understanding the expected structure of the xml configuration file makes it easier to concentrate on the specific elements one needs to configure.

Appender Configuration

One can instrument all the code one writes to output useful debug trace messages, but if log4j is not configured to have at least one appender, all will be for naught. None of the useful messages will be displayed anywhere.

Looking again to the log4j.dtd, appender elements are declared to be:

<!ELEMENT appender (errorHandler?, param*, layout?, filter*, appender-ref*)>
<!ATTLIST appender
  name          ID      #REQUIRED
  class         CDATA   #REQUIRED
>

An appender element must have name and class attributes. The name is the value used to reference the appender in the rest of the configuration file. The class attribute should be the fully qualified class name of the appender class to use (ie org.apache.log4j.ConsoleAppender ).

An appender element can also contain child elements:

  • 0 or 1 errorHandler element - <yet to be described>

  • 0 or more param elements - Each appender can be configured with setting specific to the functioning of the appender. This is implemented by getter and setter methods in the appender class. The param element is used to access the setter methods. The format for param elements is simple; they are atomic elements with a name attribute and a value attribute. The name attribute should be the name of the setter method with the "set" part of the method name omitted (ie method name "setTarget" would be "Target"). The value attribute is the value the setter method should be set with.

  • 0 or 1 layout element - Not all appenders use or require a layout. For appenders that do, the layout element defines what layout class to use. The layout element has one attribute, class, which is the fully qualified class name of the layout class to use. Similar to the appender element, the layout element is allowed to have 0 or more param child elements. Again, the param elements are used to set specific values for the layout class, which varies based on what layout class is used.

  • 0 or more filter elements - See the Filter Configuration section below for more details.

  • 0 or more appender-ref elements - <yet to be described>

So, from the above, the simple example of the appender named "console" from the basic example starts to make more sense:

  <appender name="console" class="org.apache.log4j.ConsoleAppender">
    <param name="Target" value="System.out"/>
    <layout class="org.apache.log4j.PatternLayout"> 
      <param name="ConversionPattern" value="%-5p %c{1} - %m%n"/> 
    </layout> 
  </appender>

The name of of the appender is "console" and this is the name that is used to refer to the appender in the rest of the configuration file. The class to use for the appender is  org.apache.log4j.ConsoleAppender .

The console appender has one param element defined. Looking at the javadoc for  ConsoleAppender , the  setTarget  method is used to choose which console stream to print messages to, System.out or System.err. The example configures the appender to use System.out.

The console appender also has a layout element defined which uses  org.apache.log4j.PatternLayout . Looking at the javadoc for  PatternLayout , the setConversionPattern method takes a string describing the layout for messages. The details of this format can also be found in the javadoc.

The details of the configuration for a specific appender class vary from class to class. Your best bet is to review the javadoc for the appender class you want to use. Pay particular attention to the setter property methods and the values they expect. Each setter method can be accessed using the param element in the xml configuration.

Currently, the following appender classes exist:

Logger Configuration

Now the appenders are configured. But how to configure loggers to output messages at a certain level? How to configure loggers to output to specific appender? Welcome to logger configuration.

The most important logger you need to configure is the root logger. From the simple example, this was done with the following configuration:

  <root> 
    <priority value ="debug" /> 
    <appender-ref ref="console" /> 
  </root>

The root logger is configured to output log message at level "debug" or higher to the appender named "console". All loggers inherit their settings from the root logger, so with no other configuration settings, all loggers will output all of their messages to the "console" appender automatically. This may be fine for simple debugging, but eventually more specific logger configuration is going to be required.

Looking again to the log4j.dtd, logger elements are declared to be:

<!ELEMENT logger (level?,appender-ref*)>
<!ATTLIST logger
  name          ID      #REQUIRED 
  additivity    (true|false) "true"   
>

A logger element must have a name attribute. This is the name of the logger used when creating the Logger instance(usually the fully qualified class name). It can also have an optional additivity attribute. More on this later.

A logger element can also contain child elements:

  • 0 or 1 level element - This defines the level of log messages that will be allowed to be logged for this logger. Normal usage has a value of "debug", "info", "warn", "error", or "fatal". Only that level or above will be reported to the log.

  • 0 or more appender-ref elements - This references a defined appender that log messages from this logger should be directed to. Appender-ref elements are simple elements that have a ref attribute. The value for this attribute should be the name of the appender.

A typical logger configuration element would look similar to this:

<logger name="com.mycompany.apackage.MyClass">
  <level value="info"/> 
</logger>

Logger Inheritance

<yet to be described>

Additivity

The output of a log statement of logger C will go to all the appenders in C and its ancestors. This is the meaning of the term "appender additivity".

However, if an ancestor of logger C, say P, has the additivity flag set to false, then C's output will be directed to all the appenders in C and it's ancestors upto and including P but not the appenders in any of the ancestors of P.

Loggers have their additivity flag set to true by default.

Example config;

<logger name="com.eatmutton.muttonsite.torque" additivity="false">
   <level value="info" />
   <appender-ref ref="local-torque" />
</logger>

Additivitiy section taken from http://logging.apache.org/log4j/docs/manual.html.

Converting Configuration Files To XML format

I have converted the configuration examples from the log4j manual to xml format. Hopefully people can use this to convert their own configuration files.

Example 1

# Set root logger level to DEBUG and its only appender to A1.
log4j.rootLogger=DEBUG, A1

# A1 is set to be a ConsoleAppender.
log4j.appender.A1=org.apache.log4j.ConsoleAppender

# A1 uses PatternLayout.
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r [%t] %-5p %c %x - %m%n

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
  <!-- A1 is set to be a ConsoleAppender -->
  <appender name="A1" class="org.apache.log4j.ConsoleAppender">
    <!-- A1 uses PatternLayout -->
    <layout class="org.apache.log4j.PatternLayout"> 
      <param name="ConversionPattern" value="%-4r [%t] %-5p %c %x - %m%n"/> 
    </layout> 
  </appender> 
  <root> 
    <!-- Set root logger level to DEBUG and its only appender to A1 -->
    <priority value ="debug" /> 
    <appender-ref ref="A1" /> 
  </root>
</log4j:configuration>

Example 2

log4j.rootLogger=DEBUG, A1
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout

# Print the date in ISO 8601 format
log4j.appender.A1.layout.ConversionPattern=%d [%t] %-5p %c - %m%n

# Print only messages of level WARN or above in the package com.foo.
log4j.logger.com.foo=WARN

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
  <appender name="A1" class="org.apache.log4j.ConsoleAppender"> 
    <layout class="org.apache.log4j.PatternLayout"> 
      <!-- Print the date in ISO 8601 format -->
      <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n"/> 
    </layout> 
  </appender> 
  <logger name="com.foo">
    <!-- Print only messages of level warn or above in the package com.foo -->
    <level value="warn"/> 
  </logger>
  <root> 
    <priority value ="debug" /> 
    <appender-ref ref="A1" /> 
  </root>
</log4j:configuration>

Example 3

log4j.rootLogger=debug, stdout, R

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=example.log

log4j.appender.R.MaxFileSize=100KB
# Keep one backup file
log4j.appender.R.MaxBackupIndex=1

log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%p %t %c - %m%n

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
  <appender name="stdout" class="org.apache.log4j.ConsoleAppender"> 
    <layout class="org.apache.log4j.PatternLayout"> 
      <!-- Pattern to output the caller's file name and line number -->
      <param name="ConversionPattern" value="%5p [%t] (%F:%L) - %m%n"/> 
    </layout> 
  </appender> 
  <appender name="R" class="org.apache.log4j.RollingFileAppender"> 
    <param name="file" value="example.log"/>
    <param name="MaxFileSize" value="100KB"/>
    <!-- Keep one backup file -->
    <param name="MaxBackupIndex" value="1"/>
    <layout class="org.apache.log4j.PatternLayout"> 
      <param name="ConversionPattern" value="%p %t %c - %m%n"/> 
    </layout> 
  </appender> 
  <root> 
    <priority value ="debug" /> 
    <appender-ref ref="stdout" /> 
    <appender-ref ref="R" /> 
  </root>
</log4j:configuration>

Filter Configuration

Filters can be defined at appender level. For example, to filter only certain levels, the LevelRangeFilter can be used like this:

        <appender name="TRACE" class="org.apache.log4j.ConsoleAppender">
                <layout class="org.apache.log4j.PatternLayout">
                        <param name="ConversionPattern" value="[%t] %-5p %c - %m%n" />
                </layout>
                <filter class="org.apache.log4j.varia.LevelRangeFilter">
                        <param name="levelMin" value="DEBUG" />
                        <param name="levelMax" value="DEBUG" />
                </filter>
        </appender>

Advanced Topics

<yet to be described>

More examples

(Please feel free to add your own configuration examples here)

Note that TimeBasedRollingPolicy can only be configured with xml, not log4j.properties

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<!-- Note that this file is refreshed by the server every 60seconds, as specified in web.xml -->

<log4j:configuration debug="true">

        <appender name="ROLL" class="org.apache.log4j.rolling.RollingFileAppender">
                <!-- The active file to log to -->
                <param name="file" value="/applogs/myportal/portal.log" />
                <param name="append" value="true" />
                <param name="encoding" value="UTF-8" />

                <rollingPolicy class="org.apache.log4j.rolling.TimeBasedRollingPolicy">
                        <!-- The file to roll to, this is a fairly intelligent parameter, if the file
                        ends in .gz, it gzips it, based on the date stamp it rolls at that time, 
                        default is yyyy-MM-dd, (rolls at midnight)
                        See: http://logging.apache.org/log4j/companions/extras/apidocs/org/apache/log4j/rolling/TimeBasedRollingPolicy.html -->
                        <param name="FileNamePattern" value="/applogs/myportal/portal.%d.log.gz" />
                </rollingPolicy>

                <layout class="org.apache.log4j.PatternLayout">
                        <!-- The log message pattern -->
                        <param name="ConversionPattern" value="%5p %d{ISO8601} [%t][%x] %c - %m%n" />
                </layout>
        </appender>
        
        <!-- Loggers to filter out various class paths -->

        <logger name="org.hibernate.engine.loading.LoadContexts" additivity="false">
                <level value="error"/>
                <appender-ref ref="ROLL" />
        </logger>
        
        <!-- Debugging loggers -->
        
        <!-- Uncomment to enable debug on calpoly code only -->
        <!--
        <logger name="edu.calpoly">
                <level value="debug"/>
                <appender-ref ref="ROLL" />
        </logger>
        -->
        
        <root>
                <priority value="info" />
                <appender-ref ref="ROLL" />
        </root>
        

</log4j:configuration>
ConversionPattern格式：

1）%m：消息本身
2）%p：消息的层次,也就是级别DEBUG,INFO,WARN,ERROR,FATAL
3）%r：从程序开始执行到当前日志产生时的时间间隔（微秒）
4）%c：输出当前日志动作所在的category名称（一般是类全名）。例如：如果category名称是"a.b.c","%c{2}"将会输出"b.c"；{2}意谓着输出“以点分隔开的category名称的后两个组件”,如果 {n}没有，将会输出整个category名称。
5）%t：输出当前线程的名称
6）%x：输出和当前线程相关联的NDC(具体解释见下文),尤其用到像java servlets这样的多客户多线程的应用中。
7）%n：输出平台相关的换行符。
8）%%：输出一个"%"字符
9）%d：输出日志产生时候的日期，当然可以对日期的格式进行定制。例如%d{yyy MMM dd HH:mm:ss,SSS}，输出类似： 2002年10月18日 22：10：28，921   ；如果没有指定后面的格式，将会输出ISO8601的格式。
10）%l：输出位置信息，相当于%C.%M(%F:%L)的组合。包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)
11）%C：输出日志消息产生时所在的类名，如果类名是“test.page.Class1”%C{1}表示输出类名"Class1" ；%C{2}输出"page.Class1"；而%C则输出"test.page.Class1"。
12）%M：输出日志消息产生时的方法名称
13）%F：输出日志消息产生时所在的文件名称
14）%L：输出代码中的行号

log4j.additivity是 子Logger 是否继承 父Logger 的 输出源（appender） 的标志位。具体说，默认情况下 子Logger 会继承 父Logger 的appender，也就是说 子Logger 会在 父Logger 的appender里输出。若是additivity设为false，则 子Logger 只会在自己的appender里输出，而不会在 父Logger 的appender里输出。 
w星星b
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
log4j-XML文件配置
王景清的博客
02-21 1648
如果使用SpringBoot指定log4j日志框架，那么配置文件名需为 log4j2-spring.xml 才能读取配置。 配置样例 <?xml version="1.0" encoding="UTF-8"?> <configuration status="OFF" name="XIncludeDemo" monitorInterval="30" packages="com.sitech.csd.cmap.log4j2.test"> <ap
在applicationContext.xml中配置Service层时 name Tag ‘property’ must have a ‘name’ attribute 出错的问题
FEDDDWQWQE的博客
12-29 2342
在applicationContext.xml中配置Service层时 name Tag ‘property’ must have a ‘name’ attribute 出错的问题抛出异常 Error creating bean with name ‘userService’ defined in class path resource [applicationContext.xml]: Er
log4j xml配置详解
qq_39256196的博客
10-12 4521
log4j xml配置详解
java log4j xml配置详解,log4j配置详解(非常详细)
weixin_42502165的博客
03-13 1611
资料：============================================================================================================================================================================================log4j.pro...
log4j.xml配置详解
wenwentana的博客
09-24 5009
可能的取值从小到大依次为"all"、"debug"、"info"、"warn"、"error"、"fatal"和"off"。%c : 输出所属类的全名，可在修改为 %C{Num} ,Num类名输出的维（如："org.apache.elathen.ClassName",%C{2}将输出elathen.ClassName）class [#IMPLIED attribute] : 定义level对象所属的类，默认情况下是"org.apache.log4j.Level类。
java log4j xml配置详解_java – log4j.xml配置的常用变量
weixin_28873283的博客
02-24 462
更新：原始答案适用于Log4j 1.xLog4j 2.x对配置文件中的属性有更加丰富的支持,请参阅Log4j手册约Configuration with properties.Log4j 1.x(原答案)：在使用log4j.xml时,实现类似操作的唯一方法是在启动时设置系统属性,然后从log4j.xml引用该属性.在启动时,您设置系统属性：java -Dlog_dir=/var/logs/custo...
java log4j xml配置详解_java-log4j-xml配置 category、logger、boot 标签使用
weixin_33603397的博客
02-24 512
java-log4j-xml配置 category、logger、boot 标签使用一、节点说明： root：基础日志配置、包括使用的输出器、日志级别等；logger：自定义输出配置；category：自定义输出配置；logger、category 用法一致，可以配置通过 additivity 属性标记是否集成 root 配置；二、maven 依赖：log4jlog4j1.2.17log4j 配置...
log4j配置文件（xml）
m0_65486538的博客
01-03 828
【代码】log4j配置文件（xml）
Log4j.xml配置说明
井底之蛙
12-12 1163
Log4j 2 是一款广泛使用的 Java 日志框架，它支持多种日志级别、异步日志、过滤器等功能，并且具有高性能和可扩展性。以下是 Log4j 2 的详细配置说明：配置文件名称和存放位置：Log4j 2 的配置文件名可以是任意有效的文件名，但通常以.xml.json或.yaml结尾。配置文件应该存放在项目的类路径（class path）下，例如目录下。配置文件格式：Log4j 2 的配置文件可以采用 XML、JSON 或 YAML 格式。
java log4j xml配置详解,详解log4j.properties的简单配置和使用
weixin_30741979的博客
03-13 705
本文介绍了详解log4j.properties的简单配置和使用，分享给大家，具体如下：简单log4j.properties配置示例JAVA 代码部分需要log4j JAR包Log4j支持两种格式的配置文件：xml和properties;依赖commons-logging包1、配置根loggerlog4j.rootLogger=[level],appenderName,appenderName,.....
Log4j2学习log4j2.xml配置模板
07-13
下面是一个较为完整的 Log4j2.xml 配置模板： ```xml <?xml version="1.0" encoding="UTF-8"?> <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL --> <!--Configuration 后面...
Log4J配置实例（xml格式）
03-16
Log4J的XML配置文件通常以`log4j.xml`或`logging.xml`为名，它们定义了日志的输出级别、目的地、布局格式以及附加的配置参数。 ### 1. 日志级别 Log4J支持多种日志级别，包括`DEBUG`、`INFO`、`WARN`、`ERROR`和`...
log4j2的日志xml配置文件
07-25
log4j2的配置文件
log4j.xml（MyBatis框架）
08-02
这里是log4j.xml详细的配置，在使用MyBatis框架时必要的一种配置。
log4j2.xml配置
04-26
spring5取消Log4jConfigListener，运用Log4jServletContextListener代替Log4jConfigListener（log4j2.xml的配置）
C++那些事之依赖注入
Francis的博客
07-18 1075
C++那些事之依赖注入最近星球里面有个小伙伴让更新一下依赖注入，于是写出了这篇文章，来从实际的例子讲解，本文会讲解一些原理与实现，完整的实现代码懒人版放在星球中，我们开始正文。大纲：直接依赖接口依赖注入模版依赖注入依赖注入是一种常用的设计模式，通常会采用接口/模版的方式提高代码的可测性与维护性，下面我们来举个例子。假设有一个用户服务类UserService，需要通过HTTP客户端与远程服务器进行通...
配置文件格式 XML 快速上手
Dablelv 的博客专栏。
07-20 824
XML（Extensible Markup Language）是可扩展标记语言，用来传输和存储数据。因为其允许用户自定义标记名称，具有自我描述性，可灵活地用于存储服务配置信息。
XMl基本操作
weixin_73775528的博客
07-20 697
使⽤Mybatis的注解⽅式，主要是来完成⼀些简单的增删改查功能. 如果需要实现复杂的SQL功能，建议使⽤XML来配置映射语句，也就是将SQL语句写在XML配置⽂件中.之前，我们学习了，用注解的方式来实现MyBatis接下来我们学习XML的⽅式MyBatis XML的⽅式需要以下两步配置数据库连接字符串和MyBatis写持久层代码MyBatis XML配置⽂件配置连接字符串和MyBatis此步骤需要进⾏两项设置，数据库连接字符串设置和 MyBatis 的 XML ⽂件配置。写持久层代码。
XML 和 SimpleXML 入门教程
最新发布
wjs2024的博客
07-24 232
XML 是一种用于存储和传输数据的标记语言，而 SimpleXML 是 PHP 中的一个扩展，用于解析和操作 XML 数据。通过本文的介绍，您应该已经了解了 XML 和 SimpleXML 的基本概念，并掌握了如何在 PHP 中使用 SimpleXML 解析和操作 XML 数据。
log4j xml 配置说明
05-31
以下是log4j的XML配置说明： 1. 首先，需要定义一个根logger，它将捕获所有日志消息。可以通过设置级别（level）属性来控制要记录的日志消息的详细程度。例如，设置级别为INFO将记录INFO、WARN、ERROR和FATAL级别的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值