com.att.eelf.configuration

Interface EELFLogger

All Superinterfaces:

org.slf4j.Logger

All Known Implementing Classes:

AbstractEELFLogger, LogbackEELFLogger, SLF4jWrapper

public interface EELFLogger
extends org.slf4j.Logger

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

Field Summary

Fields inherited from interface org.slf4j.Logger

ROOT_LOGGER_NAME

Method Summary

Modifier and Type	Method and Description
void	applicationEvent(EELFLogger.Level level, String msg, Object... arguments) Deprecated.
void	applicationEvent(String msg, Object... arguments) Deprecated.
void	auditEvent(EELFLogger.Level level, String msg, Object... arguments) Deprecated.
void	auditEvent(String msg, Object... arguments) Deprecated.
void	debug(EELFResolvableResourceEnum resource, String... arguments) Log a debug message based on message key as defined in resource bundle with arguments.
void	debug(EELFResolvableResourceEnum resource, Throwable th, String... arguments) Log a debug message based on message key as defined in resource bundle along with exception.
void	debug(Locale locale, EELFResolvableResourceEnum resource, String... arguments) Log a debug message based on message key as defined in resource bundle for the given locale.
void	debug(Locale locale, EELFResolvableResourceEnum resource, Throwable th, String... arguments) Log a debug message based on message key as defined in resource bundle for the given locale along with exception.
void	disableLogging() Turn off the logging for the logger
void	error(EELFResolvableResourceEnum resource, String... arguments) Log a error message based on message key as defined in resource bundle with arguments.
void	error(EELFResolvableResourceEnum resource, Throwable th, String... arguments) Log a error message based on message key as defined in resource bundle along with exception.
void	error(Locale locale, EELFResolvableResourceEnum resource, String... arguments) Log a error message based on message key as defined in resource bundle for the given locale.
void	error(Locale locale, EELFResolvableResourceEnum resource, Throwable th, String... arguments) Log a error message based on message key as defined in resource bundle for the given locale along with exception.
void	info(EELFResolvableResourceEnum resource, String... arguments) Log a info message based on message key as defined in resource bundle with arguments.
void	info(EELFResolvableResourceEnum resource, Throwable th, String... arguments) Log a info message based on message key as defined in resource bundle along with exception.
void	info(Locale locale, EELFResolvableResourceEnum resource, String... arguments) Log a info message based on message key as defined in resource bundle for the given locale.
void	info(Locale locale, EELFResolvableResourceEnum resource, Throwable th, String... arguments) Log a info message based on message key as defined in resource bundle for the given locale along with exception.
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) Deprecated.
void	metricsEvent(String msg, Object... arguments) Deprecated.
void	performanceEvent(EELFLogger.Level level, String msg, Object... arguments) Deprecated.
void	performanceEvent(String msg, Object... arguments) Deprecated.
void	policyEvent(EELFLogger.Level level, String msg, Object... arguments) Deprecated.
void	policyEvent(String msg, Object... arguments) Deprecated.
void	securityEvent(EELFLogger.Level level, String msg, Object... arguments) Deprecated.
void	securityEvent(String msg, Object... arguments) Deprecated.
void	serverEvent(EELFLogger.Level level, String msg, Object... arguments) Deprecated.
void	serverEvent(String msg, Object... arguments) Deprecated.
void	setLevel(EELFLogger.Level level) Change the logging level for the logger
void	trace(EELFResolvableResourceEnum resource, String... arguments) Log a trace message based on message key as defined in resource bundle with arguments.
void	trace(EELFResolvableResourceEnum resource, Throwable th, String... arguments) Log a trace message based on message key as defined in resource bundle along with exception.
void	trace(Locale locale, EELFResolvableResourceEnum resource, String... arguments) Log a trace message based on message key as defined in resource bundle for the given locale.
void	trace(Locale locale, EELFResolvableResourceEnum resource, Throwable th, String... arguments) Log a trace message based on message key as defined in resource bundle for the given locale along with exception.
void	warn(EELFResolvableResourceEnum resource, String... arguments) Log a warn message based on message key as defined in resource bundle with arguments.
void	warn(EELFResolvableResourceEnum resource, Throwable th, String... arguments) Log a warn message based on message key as defined in resource bundle along with exception.
void	warn(Locale locale, EELFResolvableResourceEnum resource, String... arguments) Log a warn message based on message key as defined in resource bundle for the given locale.
void	warn(Locale locale, EELFResolvableResourceEnum resource, Throwable th, String... arguments) Log a warn message based on message key as defined in resource bundle for the given locale along with exception.

Methods inherited from interface org.slf4j.Logger

debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, error, error, error, error, error, error, error, error, error, error, getName, info, info, info, info, info, info, info, info, info, info, isDebugEnabled, isDebugEnabled, isErrorEnabled, isErrorEnabled, isInfoEnabled, isInfoEnabled, isTraceEnabled, isTraceEnabled, isWarnEnabled, isWarnEnabled, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn

Method Detail

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 message string to be logged

th - the exception (throwable) to log

arguments - list of arguments for message

auditEvent

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

Deprecated.

Log a audit event using audit logger at info level.

Parameters:

msg - the message string to be logged

arguments - list of arguments for message

auditEvent

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

Deprecated.

Log a audit event using audit logger at given level.

Parameters:

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

msg - the message string to be logged

arguments - list of arguments for message

metricsEvent

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

Deprecated.

Log a metrics event using metrics logger at info level.

Parameters:

msg - the message string to be logged

arguments - list of arguments for message

metricsEvent

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

Deprecated.

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 message string to be logged

arguments - list of arguments for message

securityEvent

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

Deprecated.

Log a security event using security logger at info level.

Parameters:

msg - the message string to be logged

arguments - list of arguments for message

securityEvent

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

Deprecated.

Log a security event using security logger at given level.

Parameters:

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

msg - the message string to be logged

arguments - list of arguments for message

performanceEvent

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

Deprecated.

Log a performance event using performance logger at info level.

Parameters:

msg - the message string to be logged

arguments - list of arguments for message

performanceEvent

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

Deprecated.

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

Parameters:

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

msg - the message string to be logged

arguments - list of arguments for message

applicationEvent

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

Deprecated.

Log an application event using application logger at info.

Parameters:

msg - the message string to be logged

arguments - list of arguments for message

applicationEvent

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

Deprecated.

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

Parameters:

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

msg - the message string to be logged

arguments - list of arguments for message

serverEvent

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

Deprecated.

Log a server event using server logger at info level.

Parameters:

msg - the message string to be logged

arguments - list of arguments for message

serverEvent

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

Deprecated.

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

Parameters:

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

msg - the message string to be logged

arguments - list of arguments for message

policyEvent

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

Deprecated.

Log a policy event using policy logger at info level.

Parameters:

msg - the message string to be logged

arguments - list of arguments for message

policyEvent

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

Deprecated.

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

Parameters:

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

msg - the message string to be logged

arguments - list of arguments for message

warn

void warn(Locale locale,
          EELFResolvableResourceEnum resource,
          Throwable th,
          String... arguments)

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

Parameters:

locale - the locale that we want to load the resource for

resource - identifies the resource to be used

th - the exception (throwable) to log

arguments - list of arguments for message

info

void info(Locale locale,
          EELFResolvableResourceEnum resource,
          Throwable th,
          String... arguments)

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

Parameters:

locale - the locale that we want to load the resource for

resource - identifies the resource to be used

th - the exception (throwable) to log

arguments - list of arguments for message

debug

void debug(Locale locale,
           EELFResolvableResourceEnum resource,
           Throwable th,
           String... arguments)

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

Parameters:

locale - the locale that we want to load the resource for

resource - identifies the resource to be used

th - the exception (throwable) to log

arguments - list of arguments for message

error

void error(Locale locale,
           EELFResolvableResourceEnum resource,
           Throwable th,
           String... arguments)

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

Parameters:

locale - the locale that we want to load the resource for

resource - identifies the resource to be used

th - the exception (throwable) to log

arguments - list of arguments for message

trace

void trace(Locale locale,
           EELFResolvableResourceEnum resource,
           Throwable th,
           String... arguments)

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

Parameters:

locale - the locale that we want to load the resource for

resource - identifies the resource to be used

th - the exception (throwable) to log

arguments - list of arguments for message

warn

void warn(Locale locale,
          EELFResolvableResourceEnum resource,
          String... arguments)

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

Parameters:

locale - the locale that we want to load the resource for

resource - identifies the resource to be used

arguments - list of arguments for message

info

void info(Locale locale,
          EELFResolvableResourceEnum resource,
          String... arguments)

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

Parameters:

locale - the locale that we want to load the resource for

resource - identifies the resource to be used

arguments - list of arguments for message

debug

void debug(Locale locale,
           EELFResolvableResourceEnum resource,
           String... arguments)

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

Parameters:

locale - the locale that we want to load the resource for

resource - identifies the resource to be used

arguments - list of arguments for message

error

void error(Locale locale,
           EELFResolvableResourceEnum resource,
           String... arguments)

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

Parameters:

locale - the locale that we want to load the resource for

resource - identifies the resource to be used

arguments - list of arguments for message

trace

void trace(Locale locale,
           EELFResolvableResourceEnum resource,
           String... arguments)

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

Parameters:

locale - the locale that we want to load the resource for

resource - identifies the resource to be used

arguments - list of arguments for message

warn

void warn(EELFResolvableResourceEnum resource,
          String... arguments)

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

Parameters:

resource - identifies the resource to be used

arguments - list of arguments for message

info

void info(EELFResolvableResourceEnum resource,
          String... arguments)

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

Parameters:

resource - identifies the resource to be used

arguments - list of arguments for message

debug

void debug(EELFResolvableResourceEnum resource,
           String... arguments)

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

Parameters:

resource - identifies the resource to be used

arguments - list of arguments for message

error

void error(EELFResolvableResourceEnum resource,
           String... arguments)

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

Parameters:

resource - identifies the resource to be used

arguments - list of arguments for message

trace

void trace(EELFResolvableResourceEnum resource,
           String... arguments)

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

Parameters:

resource - identifies the resource to be used

arguments - list of arguments for message

warn

void warn(EELFResolvableResourceEnum resource,
          Throwable th,
          String... arguments)

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

Parameters:

resource - identifies the resource to be used

th - the exception (throwable) to log

arguments - list of arguments for message

info

void info(EELFResolvableResourceEnum resource,
          Throwable th,
          String... arguments)

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

Parameters:

resource - identifies the resource to be used

th - the exception (throwable) to log

arguments - list of arguments for message

debug

void debug(EELFResolvableResourceEnum resource,
           Throwable th,
           String... arguments)

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

Parameters:

resource - identifies the resource to be used

th - the exception (throwable) to log

arguments - list of arguments for message

error

void error(EELFResolvableResourceEnum resource,
           Throwable th,
           String... arguments)

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

Parameters:

resource - identifies the resource to be used

th - the exception (throwable) to log

arguments - list of arguments for message

trace

void trace(EELFResolvableResourceEnum resource,
           Throwable th,
           String... arguments)

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

Parameters:

resource - identifies the resource to be used

th - the exception (throwable) to log

arguments - list of arguments for message

setLevel

void setLevel(EELFLogger.Level level)

Change the logging level for the logger

Parameters:

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

disableLogging

void disableLogging()

Turn off the logging for the logger