com.att.eelf.configuration

Interface EELFLogger

All Known Implementing Classes:

SLF4jWrapper

public interface EELFLogger

The EELFLogger is the main interface to access loggers in EELF.

It defines the convenience methods that are available to the application to log messages based on the string or a key in the resource bundle(s).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EELFLogger.Level

Method Summary

Modifier and Type	Method and Description
void	applicationEvent(EELFLogger.Level level, String msg, Object... arguments) Log an application event using application logger at a given level.
void	applicationEvent(String msg, Object... arguments) Log an application event using application logger at info.
void	auditEvent(EELFLogger.Level level, String msg, Object... arguments) Log a audit event using audit logger at given level.
void	auditEvent(String msg, Object... arguments) Log a audit event using audit logger at info level.
void	debug(EELFResolvableErrorEnum errorCode, String... args) Log a debug message based on message key as defined in resource bundle with arguments.
void	debug(EELFResolvableErrorEnum errorCode, Throwable th, String... args) Log a debug message based on message key as defined in resource bundle along with exception.
void	debug(Locale locale, EELFResolvableErrorEnum errorCode, String... args) Log a debug message based on message key as defined in resource bundle for the given locale.
void	debug(Locale locale, EELFResolvableErrorEnum errorCode, Throwable th, String... args) Log a debug message based on message key as defined in resource bundle for the given locale along with exception.
void	debug(String msg) Log a debug message, with no arguments.
void	debug(String msg, Object... arguments) Log a debug message, with arguments.
void	debug(String msg, Throwable th) Log a exception at debug level.
void	disableLogging() Turn off the logging for the logger
void	error(EELFResolvableErrorEnum errorCode, String... args) Log a error message based on message key as defined in resource bundle with arguments.
void	error(EELFResolvableErrorEnum errorCode, Throwable th, String... args) Log a error message based on message key as defined in resource bundle along with exception.
void	error(Locale locale, EELFResolvableErrorEnum errorCode, String... args) Log a error message based on message key as defined in resource bundle for the given locale.
void	error(Locale locale, EELFResolvableErrorEnum errorCode, Throwable th, String... args) Log a error message based on message key as defined in resource bundle for the given locale along with exception.
void	error(String msg) Log a error message, with no arguments.
void	error(String msg, Object... arguments) Log a error message, with arguments.
void	error(String msg, Throwable th) Log a exception at error level.
void	info(EELFResolvableErrorEnum errorCode, String... args) Log a info message based on message key as defined in resource bundle with arguments.
void	info(EELFResolvableErrorEnum errorCode, Throwable th, String... args) Log a info message based on message key as defined in resource bundle along with exception.
void	info(Locale locale, EELFResolvableErrorEnum errorCode, String... args) Log a info message based on message key as defined in resource bundle for the given locale.
void	info(Locale locale, EELFResolvableErrorEnum errorCode, Throwable th, String... args) Log a info message based on message key as defined in resource bundle for the given locale along with exception.
void	info(String msg) Log a info message, with no arguments.
void	info(String msg, Object... arguments) Log a info message, with arguments.
boolean	isDebugEnabled() Checks if the debug is enabled for the logger
boolean	isErrorEnabled() Checks if the error is enabled for the logger
boolean	isInfoEnabled() Checks if the info is enabled for the logger
boolean	isTraceEnabled() Checks if the trace is enabled for the logger
boolean	isWarnEnabled() Checks if the warn is enabled for the logger
void	log(EELFLogger.Level level, String msg, Throwable th, Object... arguments) Log a message or exception with arguments if the argument list is provided
void	metricsEvent(EELFLogger.Level level, String msg, Object... arguments) Log a metrics event using metrics logger at info level at given level.
void	metricsEvent(String msg, Object... arguments) Log a metrics event using metrics logger at info level.
void	performanceEvent(EELFLogger.Level level, String msg, Object... arguments) Log a performance event using performance logger at a given level.
void	performanceEvent(String msg, Object... arguments) Log a performance event using performance logger at info level.
void	policyEvent(EELFLogger.Level level, String msg, Object... arguments) Log a policy event using policy logger at a given level.
void	policyEvent(String msg, Object... arguments) Log a policy event using policy logger at info level.
void	securityEvent(EELFLogger.Level level, String msg, Object... arguments) Log a security event using security logger at given level.
void	securityEvent(String msg, Object... arguments) Log a security event using security logger at info level.
void	serverEvent(EELFLogger.Level level, String msg, Object... arguments) Log a server event using server logger at a given level.
void	serverEvent(String msg, Object... arguments) Log a server event using server logger at info level.
void	setLevel(EELFLogger.Level level) Change the logging level for the logger
void	trace(EELFResolvableErrorEnum errorCode, String... args) Log a trace message based on message key as defined in resource bundle with arguments.
void	trace(EELFResolvableErrorEnum errorCode, Throwable th, String... args) Log a trace message based on message key as defined in resource bundle along with exception.
void	trace(Locale locale, EELFResolvableErrorEnum errorCode, String... args) Log a trace message based on message key as defined in resource bundle for the given locale.
void	trace(Locale locale, EELFResolvableErrorEnum errorCode, Throwable th, String... args) Log a trace message based on message key as defined in resource bundle for the given locale along with exception.
void	trace(String msg) Log a trace message, with no arguments.
void	trace(String msg, Object... arguments) Log a trace message, with arguments.
void	trace(String msg, Throwable th) Log a exception at trace level.
void	warn(EELFResolvableErrorEnum errorCode, String... args) Log a warn message based on message key as defined in resource bundle with arguments.
void	warn(EELFResolvableErrorEnum errorCode, Throwable th, String... args) Log a warn message based on message key as defined in resource bundle along with exception.
void	warn(Locale locale, EELFResolvableErrorEnum errorCode, String... args) Log a warn message based on message key as defined in resource bundle for the given locale.
void	warn(Locale locale, EELFResolvableErrorEnum errorCode, Throwable th, String... args) Log a warn message based on message key as defined in resource bundle for the given locale along with exception.
void	warn(String msg) Log a warn message, with no arguments.
void	warn(String msg, Object... arguments) Log a warn message, with arguments.
void	warn(String msg, Throwable th) Log a exception at warn level.

Method Detail

warn

void warn(String msg)

Log a warn message, with no arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message

warn

void warn(String msg,
          Object... arguments)

Log a warn message, with arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message

arguments - The list of arguments

warn

void warn(String msg,
          Throwable th)

Log a exception at warn level.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message

th - The exception object

debug

void debug(String msg)

Log a debug message, with no arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message

debug

void debug(String msg,
           Object... arguments)

Log a debug message, with arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message

arguments - The list of arguments

debug

void debug(String msg,
           Throwable th)

Log a exception at debug level.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message

th - The exception object

info

void info(String msg)

Log a info message, with no arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message

info

void info(String msg,
          Object... arguments)

Log a info message, with arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message

arguments - The list of arguments

trace

void trace(String msg)

Log a trace message, with no arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message

trace

void trace(String msg,
           Object... arguments)

Log a trace message, with arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message

arguments - The list of arguments

trace

void trace(String msg,
           Throwable th)

Log a exception at trace level.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message

th - The exception object

error

void error(String msg)

Log a error message, with no arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message

error

void error(String msg,
           Object... arguments)

Log a error message, with arguments.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message

arguments - The list of arguments

error

void error(String msg,
           Throwable th)

Log a exception at error level.

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

msg - The string message

th - The exception object

isTraceEnabled

boolean isTraceEnabled()

Checks if the trace is enabled for the logger

isInfoEnabled

boolean isInfoEnabled()

Checks if the info is enabled for the logger

isErrorEnabled

boolean isErrorEnabled()

Checks if the error is enabled for the logger

isWarnEnabled

boolean isWarnEnabled()

Checks if the warn is enabled for the logger

isDebugEnabled

boolean isDebugEnabled()

Checks if the debug is enabled for the logger

log

void log(EELFLogger.Level level,
         String msg,
         Throwable th,
         Object... arguments)

Log a message or exception with arguments if the argument list is provided

If the logger is currently enabled for the given message level then the given message is forwarded to all the registered output Handler objects.

Parameters:

level - One of the message level identifiers, e.g., SEVERE

msg - The string message

th - The exception object

arguments - The list of arguments

auditEvent

void auditEvent(String msg,
                Object... arguments)

Log a audit event using audit logger at info level.

Parameters:

msg - The string message

arguments - The list of arguments

auditEvent

void auditEvent(EELFLogger.Level level,
                String msg,
                Object... arguments)

Log a audit event using audit logger at given level.

Parameters:

level - One of the message level identifiers, e.g., WARN

msg - The string message

arguments - The list of arguments

metricsEvent

void metricsEvent(String msg,
                  Object... arguments)

Log a metrics event using metrics logger at info level.

Parameters:

msg -

arguments -

metricsEvent

void metricsEvent(EELFLogger.Level level,
                  String msg,
                  Object... arguments)

Log a metrics event using metrics logger at info level at given level.

Parameters:

level - One of the message level identifiers, e.g., WARN

msg - The string message

arguments - The list of arguments

securityEvent

void securityEvent(String msg,
                   Object... arguments)

Log a security event using security logger at info level.

Parameters:

msg -

arguments -

securityEvent

void securityEvent(EELFLogger.Level level,
                   String msg,
                   Object... arguments)

Log a security event using security logger at given level.

Parameters:

level -

msg -

arguments -

performanceEvent

void performanceEvent(String msg,
                      Object... arguments)

Log a performance event using performance logger at info level.

Parameters:

msg -

arguments -

performanceEvent

void performanceEvent(EELFLogger.Level level,
                      String msg,
                      Object... arguments)

Log a performance event using performance logger at a given level.

Parameters:

level -

msg -

arguments -

applicationEvent

void applicationEvent(String msg,
                      Object... arguments)

Log an application event using application logger at info.

Parameters:

msg -

arguments -

applicationEvent

void applicationEvent(EELFLogger.Level level,
                      String msg,
                      Object... arguments)

Log an application event using application logger at a given level.

Parameters:

level -

msg -

arguments -

serverEvent

void serverEvent(String msg,
                 Object... arguments)

Log a server event using server logger at info level.

Parameters:

msg -

arguments -

serverEvent

void serverEvent(EELFLogger.Level level,
                 String msg,
                 Object... arguments)

Log a server event using server logger at a given level.

Parameters:

level -

arguments -

policyEvent

void policyEvent(String msg,
                 Object... arguments)

Log a policy event using policy logger at info level.

Parameters:

msg -

arguments -

policyEvent

void policyEvent(EELFLogger.Level level,
                 String msg,
                 Object... arguments)

Log a policy event using policy logger at a given level.

Parameters:

level -

msg -

arguments -

warn

void warn(Locale locale,
          EELFResolvableErrorEnum errorCode,
          Throwable th,
          String... args)

Log a warn message based on message key as defined in resource bundle for the given locale along with exception.

Parameters:

locale -

errorCode -

th -

args -

info

void info(Locale locale,
          EELFResolvableErrorEnum errorCode,
          Throwable th,
          String... args)

Log a info message based on message key as defined in resource bundle for the given locale along with exception.

Parameters:

locale -

errorCode -

th -

args -

debug

void debug(Locale locale,
           EELFResolvableErrorEnum errorCode,
           Throwable th,
           String... args)

Log a debug message based on message key as defined in resource bundle for the given locale along with exception.

Parameters:

locale -

errorCode -

th -

args -

error

void error(Locale locale,
           EELFResolvableErrorEnum errorCode,
           Throwable th,
           String... args)

Log a error message based on message key as defined in resource bundle for the given locale along with exception.

Parameters:

locale -

errorCode -

th -

args -

trace

void trace(Locale locale,
           EELFResolvableErrorEnum errorCode,
           Throwable th,
           String... args)

Log a trace message based on message key as defined in resource bundle for the given locale along with exception.

Parameters:

locale -

errorCode -

th -

args -

warn

void warn(Locale locale,
          EELFResolvableErrorEnum errorCode,
          String... args)

Log a warn message based on message key as defined in resource bundle for the given locale.

Parameters:

locale -

errorCode -

args -

info

void info(Locale locale,
          EELFResolvableErrorEnum errorCode,
          String... args)

Log a info message based on message key as defined in resource bundle for the given locale.

Parameters:

locale -

errorCode -

args -

debug

void debug(Locale locale,
           EELFResolvableErrorEnum errorCode,
           String... args)

Log a debug message based on message key as defined in resource bundle for the given locale.

Parameters:

locale -

errorCode -

args -

error

void error(Locale locale,
           EELFResolvableErrorEnum errorCode,
           String... args)

Log a error message based on message key as defined in resource bundle for the given locale.

Parameters:

locale -

errorCode -

args -

trace

void trace(Locale locale,
           EELFResolvableErrorEnum errorCode,
           String... args)

Log a trace message based on message key as defined in resource bundle for the given locale.

Parameters:

locale -

errorCode -

args -

warn

void warn(EELFResolvableErrorEnum errorCode,
          String... args)

Log a warn message based on message key as defined in resource bundle with arguments.

Parameters:

errorCode -

args -

info

void info(EELFResolvableErrorEnum errorCode,
          String... args)

Log a info message based on message key as defined in resource bundle with arguments.

Parameters:

errorCode -

args -

debug

void debug(EELFResolvableErrorEnum errorCode,
           String... args)

Log a debug message based on message key as defined in resource bundle with arguments.

Parameters:

errorCode -

args -

error

void error(EELFResolvableErrorEnum errorCode,
           String... args)

Log a error message based on message key as defined in resource bundle with arguments.

Parameters:

errorCode -

args -

trace

void trace(EELFResolvableErrorEnum errorCode,
           String... args)

Log a trace message based on message key as defined in resource bundle with arguments.

Parameters:

errorCode -

args -

warn

void warn(EELFResolvableErrorEnum errorCode,
          Throwable th,
          String... args)

Log a warn message based on message key as defined in resource bundle along with exception.

Parameters:

errorCode -

th -

args -

info

void info(EELFResolvableErrorEnum errorCode,
          Throwable th,
          String... args)

Log a info message based on message key as defined in resource bundle along with exception.

Parameters:

errorCode -

th -

args -

debug

void debug(EELFResolvableErrorEnum errorCode,
           Throwable th,
           String... args)

Log a debug message based on message key as defined in resource bundle along with exception.

Parameters:

errorCode -

th -

args -

error

void error(EELFResolvableErrorEnum errorCode,
           Throwable th,
           String... args)

Log a error message based on message key as defined in resource bundle along with exception.

Parameters:

errorCode -

th -

args -

trace

void trace(EELFResolvableErrorEnum errorCode,
           Throwable th,
           String... args)

Log a trace message based on message key as defined in resource bundle along with exception.

Parameters:

errorCode -

th -

args -

setLevel

void setLevel(EELFLogger.Level level)

Change the logging level for the logger

Parameters:

level -

disableLogging

void disableLogging()

Turn off the logging for the logger