Apache Log4j 2用户指南

需积分: 3 25 浏览量更新于2024-07-20 收藏 1.13MB PDF 举报

"Apache Log4j 2用户指南PDF版，版本2.4.1，由Apache软件基金会于2015年10月8日发布。该指南涵盖了从Log4j 1.x迁移、API、配置、Web应用与JSP、插件、查找器、追加器、布局、过滤器、异步记录器、JMX管理、日志分离、扩展Log4j以及编程配置Log4j等多个方面，旨在帮助用户全面理解和使用Log4j 2框架。" Apache Log4j是Java平台上广泛使用的日志记录框架，Log4j 2作为其后续版本，提供了更多的功能和改进，以满足更高效、更灵活的日志处理需求。以下是对标题和描述中涉及的一些关键知识点的详细说明： 1. **架构**：Log4j 2的架构设计使其能够支持多种日志记录模式，包括同步和异步记录，同时也允许动态调整日志级别和配置。 2. **Log4j 1.x 迁移**：对于已经使用Log4j 1.x的项目，用户指南提供了详细的迁移指南，解释了如何平滑过渡到Log4j 2，包括API变化和配置文件的转换。 3. **API**：Log4j 2提供了新的API，如`org.apache.logging.log4j.Logger`，以提供更好的性能和更丰富的功能，比如异步记录器和自定义日志级别。 4. **配置**：Log4j 2支持XML、JSON、YAML和属性文件等多种配置格式，允许动态配置更改，增强了可配置性，用户可以通过配置文件定义日志输出的位置、格式、级别等。 5. **Web应用与JSPs**：Log4j 2可以轻松集成到Web应用中，对JSP页面的日志记录提供了支持，帮助开发者调试和监控Web应用。 6. **插件系统**：Log4j 2引入了插件机制，允许开发人员自定义追加器、布局和过滤器，以适应特定的日志需求。 7. **查找器（Lookups）**：查找器允许在配置中使用动态值，例如系统属性或环境变量，提高了配置的灵活性。 8. **追加器（Appenders）**：追加器负责将日志事件写入不同的输出目标，如文件、控制台、数据库或网络。 9. **布局（Layouts）**：布局定义了日志事件的输出格式，如简单文本、JSON或XML，便于分析和处理。 10. **过滤器（Filters）**：过滤器用于控制哪些日志事件被记录，可以根据日志级别、MDC（Mapped Diagnostic Context）、日志事件的属性等条件进行过滤。 11. **异步记录器（Async Loggers）**：异步记录器利用线程池提高日志记录性能，尤其在高并发场景下，能够显著减少日志处理对应用程序性能的影响。 12. **JMX管理**：通过JMX（Java Management Extensions），用户可以动态监控和修改Log4j 2的配置，实现运行时的日志管理。 13. **日志分离（Logging Separation）**：Log4j 2支持将不同模块或组件的日志分开，有助于组织和分析大量日志数据。 14. **扩展Log4j**：Log4j 2的设计使得其易于扩展，允许开发人员根据需要创建自定义组件，如新的追加器、过滤器等。 15. **编程配置Log4j**：除了配置文件，Log4j 2还允许通过代码动态创建和管理日志配置，提供更大的灵活性。 16. **自定义日志级别**：用户可以定义自己的日志级别，以满足特定的业务需求，扩展标准的日志级别系统。这个用户指南为Log4j 2的使用者提供了全面的参考资料，无论你是初学者还是经验丰富的开发者，都可以从中学习到如何有效利用Log4j 2来管理和优化你的日志系统。

3 L o g 4 j 1 . x M i g r a t i o n

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN" "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

</layout>

</appender>

</layout>

</appender>

<appender-ref ref="A1" />

</category>

<root>

<appender-ref ref="STDOUT" />

</Root>

</log4j:configuration>

Log4j 2 XML configuration

<?xml version="1.0" encoding="UTF-8"?>

</File>

</Console>

</Appenders>

</Logger>

</Root>

</Loggers>

</Configuration>

3.1.3.3 Sample 3 - SocketAppender

Log4j 1.x XML configuration. This example from Log4j 1.x is misleading. The SocketAppender does

not actually use a Layout. Configuring one will have no effect.

4 A P I

4 API

.......................................................................................................................................

4.1 Log4j 2 API

4.1.1 Overview

The Log4j 2 API provides the interface that applications should code to and provides the adapter

components required for implementers to create a logging implementation. Although Log4j 2 is

broken up between an API and an implementation, the primary purpose of doing so was not to allow

multiple implementations, although that is certainly possible, but to clearly define what classes and

methods are safe to use in "normal" application code.

4.1.1.1 Hello World!

No introduction would be complete without the customary Hello, World example. Here is ours. First,

a Logger with the name "HelloWorld" is obtained from the LogManager. Next, the logger is used

to write the "Hello, World!" message, however the message will be written only if the Logger is

configured to allow informational messages.

import org.apache.logging.log4j.LogManager;

import org.apache.logging.log4j.Logger;

public class HelloWorld {

private static final Logger logger = LogManager.getLogger("HelloWorld");

public static void main(String[] args) {

logger.info("Hello, World!");

}

The output from the call to logger.info() will vary significantly depending on the configuration used.

See the Configuration section for more details.

4.1.1.2 Substituting Parameters

Frequently the purpose of logging is to provide information about what is happening in the system,

which requires including information about the objects being manipulated. In Log4j 1.x this could be

accomplished by doing:

if (logger.isDebugEnabled()) {

logger.debug("Logging in user " + user.getName() + " with birthday " + user.getBirthdayCalendar());

}

Doing this repeatedly has the effect of making the code feel like it is more about logging than the

actual task at hand. In addition, it results in the logging level being checked twice; once on the call to

isDebugEnabled and once on the debug method. A better alternative would be:

logger.debug("Logging in user {} with birthday {}", user.getName(), user.getBirthdayCalendar());

With the code above the logging level will only be checked once and the String construction will only

occur when debug logging is enabled.

4.1.1.3 Formatting Parameters

Substituting parameters leaves formatting up to you if toString() is not what you want. To

facilitate formatting, you can use the same format strings as Java's Formatter. For example:

剩余211页未读，继续阅读

zlyHabib

粉丝: 0
资源: 5

Apache Log4j 2用户指南

log4j-users-guide 用户手册

log4j-user-guide

log4j-users-guide.pdf

nextgen-mirthconnect-39-user-guide(mirth3.9使用文档).pdf

log4j中文文档(对英语水平不高的编程者的绝对诱惑)

primefaces_users_guide_3_3.pdf

IMM User Guide

最新资源