com.alibaba.csp.sentinel.log

Class LogBase

java.lang.Object

com.alibaba.csp.sentinel.log.LogBase

Direct Known Subclasses:

CommandCenterLog, RecordLog

public class LogBase
extends Object

The base class for logging.

The default log base directory is ${user.home}/logs/csp/. We can use the LOG_DIR property to override it. The default log file name dose not contain pid, but if multi-instances of the same service are running in the same machine, we may want to distinguish the log file by process ID number. In this case, LOG_NAME_USE_PID property could be configured as "true" to turn on this switch.

Author:

leyou

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOG_CHARSET
static String	LOG_CHARSET_UTF8
static String	LOG_DIR
static String	LOG_NAME_USE_PID
static String	LOG_OUTPUT_TYPE
static String	LOG_OUTPUT_TYPE_CONSOLE Output biz log (e.g.
static String	LOG_OUTPUT_TYPE_FILE Output biz log (e.g.

Constructor Summary

Constructors

Constructor and Description
LogBase()

Method Summary

Modifier and Type	Method and Description
static String	getLogBaseDir() Get the log file base directory path, which is guaranteed ended with File.separator.
static String	getLogCharset() Get the log file charset.
static String	getLogOutputType() Get the log file output type.
static boolean	isLogNameUsePid() Whether log file name should contain pid.
protected static void	log(Logger logger, Handler handler, Level level, String detail, Object... params)
protected static void	log(Logger logger, Handler handler, Level level, String detail, Throwable throwable)
protected static Handler	makeLogger(String logName, Logger heliumRecordLog)

Methods inherited from class java.lang.Object

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

Field Detail

LOG_DIR

public static final String LOG_DIR

See Also:

Constant Field Values

LOG_NAME_USE_PID

public static final String LOG_NAME_USE_PID

See Also:

Constant Field Values

LOG_OUTPUT_TYPE

public static final String LOG_OUTPUT_TYPE

See Also:

Constant Field Values

LOG_CHARSET

public static final String LOG_CHARSET

See Also:

Constant Field Values

LOG_OUTPUT_TYPE_FILE

public static final String LOG_OUTPUT_TYPE_FILE

Output biz log (e.g. RecordLog and CommandCenterLog) to file.

See Also:

Constant Field Values

LOG_OUTPUT_TYPE_CONSOLE

public static final String LOG_OUTPUT_TYPE_CONSOLE

Output biz log (e.g. RecordLog and CommandCenterLog) to console.

See Also:

Constant Field Values

LOG_CHARSET_UTF8

public static final String LOG_CHARSET_UTF8

See Also:

Constant Field Values

Constructor Detail

LogBase

public LogBase()

Method Detail

isLogNameUsePid

public static boolean isLogNameUsePid()

Whether log file name should contain pid. This switch is configured by LOG_NAME_USE_PID system property.

Returns:

true if log file name should contain pid, return true, otherwise false

getLogBaseDir

public static String getLogBaseDir()

Get the log file base directory path, which is guaranteed ended with File.separator.

Returns:

log file base directory path

getLogOutputType

public static String getLogOutputType()

Get the log file output type.

Returns:

log output type, "file" by default

getLogCharset

public static String getLogCharset()

Get the log file charset.

Returns:

the log file charset, "utf-8" by default

log

protected static void log(Logger logger,
                          Handler handler,
                          Level level,
                          String detail,
                          Object... params)

log

protected static void log(Logger logger,
                          Handler handler,
                          Level level,
                          String detail,
                          Throwable throwable)

makeLogger

protected static Handler makeLogger(String logName,
                                    Logger heliumRecordLog)