com.taobao.middleware.logger.support

Class LoggerHelper

java.lang.Object

com.taobao.middleware.logger.support.LoggerHelper

public abstract class LoggerHelper
extends Object

Constructor Summary

Constructors

Constructor and Description
LoggerHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static void	activePrudent(Logger logger, boolean prudent) When prudent is set to true, file appenders from multiple JVMs can safely write to the same file.
static String	getErrorCodeStr(String errorCode) Deprecated.
static String	getErrorCodeStr(String productName, String errorCode, String errorType, String message) 根据productName获取统一格式的ErrorCode输出
static String	getLogFile(String productName, String fileName) 获取中间件产品日志路径 优先使用-DJM.LOG.PATH参数，且必须是绝对路径 其次是{user.home}/logs/ 比如hsf调用：LoggerHelper.getLogFile("hsf", "hsf.log")，则返回{user.home}/logs/hsf/hsf.log
static String	getLogFileP(String productName, String fileName)
static String	getLogpath() 获取中间件日志根目录，以File.separator结尾
static String	getPattern() 获取中间件日志特定格式
static String	getPattern(String productName) 获取中间件日志格式，优先使用用户产品自定义的格式，logback/log4j通用
static String	getResourceBundleString(String productName, String code) 获取国际化的message，如果找不到，则返回原始的code
static void	setPattern(String productName, String pattern) 设置特定中间件产品的日志格式，注意，这里的格式需要自己保证在 log4j/logback 下都兼容，框架不做校验，同时控制台输出仍会采用中间件的特定格式
static void	setResourceBundle(String productName, String bundleName) 设置产品的日志国际化properties文件

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LoggerHelper

public LoggerHelper()

Method Detail

getLogpath

public static String getLogpath()

获取中间件日志根目录，以File.separator结尾

getLogFile

public static String getLogFile(String productName,
                String fileName)

 获取中间件产品日志路径
 
 优先使用-DJM.LOG.PATH参数，且必须是绝对路径
 其次是{user.home}/logs/
 
 比如hsf调用：LoggerHelper.getLogFile("hsf", "hsf.log")，则返回{user.home}/logs/hsf/hsf.log
 

Parameters:

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

fileName - 日志文件名，如hsf.log，如需要二级子目录，可以传 subDir + File.separator + *.log

getPattern

public static String getPattern(String productName)

获取中间件日志格式，优先使用用户产品自定义的格式，logback/log4j通用

getPattern

public static String getPattern()

获取中间件日志特定格式

setPattern

public static void setPattern(String productName,
              String pattern)

设置特定中间件产品的日志格式，注意，这里的格式需要自己保证在 log4j/logback 下都兼容，框架不做校验，同时控制台输出仍会采用中间件的特定格式

Parameters:

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

pattern - 日志格式

setResourceBundle

public static void setResourceBundle(String productName,
                     String bundleName)

设置产品的日志国际化properties文件

Parameters:

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

bundleName - bundleName

getResourceBundleString

public static String getResourceBundleString(String productName,
                             String code)

获取国际化的message，如果找不到，则返回原始的code

Parameters:

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

code - code

getErrorCodeStr

@Deprecated
public static String getErrorCodeStr(String errorCode)

Deprecated.

获取统一格式的ErrorCode输出

Parameters:

errorCode -

getErrorCodeStr

public static String getErrorCodeStr(String productName,
                     String errorCode,
                     String errorType,
                     String message)

根据productName获取统一格式的ErrorCode输出

Parameters:

productName - 如 HSF，会根据 HSF.ErrorCodeMoreUrl 从 System属性中获取 more url 前缀，如http://console.taobao.net/jm/

errorCode - 错误码，如HSF-001

errorType - 错误类型

message - 出错异常信息

getLogFileP

public static String getLogFileP(String productName,
                 String fileName)

activePrudent

public static void activePrudent(Logger logger,
                 boolean prudent)

When prudent is set to true, file appenders from multiple JVMs can safely write to the same file. Only support by logback

Parameters:

prudent -

Since:

0.1.8