StatusLogger (Apache Log4j API 2.17.1 API)

java.lang.Object
- org.apache.logging.log4j.spi.AbstractLogger
- - org.apache.logging.log4j.status.StatusLogger

All Implemented Interfaces:

Serializable, Logger, ExtendedLogger, LocationAwareLogger
```
public final class StatusLogger
extends 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 "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 `StatusListener`s.
`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, logBuilder, name, THROWING_MARKER

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears the list of status events.
`Level`	`getLevel()` Gets the Level associated with the Logger.
`Iterable<StatusListener>`	`getListeners()` Returns a thread safe Iterable for the StatusListener.
`static StatusLogger`	`getLogger()` Retrieve the StatusLogger.
`List<StatusData>`	`getStatusData()` Returns a List of all events as StatusData objects.
`boolean`	`isEnabled(Level level, Marker marker)` Checks whether this Logger is enabled for the given Level and Marker.
`boolean`	`isEnabled(Level level, Marker marker, CharSequence message, Throwable t)` Determines if logging is enabled.
`boolean`	`isEnabled(Level level, Marker marker, Message message, Throwable t)` Determines if logging is enabled.
`boolean`	`isEnabled(Level level, Marker marker, Object message, Throwable t)` Determines if logging is enabled.
`boolean`	`isEnabled(Level level, Marker marker, String message)` Determine if logging is enabled.
`boolean`	`isEnabled(Level level, Marker marker, String message, Object... params)` Determines if logging is enabled.
`boolean`	`isEnabled(Level level, Marker marker, String message, Object p0)` Determines if logging is enabled.
`boolean`	`isEnabled(Level level, Marker marker, String message, Object p0, Object p1)` Determines if logging is enabled.
`boolean`	`isEnabled(Level level, Marker marker, String message, Object p0, Object p1, Object p2)` Determines if logging is enabled.
`boolean`	`isEnabled(Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3)` Determines if logging is enabled.
`boolean`	`isEnabled(Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4)` Determines if logging is enabled.
`boolean`	`isEnabled(Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5)` Determines if logging is enabled.
`boolean`	`isEnabled(Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6)` Determines if logging is enabled.
`boolean`	`isEnabled(Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7)` Determines if logging is enabled.
`boolean`	`isEnabled(Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8)` Determines if logging is enabled.
`boolean`	`isEnabled(Level level, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8, Object p9)` Determines if logging is enabled.
`boolean`	`isEnabled(Level level, Marker marker, String message, Throwable t)` Determines if logging is enabled.
`void`	`logMessage(String fqcn, Level level, Marker marker, Message msg, Throwable t)` Adds an event.
`void`	`registerListener(StatusListener listener)` Registers a new listener.
`void`	`removeListener(StatusListener listener)` Removes a StatusListener.
`void`	`reset()` Clears the list of status events and listeners.
`void`	`setLevel(Level level)`
`void`	`updateListenerLevel(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, 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(Level level)
```

registerListener
```
public void registerListener(StatusListener listener)
```
Registers a new listener.

Parameters:

listener - The StatusListener to register.

removeListener
```
public void removeListener(StatusListener listener)
```
Removes a StatusListener.

Parameters:

listener - The StatusListener to remove.

updateListenerLevel

public void updateListenerLevel(Level status)

getListeners
```
public Iterable<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<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 Level getLevel()
```
Description copied from interface: Logger

Gets the Level associated with the Logger.

Returns:

the Level associate with the Logger.

logMessage

public void logMessage(String fqcn,
                       Level level,
                       Marker marker,
                       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(Level level,
                         Marker marker,
                         String message,
                         Throwable t)
```
Description copied from interface: ExtendedLogger

Determines if logging is enabled.

Parameters:

level - The logging Level to check.

marker - A Marker or null.

message - The message.

t - the exception to log, including its stack trace.

Returns:

True if logging is enabled, false otherwise.

isEnabled
```
public boolean isEnabled(Level level,
                         Marker marker,
                         String message)
```
Description copied from interface: ExtendedLogger

Determine if logging is enabled.

Parameters:

level - The logging Level to check.

marker - A Marker or null.

message - The message.

Returns:

True if logging is enabled, false otherwise.

isEnabled
```
public boolean isEnabled(Level level,
                         Marker marker,
                         String message,
                         Object... params)
```
Description copied from interface: ExtendedLogger

Determines if logging is enabled.

Parameters:

level - The logging Level to check.

marker - A Marker or null.

message - The message.

params - The parameters.

Returns:

True if logging is enabled, false otherwise.

isEnabled
```
public boolean isEnabled(Level level,
                         Marker marker,
                         String message,
                         Object p0)
```
Description copied from interface: ExtendedLogger

Determines if logging is enabled.

Parameters:

level - The logging Level to check.

marker - A Marker or null.

message - The message.

p0 - the message parameters

Returns:

True if logging is enabled, false otherwise.