org.apache.logging.log4j.status

Class StatusLogger

java.lang.Object

org.apache.logging.log4j.spi.AbstractLogger

org.apache.logging.log4j.status.StatusLogger

All Implemented Interfaces:

Serializable, org.apache.logging.log4j.Logger, org.apache.logging.log4j.spi.ExtendedLogger, org.apache.logging.log4j.spi.LocationAwareLogger

public final class StatusLogger
extends org.apache.logging.log4j.spi.AbstractLogger

Records events that occur in the logging system. By default, only error messages are logged to System.err. Normally, the Log4j StatusLogger is configured via the root <Configuration status="LEVEL"/> node in a Log4j configuration file. However, this can be overridden via a system property named "log4j2.StatusLogger.level" and will work with any Log4j provider.

See Also:

SimpleLogger, SimpleLoggerContext, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_STATUS_LISTENER_LEVEL System property that can be configured with the Level name to use as the default level for StatusListeners.
static String	MAX_STATUS_ENTRIES System property that can be configured with the number of entries in the queue.
static String	STATUS_DATE_FORMAT System property that can be configured with a date-time format string to use as the format for timestamps in the status logger output.

Fields inherited from class org.apache.logging.log4j.spi.AbstractLogger

CATCHING_MARKER, DEFAULT_FLOW_MESSAGE_FACTORY_CLASS, DEFAULT_MESSAGE_FACTORY_CLASS, ENTRY_MARKER, EXCEPTION_MARKER, EXIT_MARKER, FLOW_MARKER, name, THROWING_MARKER

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the list of status events.
org.apache.logging.log4j.Level	getLevel()
Iterable<org.apache.logging.log4j.status.StatusListener>	getListeners() Returns a thread safe Iterable for the StatusListener.
static StatusLogger	getLogger() Retrieve the StatusLogger.
List<org.apache.logging.log4j.status.StatusData>	getStatusData() Returns a List of all events as StatusData objects.
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, CharSequence message, Throwable t)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, org.apache.logging.log4j.message.Message message, Throwable t)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, Object message, Throwable t)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object... params)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2, Object p3)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8, Object p9)
boolean	isEnabled(org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String message, Throwable t)
void	logMessage(String fqcn, org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, org.apache.logging.log4j.message.Message msg, Throwable t) Adds an event.
void	registerListener(org.apache.logging.log4j.status.StatusListener listener) Registers a new listener.
void	removeListener(org.apache.logging.log4j.status.StatusListener listener) Removes a StatusListener.
void	reset() Clears the list of status events and listeners.
void	setLevel(org.apache.logging.log4j.Level level)
void	updateListenerLevel(org.apache.logging.log4j.Level status)

Methods inherited from class org.apache.logging.log4j.spi.AbstractLogger

always, atDebug, atError, atFatal, atInfo, atLevel, atTrace, atWarn, catching, catching, catching, catchingMsg, checkMessageFactory, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, enter, enter, enter, enter, enter, entry, entry, entry, entryMsg, entryMsg, entryMsg, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, exit, exit, exit, exit, exitMsg, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, getFlowMessageFactory, getLogBuilder, getMessageFactory, getName, getRecursionDepth, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, isDebugEnabled, isDebugEnabled, isEnabled, isErrorEnabled, isErrorEnabled, isFatalEnabled, isFatalEnabled, isInfoEnabled, isInfoEnabled, isTraceEnabled, isTraceEnabled, isWarnEnabled, isWarnEnabled, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, printf, printf, requiresLocation, throwing, throwing, throwing, throwingMsg, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, traceEntry, traceEntry, traceEntry, traceEntry, traceEntry, traceExit, traceExit, traceExit, traceExit, traceExit, traceExit, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Field Detail

MAX_STATUS_ENTRIES

public static final String MAX_STATUS_ENTRIES

System property that can be configured with the number of entries in the queue. Once the limit is reached older entries will be removed as new entries are added.

See Also:

Constant Field Values

DEFAULT_STATUS_LISTENER_LEVEL

public static final String DEFAULT_STATUS_LISTENER_LEVEL

System property that can be configured with the Level name to use as the default level for StatusListeners.

See Also:

Constant Field Values

STATUS_DATE_FORMAT

public static final String STATUS_DATE_FORMAT

System property that can be configured with a date-time format string to use as the format for timestamps in the status logger output. See SimpleDateFormat for supported formats.

Since:

2.11.0

See Also:

Constant Field Values

Method Detail

getLogger

public static StatusLogger getLogger()

Retrieve the StatusLogger.

Returns:

The StatusLogger.

setLevel

public void setLevel(org.apache.logging.log4j.Level level)

registerListener

public void registerListener(org.apache.logging.log4j.status.StatusListener listener)

Registers a new listener.

Parameters:

listener - The StatusListener to register.

removeListener

public void removeListener(org.apache.logging.log4j.status.StatusListener listener)

Removes a StatusListener.

Parameters:

listener - The StatusListener to remove.

updateListenerLevel

public void updateListenerLevel(org.apache.logging.log4j.Level status)

getListeners

public Iterable<org.apache.logging.log4j.status.StatusListener> getListeners()

Returns a thread safe Iterable for the StatusListener.

Returns:

An Iterable for the list of StatusListeners.

reset

public void reset()

Clears the list of status events and listeners.

getStatusData

public List<org.apache.logging.log4j.status.StatusData> getStatusData()

Returns a List of all events as StatusData objects.

Returns:

The list of StatusData objects.

clear

public void clear()

Clears the list of status events.

getLevel

public org.apache.logging.log4j.Level getLevel()

logMessage

public void logMessage(String fqcn,
                       org.apache.logging.log4j.Level level,
                       org.apache.logging.log4j.Marker marker,
                       org.apache.logging.log4j.message.Message msg,
                       Throwable t)

Adds an event.

Parameters:

marker - The Marker

fqcn - The fully qualified class name of the caller

level - The logging level

msg - The message associated with the event.

t - A Throwable or null.

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         String message,
                         Throwable t)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         String message)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         String message,
                         Object... params)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         String message,
                         Object p0)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         String message,
                         Object p0,
                         Object p1)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         String message,
                         Object p0,
                         Object p1,
                         Object p2)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         String message,
                         Object p0,
                         Object p1,
                         Object p2,
                         Object p3)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         String message,
                         Object p0,
                         Object p1,
                         Object p2,
                         Object p3,
                         Object p4)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         String message,
                         Object p0,
                         Object p1,
                         Object p2,
                         Object p3,
                         Object p4,
                         Object p5)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         String message,
                         Object p0,
                         Object p1,
                         Object p2,
                         Object p3,
                         Object p4,
                         Object p5,
                         Object p6)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         String message,
                         Object p0,
                         Object p1,
                         Object p2,
                         Object p3,
                         Object p4,
                         Object p5,
                         Object p6,
                         Object p7)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         String message,
                         Object p0,
                         Object p1,
                         Object p2,
                         Object p3,
                         Object p4,
                         Object p5,
                         Object p6,
                         Object p7,
                         Object p8)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         String message,
                         Object p0,
                         Object p1,
                         Object p2,
                         Object p3,
                         Object p4,
                         Object p5,
                         Object p6,
                         Object p7,
                         Object p8,
                         Object p9)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         CharSequence message,
                         Throwable t)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         Object message,
                         Throwable t)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker,
                         org.apache.logging.log4j.message.Message message,
                         Throwable t)

isEnabled

public boolean isEnabled(org.apache.logging.log4j.Level level,
                         org.apache.logging.log4j.Marker marker)

Specified by:

isEnabled in interface org.apache.logging.log4j.Logger

Overrides:

isEnabled in class org.apache.logging.log4j.spi.AbstractLogger