@Plugin(name="Console", category="Core", elementType="appender", printObject=true) public final class ConsoleAppender extends AbstractOutputStreamAppender<OutputStreamManager>
System.out or System.err using a layout specified by the user. The
default target is System.out.
TODO Accessing System.out or System.err as a byte stream instead of a writer bypasses the
JVM's knowledge of the proper encoding. (RG) Encoding is handled within the Layout. Typically, a Layout will generate
a String and then call getBytes which may use a configured encoding or the system default. OTOH, a Writer cannot
print byte streams.
| Modifier and Type | Class and Description |
|---|---|
static class |
ConsoleAppender.Builder<B extends ConsoleAppender.Builder<B>>
Builds ConsoleAppender instances.
|
static class |
ConsoleAppender.Target
Enumeration of console destinations.
|
LifeCycle.State| Modifier and Type | Field and Description |
|---|---|
static String |
PLUGIN_NAME |
DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGERELEMENT_TYPE, EMPTY_ARRAY| Modifier and Type | Method and Description |
|---|---|
static ConsoleAppender |
createAppender(Layout<? extends Serializable> layout,
Filter filter,
ConsoleAppender.Target target,
String name,
boolean follow,
boolean direct,
boolean ignoreExceptions)
Deprecated.
Deprecated in 2.7; use
newBuilder(). |
static ConsoleAppender |
createAppender(Layout<? extends Serializable> layout,
Filter filter,
String targetStr,
String name,
String follow,
String ignore)
Deprecated.
Deprecated in 2.7; use
newBuilder(). |
static ConsoleAppender |
createDefaultAppenderForLayout(Layout<? extends Serializable> layout) |
ConsoleAppender.Target |
getTarget() |
static <B extends ConsoleAppender.Builder<B>> |
newBuilder() |
append, directEncodeEvent, getImmediateFlush, getManager, start, stop, stop, writeByteArrayToManagererror, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, requiresLocation, setHandler, toSerializable, toStringaddFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilterequalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stoppublic static final String PLUGIN_NAME
@Deprecated public static ConsoleAppender createAppender(Layout<? extends Serializable> layout, Filter filter, String targetStr, String name, String follow, String ignore)
newBuilder().layout - The layout to use (required).filter - The Filter or null.targetStr - The target ("SYSTEM_OUT" or "SYSTEM_ERR"). The default is "SYSTEM_OUT".name - The name of the Appender (required).follow - If true will follow changes to the underlying output stream.ignore - If "true" (default) exceptions encountered when appending events are logged; otherwise they
are propagated to the caller.@Deprecated public static ConsoleAppender createAppender(Layout<? extends Serializable> layout, Filter filter, ConsoleAppender.Target target, String name, boolean follow, boolean direct, boolean ignoreExceptions)
newBuilder().layout - The layout to use (required).filter - The Filter or null.target - The target (SYSTEM_OUT or SYSTEM_ERR). The default is SYSTEM_OUT.name - The name of the Appender (required).follow - If true will follow changes to the underlying output stream.direct - If true will write directly to FileDescriptor and bypass
System.out/System.err.ignoreExceptions - If "true" (default) exceptions encountered when appending events are logged; otherwise they
are propagated to the caller.public static ConsoleAppender createDefaultAppenderForLayout(Layout<? extends Serializable> layout)
@PluginBuilderFactory public static <B extends ConsoleAppender.Builder<B>> B newBuilder()
public ConsoleAppender.Target getTarget()
Copyright © 1999-2023 The Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.