com.taobao.middleware.logger.option

Interface ActivateOption

All Known Subinterfaces:

Logger

All Known Implementing Classes:

AbstractActiveOption, Log4j2ActivateOption, Log4j2Logger, Log4jActivateOption, Log4jLogger, Logback918ActivateOption, LogbackActivateOption, LoggerSupport, NopLogger, Slf4jLog4j2AdapterActivateOption, Slf4jLog4jAdapterActivateOption, Slf4jLogger

public interface ActivateOption

 激活Logger的选项，包括：
 Appender/Layout
 Level
 Additivity
 Aysnc
 请参考具体的实现逻辑
 

Author:

zhuyong 2014年3月20日 上午10:20:51

Method Summary

Methods

Modifier and Type	Method and Description
void	activateAppender(Logger logger) 使用logger对象的appender来初始化当前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) Deprecated.
void	activateAsyncAppender(String productName, String file, String encoding, int queueSize, int discardingThreshold) Deprecated.
void	activateConsoleAppender(String target, String encoding) 设置ConsoleAppender，生产环境慎用
Level	getLevel() 获取日志级别
String	getProductName() 获取所属的产品名
void	setAdditivity(boolean additivity) 设置日志是否Attach到Parent
void	setLevel(Level level) 设置日志级别

Method Detail

activateConsoleAppender

void activateConsoleAppender(String target,
                           String encoding)

设置ConsoleAppender，生产环境慎用

Parameters:

target - System.out or System.err

encoding - 编码

activateAppender

void activateAppender(String productName,
                    String file,
                    String encoding)

设置FileAppender，日志按天回滚

Parameters:

productName - 中间件产品名，如hsf, tddl

file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log

encoding - 编码

activateAsyncAppender

@Deprecated
void activateAsyncAppender(String productName,
                                    String file,
                                    String encoding)

Deprecated.

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

Parameters:

productName - 中间件产品名，如hsf, tddl

file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log

encoding - 编码

activateAsyncAppender

@Deprecated
void activateAsyncAppender(String productName,
                                    String file,
                                    String encoding,
                                    int queueSize,
                                    int discardingThreshold)

Deprecated.

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

Parameters:

productName - 中间件产品名，如hsf, tddl

file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log

encoding - 编码

queueSize - 等待队列大小

discardingThreshold - discardingThreshold，该参数仅对logback实现有效，log4j和log4j2无效

activateAppenderWithTimeAndSizeRolling

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

设置按天和文件大小回滚

Parameters:

productName - 中间件产品名，如hsf, tddl

file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log

encoding - 编码

size - 文件大小，如300MB，支持KB，MB，GB，该参数对log4j实现不生效，log4j2和logback有效

activateAppenderWithTimeAndSizeRolling

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

 设置按日期格式和文件大小回滚
 说明：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

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开始
 

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

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
 

Parameters:

productName - 中间件产品名，如hsf, tddl

file - 日志文件名，如hsf.log，支持子目录，如client/hsf.log

encoding - 编码

size - 文件大小，如300MB，支持KB，MB，GB

maxBackupIndex - 最大备份文件数，如10

activateAsync

void activateAsync(int queueSize,
                 int discardingThreshold)

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

Parameters:

queueSize - 等待队列大小

discardingThreshold - discardingThreshold，该参数仅对logback实现有效，log4j和log4j2无效

Since:

0.2.2

activateAsync

void activateAsync(List<Object[]> args)

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

Parameters:

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

Since:

0.2.3

activateAppender

void activateAppender(Logger logger)

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

Parameters:

logger -

setLevel

void setLevel(Level level)

设置日志级别

Parameters:

level - 日志级别

See Also:

Level

getLevel

Level getLevel()

获取日志级别

setAdditivity

void setAdditivity(boolean additivity)

设置日志是否Attach到Parent

Parameters:

additivity - true or false

getProductName

String getProductName()

获取所属的产品名