Package | Description |
---|---|
org.apache.logging.log4j.core |
Implementation of Log4j 2.
|
org.apache.logging.log4j.core.appender |
Log4j 2 Appenders.
|
org.apache.logging.log4j.core.appender.rewrite |
Apache Flume Appender.
|
org.apache.logging.log4j.core.appender.routing |
Apache Flume Appender.
|
org.apache.logging.log4j.core.async |
Provides Asynchronous Logger classes and interfaces for low-latency logging.
|
org.apache.logging.log4j.core.config |
Configuration of Log4j 2.
|
org.apache.logging.log4j.core.filter |
Log4j 2 Filter support.
|
Modifier and Type | Method and Description |
---|---|
java.util.Iterator<Filter> |
Logger.getFilters()
This method is not exposed through the public API and is used primarily for unit testing.
|
Modifier and Type | Method and Description |
---|---|
void |
LoggerContext.addFilter(Filter filter)
Adds a Filter to the Configuration.
|
void |
Logger.addFilter(Filter filter)
This method is not exposed through the public API and is used primarily for unit testing.
|
void |
LoggerContext.removeFilter(Filter filter)
Removes a Filter from the current Configuration.
|
Modifier and Type | Field and Description |
---|---|
private Filter |
AsyncAppender.Builder.filter |
private Filter |
OutputStreamAppender.Builder.filter |
private Filter |
WriterAppender.Builder.filter |
Modifier and Type | Method and Description |
---|---|
static AsyncAppender |
AsyncAppender.createAppender(AppenderRef[] appenderRefs,
java.lang.String errorRef,
boolean blocking,
long shutdownTimeout,
int size,
java.lang.String name,
boolean includeLocation,
Filter filter,
Configuration config,
boolean ignoreExceptions)
Deprecated.
use
AsyncAppender.Builder instead |
static SmtpAppender |
SmtpAppender.createAppender(Configuration config,
java.lang.String name,
java.lang.String to,
java.lang.String cc,
java.lang.String bcc,
java.lang.String from,
java.lang.String replyTo,
java.lang.String subject,
java.lang.String smtpProtocol,
java.lang.String smtpHost,
java.lang.String smtpPortStr,
java.lang.String smtpUsername,
java.lang.String smtpPassword,
java.lang.String smtpDebug,
java.lang.String bufferSizeStr,
Layout<? extends java.io.Serializable> layout,
Filter filter,
java.lang.String ignore)
Create a SmtpAppender.
|
static ConsoleAppender |
ConsoleAppender.createAppender(Layout<? extends java.io.Serializable> layout,
Filter filter,
ConsoleAppender.Target target,
java.lang.String name,
boolean follow,
boolean direct,
boolean ignoreExceptions)
Deprecated.
Deprecated in 2.7; use
ConsoleAppender.newBuilder() . |
static OutputStreamAppender |
OutputStreamAppender.createAppender(Layout<? extends java.io.Serializable> layout,
Filter filter,
java.io.OutputStream target,
java.lang.String name,
boolean follow,
boolean ignore)
Creates an OutputStream Appender.
|
static ConsoleAppender |
ConsoleAppender.createAppender(Layout<? extends java.io.Serializable> layout,
Filter filter,
java.lang.String targetStr,
java.lang.String name,
java.lang.String follow,
java.lang.String ignore)
Deprecated.
Deprecated in 2.7; use
ConsoleAppender.newBuilder() . |
static SocketAppender |
SocketAppender.createAppender(java.lang.String host,
int port,
Protocol protocol,
SslConfiguration sslConfig,
int connectTimeoutMillis,
int reconnectDelayMillis,
boolean immediateFail,
java.lang.String name,
boolean immediateFlush,
boolean ignoreExceptions,
Layout<? extends java.io.Serializable> layout,
Filter filter,
boolean advertise,
Configuration configuration)
Deprecated.
Deprecated in 2.7; use
SocketAppender.newBuilder() |
static <B extends SyslogAppender.Builder<B>> |
SyslogAppender.createAppender(java.lang.String host,
int port,
java.lang.String protocolStr,
SslConfiguration sslConfiguration,
int connectTimeoutMillis,
int reconnectDelayMillis,
boolean immediateFail,
java.lang.String name,
boolean immediateFlush,
boolean ignoreExceptions,
Facility facility,
java.lang.String id,
int enterpriseNumber,
boolean includeMdc,
java.lang.String mdcId,
java.lang.String mdcPrefix,
java.lang.String eventPrefix,
boolean newLine,
java.lang.String escapeNL,
java.lang.String appName,
java.lang.String msgId,
java.lang.String excludes,
java.lang.String includes,
java.lang.String required,
java.lang.String format,
Filter filter,
Configuration configuration,
java.nio.charset.Charset charset,
java.lang.String exceptionPattern,
LoggerFields[] loggerFields,
boolean advertise)
Deprecated.
|
static WriterAppender |
WriterAppender.createAppender(StringLayout layout,
Filter filter,
java.io.Writer target,
java.lang.String name,
boolean follow,
boolean ignore)
Creates a WriterAppender.
|
static FailoverAppender |
FailoverAppender.createAppender(java.lang.String name,
java.lang.String primary,
java.lang.String[] failovers,
java.lang.String retryIntervalSeconds,
Configuration config,
Filter filter,
java.lang.String ignore)
Create a Failover Appender.
|
static SocketAppender |
SocketAppender.createAppender(java.lang.String host,
java.lang.String portNum,
java.lang.String protocolIn,
SslConfiguration sslConfig,
int connectTimeoutMillis,
java.lang.String delayMillis,
java.lang.String immediateFail,
java.lang.String name,
java.lang.String immediateFlush,
java.lang.String ignore,
Layout<? extends java.io.Serializable> layout,
Filter filter,
java.lang.String advertise,
Configuration config)
Deprecated.
Deprecated in 2.5; use
SocketAppender.newBuilder() |
static <B extends MemoryMappedFileAppender.Builder<B>> |
MemoryMappedFileAppender.createAppender(java.lang.String fileName,
java.lang.String append,
java.lang.String name,
java.lang.String immediateFlush,
java.lang.String regionLengthStr,
java.lang.String ignore,
Layout<? extends java.io.Serializable> layout,
Filter filter,
java.lang.String advertise,
java.lang.String advertiseURI,
Configuration config)
Deprecated.
|
static <B extends RandomAccessFileAppender.Builder<B>> |
RandomAccessFileAppender.createAppender(java.lang.String fileName,
java.lang.String append,
java.lang.String name,
java.lang.String immediateFlush,
java.lang.String bufferSizeStr,
java.lang.String ignore,
Layout<? extends java.io.Serializable> layout,
Filter filter,
java.lang.String advertise,
java.lang.String advertiseURI,
Configuration configuration)
Deprecated.
|
static <B extends FileAppender.Builder<B>> |
FileAppender.createAppender(java.lang.String fileName,
java.lang.String append,
java.lang.String locking,
java.lang.String name,
java.lang.String immediateFlush,
java.lang.String ignoreExceptions,
java.lang.String bufferedIo,
java.lang.String bufferSizeStr,
Layout<? extends java.io.Serializable> layout,
Filter filter,
java.lang.String advertise,
java.lang.String advertiseUri,
Configuration config)
Deprecated.
|
static <B extends RollingFileAppender.Builder<B>> |
RollingFileAppender.createAppender(java.lang.String fileName,
java.lang.String filePattern,
java.lang.String append,
java.lang.String name,
java.lang.String bufferedIO,
java.lang.String bufferSizeStr,
java.lang.String immediateFlush,
TriggeringPolicy policy,
RolloverStrategy strategy,
Layout<? extends java.io.Serializable> layout,
Filter filter,
java.lang.String ignore,
java.lang.String advertise,
java.lang.String advertiseUri,
Configuration config)
Deprecated.
|
static <B extends RollingRandomAccessFileAppender.Builder<B>> |
RollingRandomAccessFileAppender.createAppender(java.lang.String fileName,
java.lang.String filePattern,
java.lang.String append,
java.lang.String name,
java.lang.String immediateFlush,
java.lang.String bufferSizeStr,
TriggeringPolicy policy,
RolloverStrategy strategy,
Layout<? extends java.io.Serializable> layout,
Filter filter,
java.lang.String ignoreExceptions,
java.lang.String advertise,
java.lang.String advertiseURI,
Configuration configuration)
Deprecated.
|
AsyncAppender.Builder |
AsyncAppender.Builder.setFilter(Filter filter) |
OutputStreamAppender.Builder |
OutputStreamAppender.Builder.setFilter(Filter aFilter) |
WriterAppender.Builder |
WriterAppender.Builder.setFilter(Filter aFilter) |
Constructor and Description |
---|
AbstractAppender(java.lang.String name,
Filter filter,
Layout<? extends java.io.Serializable> layout)
Constructor that defaults to suppressing exceptions.
|
AbstractAppender(java.lang.String name,
Filter filter,
Layout<? extends java.io.Serializable> layout,
boolean ignoreExceptions)
Constructor.
|
AbstractOutputStreamAppender(java.lang.String name,
Layout<? extends java.io.Serializable> layout,
Filter filter,
boolean ignoreExceptions,
boolean immediateFlush,
M manager)
Instantiates a WriterAppender and set the output destination to a new
OutputStreamWriter
initialized with os as its OutputStream . |
AbstractWriterAppender(java.lang.String name,
StringLayout layout,
Filter filter,
boolean ignoreExceptions,
boolean immediateFlush,
M manager)
Instantiates.
|
AsyncAppender(java.lang.String name,
Filter filter,
AppenderRef[] appenderRefs,
java.lang.String errorRef,
int queueSize,
boolean blocking,
boolean ignoreExceptions,
long shutdownTimeout,
Configuration config,
boolean includeLocation,
BlockingQueueFactory<LogEvent> blockingQueueFactory) |
ConsoleAppender(java.lang.String name,
Layout<? extends java.io.Serializable> layout,
Filter filter,
OutputStreamManager manager,
boolean ignoreExceptions,
ConsoleAppender.Target target) |
FailoverAppender(java.lang.String name,
Filter filter,
java.lang.String primary,
java.lang.String[] failovers,
int intervalMillis,
Configuration config,
boolean ignoreExceptions) |
FileAppender(java.lang.String name,
Layout<? extends java.io.Serializable> layout,
Filter filter,
FileManager manager,
java.lang.String filename,
boolean ignoreExceptions,
boolean immediateFlush,
Advertiser advertiser) |
MemoryMappedFileAppender(java.lang.String name,
Layout<? extends java.io.Serializable> layout,
Filter filter,
MemoryMappedFileManager manager,
java.lang.String filename,
boolean ignoreExceptions,
boolean immediateFlush,
Advertiser advertiser) |
OutputStreamAppender(java.lang.String name,
Layout<? extends java.io.Serializable> layout,
Filter filter,
OutputStreamManager manager,
boolean ignoreExceptions) |
RandomAccessFileAppender(java.lang.String name,
Layout<? extends java.io.Serializable> layout,
Filter filter,
RandomAccessFileManager manager,
java.lang.String filename,
boolean ignoreExceptions,
boolean immediateFlush,
Advertiser advertiser) |
RollingFileAppender(java.lang.String name,
Layout<? extends java.io.Serializable> layout,
Filter filter,
RollingFileManager manager,
java.lang.String fileName,
java.lang.String filePattern,
boolean ignoreExceptions,
boolean immediateFlush,
Advertiser advertiser) |
RollingRandomAccessFileAppender(java.lang.String name,
Layout<? extends java.io.Serializable> layout,
Filter filter,
RollingRandomAccessFileManager manager,
java.lang.String fileName,
java.lang.String filePattern,
boolean ignoreExceptions,
boolean immediateFlush,
int bufferSize,
Advertiser advertiser) |
ScriptAppenderSelector(java.lang.String name,
Filter filter,
Layout<? extends java.io.Serializable> layout) |
SmtpAppender(java.lang.String name,
Filter filter,
Layout<? extends java.io.Serializable> layout,
SmtpManager manager,
boolean ignoreExceptions) |
SocketAppender(java.lang.String name,
Layout<? extends java.io.Serializable> layout,
Filter filter,
AbstractSocketManager manager,
boolean ignoreExceptions,
boolean immediateFlush,
Advertiser advertiser) |
SyslogAppender(java.lang.String name,
Layout<? extends java.io.Serializable> layout,
Filter filter,
boolean ignoreExceptions,
boolean immediateFlush,
AbstractSocketManager manager,
Advertiser advertiser) |
WriterAppender(java.lang.String name,
StringLayout layout,
Filter filter,
WriterManager manager,
boolean ignoreExceptions) |
Modifier and Type | Method and Description |
---|---|
static RewriteAppender |
RewriteAppender.createAppender(java.lang.String name,
java.lang.String ignore,
AppenderRef[] appenderRefs,
Configuration config,
RewritePolicy rewritePolicy,
Filter filter)
Creates a RewriteAppender.
|
Constructor and Description |
---|
RewriteAppender(java.lang.String name,
Filter filter,
boolean ignoreExceptions,
AppenderRef[] appenderRefs,
RewritePolicy rewritePolicy,
Configuration config) |
Modifier and Type | Method and Description |
---|---|
static RoutingAppender |
RoutingAppender.createAppender(java.lang.String name,
java.lang.String ignore,
Routes routes,
Configuration config,
RewritePolicy rewritePolicy,
PurgePolicy purgePolicy,
Filter filter)
Deprecated.
Since 2.7; use
RoutingAppender.newBuilder() |
Constructor and Description |
---|
RoutingAppender(java.lang.String name,
Filter filter,
boolean ignoreExceptions,
Routes routes,
RewritePolicy rewritePolicy,
Configuration configuration,
PurgePolicy purgePolicy,
AbstractScript defaultRouteScript) |
Modifier and Type | Method and Description |
---|---|
static LoggerConfig |
AsyncLoggerConfig.RootLogger.createLogger(java.lang.String additivity,
java.lang.String levelName,
java.lang.String includeLocation,
AppenderRef[] refs,
Property[] properties,
Configuration config,
Filter filter) |
static LoggerConfig |
AsyncLoggerConfig.createLogger(java.lang.String additivity,
java.lang.String levelName,
java.lang.String loggerName,
java.lang.String includeLocation,
AppenderRef[] refs,
Property[] properties,
Configuration config,
Filter filter)
Factory method to create a LoggerConfig.
|
Constructor and Description |
---|
AsyncLoggerConfig(java.lang.String name,
java.util.List<AppenderRef> appenders,
Filter filter,
Level level,
boolean additive,
Property[] properties,
Configuration config,
boolean includeLocation) |
Modifier and Type | Field and Description |
---|---|
private Filter |
AppenderRef.filter |
Modifier and Type | Method and Description |
---|---|
Filter |
LoggerConfig.getFilter() |
Filter |
AppenderRef.getFilter() |
Modifier and Type | Method and Description |
---|---|
void |
LoggerConfig.addAppender(Appender appender,
Level level,
Filter filter)
Adds an Appender to the LoggerConfig.
|
void |
Configuration.addLoggerFilter(Logger logger,
Filter filter) |
void |
AbstractConfiguration.addLoggerFilter(Logger logger,
Filter filter)
Associates a Filter with a LoggerConfig.
|
static AppenderRef |
AppenderRef.createAppenderRef(java.lang.String ref,
Level level,
Filter filter)
Create an Appender reference.
|
static LoggerConfig |
LoggerConfig.createLogger(boolean additivity,
Level level,
java.lang.String loggerName,
java.lang.String includeLocation,
AppenderRef[] refs,
Property[] properties,
Configuration config,
Filter filter)
Factory method to create a LoggerConfig.
|
static LoggerConfig |
LoggerConfig.RootLogger.createLogger(java.lang.String additivity,
Level level,
java.lang.String includeLocation,
AppenderRef[] refs,
Property[] properties,
Configuration config,
Filter filter) |
static LoggerConfig |
LoggerConfig.createLogger(java.lang.String additivity,
Level level,
java.lang.String loggerName,
java.lang.String includeLocation,
AppenderRef[] refs,
Property[] properties,
Configuration config,
Filter filter)
Deprecated.
|
Constructor and Description |
---|
AppenderControl(Appender appender,
Level level,
Filter filter)
Constructor.
|
AppenderRef(java.lang.String ref,
Level level,
Filter filter) |
LoggerConfig(java.lang.String name,
java.util.List<AppenderRef> appenders,
Filter filter,
Level level,
boolean additive,
Property[] properties,
Configuration config,
boolean includeLocation) |
Modifier and Type | Class and Description |
---|---|
class |
AbstractFilter
Users should extend this class to implement filters.
|
class |
BurstFilter
The
BurstFilter is a logging filter that regulates logging traffic. |
class |
CompositeFilter
Composes and invokes one or more filters.
|
class |
DynamicThresholdFilter
Compares against a log level that is associated with a context value.
|
class |
LevelRangeFilter
This filter returns the
onMatch result if the level in the LogEvent is in the range of the configured
min and max levels, otherwise it returns onMismatch value . |
class |
MapFilter
A Filter that operates on a Map.
|
class |
MarkerFilter
This filter returns the onMatch result if the marker in the LogEvent is the same as or has the
configured marker as a parent.
|
class |
RegexFilter
This filter returns the onMatch result if the message matches the regular expression.
|
class |
ScriptFilter
Returns the onMatch result if the script returns True and returns the onMisMatch value otherwise.
|
class |
StructuredDataFilter
Filter based on data in a StructuredDataMessage.
|
class |
ThreadContextMapFilter
Filter based on a value in the Thread Context Map (MDC).
|
class |
ThresholdFilter
This filter returns the onMatch result if the level in the LogEvent is the same or more specific
than the configured level and the onMismatch value otherwise.
|
class |
TimeFilter
Filters events that fall within a specified time period in each day.
|
Modifier and Type | Field and Description |
---|---|
private static Filter[] |
CompositeFilter.EMPTY_FILTERS |
private Filter |
AbstractFilterable.filter
May be null.
|
private Filter |
AbstractFilterable.Builder.filter |
private Filter[] |
CompositeFilter.filters |
Modifier and Type | Method and Description |
---|---|
Filter |
AbstractFilterable.getFilter()
Returns the Filter.
|
Filter |
AbstractFilterable.Builder.getFilter() |
Filter |
Filterable.getFilter()
Returns an Iterator for all the Filters.
|
Filter[] |
CompositeFilter.getFiltersArray() |
Modifier and Type | Method and Description |
---|---|
java.util.List<Filter> |
CompositeFilter.getFilters()
Deprecated.
|
java.util.Iterator<Filter> |
CompositeFilter.iterator() |
Modifier and Type | Method and Description |
---|---|
CompositeFilter |
CompositeFilter.addFilter(Filter filter) |
void |
AbstractFilterable.addFilter(Filter filter)
Adds a filter.
|
void |
Filterable.addFilter(Filter filter)
Adds a new Filter.
|
static CompositeFilter |
CompositeFilter.createFilters(Filter[] filters)
Create a CompositeFilter.
|
CompositeFilter |
CompositeFilter.removeFilter(Filter filter) |
void |
AbstractFilterable.removeFilter(Filter filter)
Removes a Filter.
|
void |
Filterable.removeFilter(Filter filter)
Removes a Filter.
|
B |
AbstractFilterable.Builder.withFilter(Filter filter) |
Constructor and Description |
---|
AbstractFilterable(Filter filter) |
CompositeFilter(Filter[] filters) |