Class Log4J2Logger
- All Implemented Interfaces:
Logger
Logger backed by Log4J 2 (org.apache.logging.log4j).
Registered as @Service(Logger.class), so it is picked up by the DefaultLoggerFactory
as soon as this module is on the class- or module path.
Messages are formatted with MessageFormat (not Log4J's {} placeholders) and logged
on behalf of the caller, i.e. Log4J reports the caller's location, not this wrapper's.
- Author:
- harald
-
Nested Class Summary
Nested classes/interfaces inherited from interface Logger
Logger.Level -
Constructor Summary
ConstructorsConstructorDescriptionLog4J2Logger(String name) Creates a logger.
Applications should usegetLogger(String)instead, which reuses existing instances. -
Method Summary
Modifier and TypeMethodDescriptionprotected voiddoLog(Logger.Level level, String message, Throwable cause, Object... params) Logs a message with optional parameters.protected voiddoLog(Logger.Level level, Throwable cause, String message, Supplier<?>... paramSuppliers) Logs a message with lazily evaluated parameters.protected voidLogs a message or the result of a message supplier.
All other logging methods end up here.voidLogs a message with level FINE.voidLogs a message with level FINE.voidLogs a message with level FINE.voidLogs a message with level FINE.voidLogs a message with level FINE.voidLogs a message with level FINE.voidLogs a message with level FINER.voidLogs a message with level FINER.voidLogs a message with level FINER.voidLogs a message with level FINER.voidLogs a message with level FINER.voidLogs a message with level FINER.static Log4J2LoggerGets the Log4J2Logger for the given name.
If a logger with that name already exists, it will be reused.Gets the concrete logger implementation.
Useful to access the logging-backend.Gets the mapped diagnostic context (MDC).
Usually a singleton (depending on the backend).voidLogs a message with level INFO.voidLogs a message with level INFO.voidLogs a message with level INFO.voidLogs a message with level INFO.voidLogs a message with level INFO.voidLogs a message with level INFO.booleanChecks if logger logs level FINE.booleanChecks if logger logs level FINER.booleanChecks if logger logs level INFO.booleanisLoggable(Logger.Level level) Returns whether this logger will log the given level.booleanChecks if logger logs level SEVERE.booleanChecks if logger logs level WARNING.voidlog(Logger.Level level, String message, Object... params) Logs a message.voidlog(Logger.Level level, String message, Throwable cause) Logs a message.voidlog(Logger.Level level, Throwable cause, Supplier<String> messageSupplier) Logs a message.voidlogStacktrace(Throwable cause) Logs the stacktrace of a throwable with a logging level of SEVERE.voidlogStacktrace(Logger.Level level, Throwable cause) Logs the stacktrace of a throwable.
The stacktrace is logged line by line via aLoggerOutputStream.voidLogs a message with level SEVERE.voidLogs a message with level SEVERE.voidLogs a message with level SEVERE.voidLogs a message with level SEVERE.voidLogs a message with level SEVERE.voidLogs a message with level SEVERE.voidLogs a message with level WARNING.voidLogs a message with level WARNING.voidLogs a message with level WARNING.voidLogs a message with level WARNING.voidLogs a message with level WARNING.voidLogs a message with level WARNING.
-
Constructor Details
-
Log4J2Logger
Creates a logger.
Applications should usegetLogger(String)instead, which reuses existing instances.- Parameters:
name- the name of the logger
-
-
Method Details
-
getLogger
Gets the Log4J2Logger for the given name.
If a logger with that name already exists, it will be reused.This is the method
DefaultLoggerFactoryprefers over the constructor. The cache is thread-safe and holds the loggers for the lifetime of the JVM.- Parameters:
name- the name of the logger- Returns:
- the logger
-
getLoggerImpl
Gets the concrete logger implementation.
Useful to access the logging-backend.Returns the
ExtendedLoggerWrapperaround the Log4J logger, not theorg.apache.logging.log4j.Loggerobtained from theLogManager.- Specified by:
getLoggerImplin interfaceLogger- Returns:
- the logger object
-
isLoggable
Description copied from interface:LoggerReturns whether this logger will log the given level.- Specified by:
isLoggablein interfaceLogger- Parameters:
level- the logging level- Returns:
- true if the given logging level is currently being logged
-
log
-
log
-
log
-
finer
-
fine
-
info
-
warning
-
severe
-
finer
-
fine
-
info
-
warning
-
severe
-
finer
-
fine
-
info
-
warning
-
severe
-
finer
-
fine
-
info
-
warning
-
severe
-
finer
-
fine
-
info
-
warning
-
severe
-
finer
-
fine
-
info
-
warning
-
severe
-
isFinerLoggable
public boolean isFinerLoggable()Description copied from interface:LoggerChecks if logger logs level FINER.- Specified by:
isFinerLoggablein interfaceLogger- Returns:
- true if logger will log this level
-
isFineLoggable
public boolean isFineLoggable()Description copied from interface:LoggerChecks if logger logs level FINE.- Specified by:
isFineLoggablein interfaceLogger- Returns:
- true if logger will log this level
-
isInfoLoggable
public boolean isInfoLoggable()Description copied from interface:LoggerChecks if logger logs level INFO.- Specified by:
isInfoLoggablein interfaceLogger- Returns:
- true if logger will log this level
-
isWarningLoggable
public boolean isWarningLoggable()Description copied from interface:LoggerChecks if logger logs level WARNING.- Specified by:
isWarningLoggablein interfaceLogger- Returns:
- true if logger will log this level
-
isSevereLoggable
public boolean isSevereLoggable()Description copied from interface:LoggerChecks if logger logs level SEVERE.- Specified by:
isSevereLoggablein interfaceLogger- Returns:
- true if logger will log this level
-
logStacktrace
Logs the stacktrace of a throwable.
The stacktrace is logged line by line via aLoggerOutputStream.- Specified by:
logStacktracein interfaceLogger- Parameters:
level- the logging levelcause- the Throwable to log the stacktrace for
-
logStacktrace
Logs the stacktrace of a throwable with a logging level of SEVERE.- Specified by:
logStacktracein interfaceLogger- Parameters:
cause- the Throwable to log the stacktrace for
-
getMappedDiagnosticContext
Description copied from interface:LoggerGets the mapped diagnostic context (MDC).
Usually a singleton (depending on the backend).- Specified by:
getMappedDiagnosticContextin interfaceLogger- Returns:
- the MDC
-
doLog
Logs a message with optional parameters.If there are parameters, the message is formatted with
MessageFormat. Otherwise, it is logged verbatim, i.e. quotes are not unescaped and placeholders stay as they are.- Parameters:
level- the log levelmessage- the messagecause- the cause, null if noneparams- optional parameters
-
doLog
protected void doLog(Logger.Level level, Throwable cause, String message, Supplier<?>... paramSuppliers) Logs a message with lazily evaluated parameters.The suppliers are evaluated only if the level is enabled. The message is always formatted with
MessageFormat, even if there are no suppliers.- Parameters:
level- the log levelcause- the cause, null if nonemessage- the messageparamSuppliers- parameter suppliers, null elements yield null parameters
-
doLog
protected void doLog(Logger.Level level, Throwable cause, String message, Supplier<String> messageSupplier) Logs a message or the result of a message supplier.
All other logging methods end up here.The message is created only if the level is enabled. The caller's location is determined by Log4J relative to this class.
- Parameters:
level- the log levelcause- the cause, null if nonemessage- the message, ignored if messageSupplier is not nullmessageSupplier- the message supplier, null to log message
-