Log4j2ActivateOption (Taobao Middleware Logger API 0.2.0 API)

java.lang.Object
- com.taobao.middleware.logger.option.AbstractActiveOption
- - com.taobao.middleware.logger.option.Log4j2ActivateOption

All Implemented Interfaces:

ActivateOption

Direct Known Subclasses:

Slf4jLog4j2AdapterActivateOption
```
public class Log4j2ActivateOption
extends AbstractActiveOption
```
Author:

zhuyong on 2017/4/13.

Field Summary

Fields
Modifier and Type Field and Description

protected org.apache.logging.log4j.core.config.Configuration configuration

protected org.apache.logging.log4j.core.Logger logger
- Fields inherited from class com.taobao.middleware.logger.option.AbstractActiveOption
  level, productName

Fields
Modifier and Type	Field and Description
`protected org.apache.logging.log4j.core.config.Configuration`	`configuration`
`protected org.apache.logging.log4j.core.Logger`	`logger`

Constructor Summary

Constructors
Constructor and Description

Log4j2ActivateOption(org.apache.logging.log4j.Logger logger)

Constructors
Constructor and Description
`Log4j2ActivateOption(org.apache.logging.log4j.Logger logger)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`activateAppender(Logger logger)` 使用logger对象的appender来初始化当前logger
`protected void`	`activateAppender(org.apache.logging.log4j.core.Logger logger)`
`void`	`activateAppender(String productName, String file, String encoding)` 设置FileAppender，日志按天回滚
`void`	`activateAppenderWithSizeRolling(String productName, String file, String encoding, String size, int maxBackupIndex)` 设置按文件大小、最大备份文件数回滚说明： 1、Log4j 备份文件数 maxBackupIndex 参数必须是 >= 0 的整数，为0时表示直接截断，不备份 2、备份日志格式说明： Log4j：notify.log.1, notify.log.2，即备份文件以 .1 .2结尾，序号从1开始 Logback: notify.log.1， notify.log.1
`void`	`activateAppenderWithTimeAndSizeRolling(String productName, String file, String encoding, String size)` 设置按天和文件大小回滚
`void`	`activateAppenderWithTimeAndSizeRolling(String productName, String file, String encoding, String size, String datePattern)` 设置按日期格式和文件大小回滚说明：Log4j 对日期格式不生效，只有按大小回滚，同时不支持备份文件，即达到文件大小直接截断，如果需要备份文件，请参考带 maxBackupIndex 参数的方法
`void`	`activateAppenderWithTimeAndSizeRolling(String productName, String file, String encoding, String size, String datePattern, int maxBackupIndex)` 设置按日期格式、文件大小、最大备份文件数回滚说明： 1、Log4j 对日期格式不生效，只有按大小、备份文件数回滚，备份文件数 maxBackupIndex 参数必须是 >= 0 的整数，为0时表示直接截断，不备份 2、备份日志格式说明： Log4j：notify.log.1, notify.log.2，即备份文件以 .1 .2结尾，序号从1开始 Logback: notify.log.2014-09-19.0， notify.log.2014-09-19.1，即中间会带日期格式，同时序号从0开始
`void`	`activateAsync(int queueSize, int discardingThreshold)` 将当前logger对象的appender设置为异步Appender 注意：此logger需要提前进行Appender的初始化
`void`	`activateAsync(List<Object[]> args)` 将当前logger对象的appender设置为异步Appender 注意：此logger需要提前进行Appender的初始化
`void`	`activateAsyncAppender(String productName, String file, String encoding)` 设置AsyncAppender，内嵌DailyRollingFileAppender，日志按天回滚，参考 `ActivateOption.activateAsync(int, int)`
`void`	`activateAsyncAppender(String productName, String file, String encoding, int queueSize, int discardingThreshold)` 设置AsyncAppender，内嵌DailyRollingFileAppender，日志按天回滚，参考 `ActivateOption.activateAsync(int, int)`
`void`	`activateConsoleAppender(String target, String encoding)` 设置ConsoleAppender，生产环境慎用
`protected org.apache.logging.log4j.core.Layout`	`buildLayout(String encoding)`
`protected void`	`removeAllAppenders(org.apache.logging.log4j.core.Logger logger)`
`void`	`setAdditivity(boolean additivity)` 设置日志是否Attach到Parent
`void`	`setLevel(Level level)` 设置日志级别

Methods inherited from class com.taobao.middleware.logger.option.AbstractActiveOption
getLevel, getProductName, invokeMethod, setProductName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected org.apache.logging.log4j.core.Logger logger

configuration

protected org.apache.logging.log4j.core.config.Configuration configuration

Constructor Detail

Log4j2ActivateOption

public Log4j2ActivateOption(org.apache.logging.log4j.Logger logger)

Method Detail

activateConsoleAppender
```
public void activateConsoleAppender(String target,
                           String encoding)
```
Description copied from interface: ActivateOption

设置ConsoleAppender，生产环境慎用

Parameters:
target - System.out or System.err
encoding - 编码

activateAppender
```
public void activateAppender(String productName,
                    String file,
                    String encoding)
```
Description copied from interface: ActivateOption

设置FileAppender，日志按天回滚

Parameters:
productName - 中间件产品名，如hsf, tddl
file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log
encoding - 编码

activateAsyncAppender
```
public void activateAsyncAppender(String productName,
                         String file,
                         String encoding)
```
Description copied from interface: ActivateOption

设置AsyncAppender，内嵌DailyRollingFileAppender，日志按天回滚，参考 ActivateOption.activateAsync(int, int)

Parameters:
productName - 中间件产品名，如hsf, tddl
file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log
encoding - 编码

activateAsyncAppender
```
public void activateAsyncAppender(String productName,
                         String file,
                         String encoding,
                         int queueSize,
                         int discardingThreshold)
```
Description copied from interface: ActivateOption

设置AsyncAppender，内嵌DailyRollingFileAppender，日志按天回滚，参考 ActivateOption.activateAsync(int, int)

Parameters:
productName - 中间件产品名，如hsf, tddl
file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log
encoding - 编码
queueSize - 等待队列大小
discardingThreshold - discardingThreshold，该参数仅对logback实现有效，log4j和log4j2无效

activateAppenderWithTimeAndSizeRolling

public void activateAppenderWithTimeAndSizeRolling(String productName,
                                          String file,
                                          String encoding,
                                          String size)

Description copied from interface: ActivateOption

设置按天和文件大小回滚

Parameters:: productName - 中间件产品名，如hsf, tddl; file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log; encoding - 编码; size - 文件大小，如300MB，支持KB，MB，GB，该参数对log4j实现不生效，log4j2和logback有效

activateAppenderWithTimeAndSizeRolling

public void activateAppenderWithTimeAndSizeRolling(String productName,
                                          String file,
                                          String encoding,
                                          String size,
                                          String datePattern)

Description copied from interface: ActivateOption

 设置按日期格式和文件大小回滚
 说明：Log4j 对日期格式不生效，只有按大小回滚，同时不支持备份文件，即达到文件大小直接截断，如果需要备份文件，请参考带 maxBackupIndex 参数的方法

Parameters:: productName - 中间件产品名，如hsf, tddl; file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log; encoding - 编码; size - 文件大小，如300MB，支持KB，MB，GB; datePattern - 日期格式，如yyyy-MM-dd 或 yyyy-MM，请自行保证格式正确，该参数对log4j实现不生效，log4j2和logback有效

activateAppenderWithTimeAndSizeRolling

public void activateAppenderWithTimeAndSizeRolling(String productName,
                                          String file,
                                          String encoding,
                                          String size,
                                          String datePattern,
                                          int maxBackupIndex)

Description copied from interface: ActivateOption

 设置按日期格式、文件大小、最大备份文件数回滚
 说明：
 1、Log4j 对日期格式不生效，只有按大小、备份文件数回滚，备份文件数 maxBackupIndex 参数必须是 >= 0 的整数，为0时表示直接截断，不备份
 2、备份日志格式说明：
     Log4j：notify.log.1, notify.log.2，即备份文件以 .1 .2结尾，序号从1开始
     Logback: notify.log.2014-09-19.0， notify.log.2014-09-19.1，即中间会带日期格式，同时序号从0开始

Parameters:: productName - 中间件产品名，如hsf, tddl; file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log; encoding - 编码; size - 文件大小，如300MB，支持KB，MB，GB; datePattern - 日期格式，如yyyy-MM-dd 或 yyyy-MM，请自行保证格式正确，该参数对log4j实现不生效，log4j2和logback有效; maxBackupIndex - 最大备份文件数，如10（对于 Logback，则是保留10天的文件，但是这10天内的文件则会按大小回滚）

activateAppenderWithSizeRolling

public void activateAppenderWithSizeRolling(String productName,
                                   String file,
                                   String encoding,
                                   String size,
                                   int maxBackupIndex)

Description copied from interface: ActivateOption

 设置按文件大小、最大备份文件数回滚
 说明：
 1、Log4j 备份文件数 maxBackupIndex 参数必须是 >= 0 的整数，为0时表示直接截断，不备份
 2、备份日志格式说明：
     Log4j：notify.log.1, notify.log.2，即备份文件以 .1 .2结尾，序号从1开始
     Logback: notify.log.1， notify.log.1

Parameters:: productName - 中间件产品名，如hsf, tddl; file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log; encoding - 编码; size - 文件大小，如300MB，支持KB，MB，GB; maxBackupIndex - 最大备份文件数，如10

activateAsync
```
public void activateAsync(int queueSize,
                 int discardingThreshold)
```
Description copied from interface: ActivateOption

将当前logger对象的appender设置为异步Appender 注意：此logger需要提前进行Appender的初始化

Parameters:
queueSize - 等待队列大小
discardingThreshold - discardingThreshold，该参数仅对logback实现有效，log4j和log4j2无效

activateAsync
```
public void activateAsync(List<Object[]> args)
```
Description copied from interface: ActivateOption

将当前logger对象的appender设置为异步Appender 注意：此logger需要提前进行Appender的初始化

Parameters:
args - AsyncAppender配置参数，请自行保证参数的正确性，要求每个Object[]有3个元素，第一个为set方法名，第二个为方法类型数组，第三个为对应的参数值，如 args.add(new Object[] { "setBufferSize", new Class[] { int.class }, queueSize });

activateAppender
```
public void activateAppender(Logger logger)
```
Description copied from interface: ActivateOption

使用logger对象的appender来初始化当前logger

activateAppender

protected void activateAppender(org.apache.logging.log4j.core.Logger logger)

setLevel
```
public void setLevel(Level level)
```
Description copied from interface: ActivateOption

设置日志级别

Parameters:
level - 日志级别
See Also:
Level

setAdditivity
```
public void setAdditivity(boolean additivity)
```
Description copied from interface: ActivateOption

设置日志是否Attach到Parent

Parameters:
additivity - true or false

buildLayout

protected org.apache.logging.log4j.core.Layout buildLayout(String encoding)

removeAllAppenders

protected void removeAllAppenders(org.apache.logging.log4j.core.Logger logger)

Class Log4j2ActivateOption

Field Summary

Fields inherited from class com.taobao.middleware.logger.option.AbstractActiveOption

Constructor Summary

Method Summary

Methods inherited from class com.taobao.middleware.logger.option.AbstractActiveOption

Methods inherited from class java.lang.Object

Field Detail

logger

configuration

Constructor Detail

Log4j2ActivateOption

Method Detail

activateConsoleAppender

activateAppender

activateAsyncAppender

activateAsyncAppender

activateAppenderWithTimeAndSizeRolling

activateAppenderWithTimeAndSizeRolling

activateAppenderWithTimeAndSizeRolling

activateAppenderWithSizeRolling

activateAsync

activateAsync

activateAppender

activateAppender

setLevel

setAdditivity

buildLayout

removeAllAppenders