Uses of Interface
org.apache.logging.log4j.core.Filter
Packages that use Filter
Package
Description
Implementation of Log4j 2.
Log4j 2 Appenders.
The classes in this package and sub packages provide appenders for various types of databases and methods for
accessing databases.
The JDBC Appender supports writing log events to a relational database using standard JDBC connections.
Message oriented middleware appenders.
Classes and interfaces for ZeroMQ/JeroMQ support.
Classes and interfaces for Kafka appender support.
The NoSQL Appender supports writing log events to NoSQL databases.
Apache Flume Appender.
Apache Flume Appender.
Provides Asynchronous Logger classes and interfaces for low-latency logging.
Configuration of Log4j 2.
Log4j 2 Filter support.
-
Uses of Filter in org.apache.logging.log4j.core
Fields in org.apache.logging.log4j.core declared as FilterMethods in org.apache.logging.log4j.core that return types with arguments of type FilterModifier and TypeMethodDescriptionLogger.getFilters()
This method is not exposed through the public API and is used primarily for unit testing.Methods in org.apache.logging.log4j.core with parameters of type FilterModifier and TypeMethodDescriptionvoid
This method is not exposed through the public API and is used primarily for unit testing.void
Adds a Filter to the Configuration.void
LoggerContext.removeFilter
(Filter filter) Removes a Filter from the current Configuration. -
Uses of Filter in org.apache.logging.log4j.core.appender
Methods in org.apache.logging.log4j.core.appender with parameters of type FilterModifier and TypeMethodDescriptionstatic AsyncAppender
AsyncAppender.createAppender
(AppenderRef[] appenderRefs, String errorRef, boolean blocking, long shutdownTimeout, int size, String name, boolean includeLocation, Filter filter, Configuration config, boolean ignoreExceptions) Deprecated.static ConsoleAppender
ConsoleAppender.createAppender
(Layout<? extends Serializable> layout, Filter filter, String targetStr, String name, String follow, String ignore) Deprecated.Deprecated in 2.7; useConsoleAppender.newBuilder()
.static ConsoleAppender
ConsoleAppender.createAppender
(Layout<? extends Serializable> layout, Filter filter, ConsoleAppender.Target target, String name, boolean follow, boolean direct, boolean ignoreExceptions) Deprecated.Deprecated in 2.7; useConsoleAppender.newBuilder()
.static FailoverAppender
FailoverAppender.createAppender
(String name, String primary, String[] failovers, String retryIntervalSeconds, Configuration config, Filter filter, String ignore) Create a Failover Appender.static <B extends FileAppender.Builder<B>>
FileAppenderFileAppender.createAppender
(String fileName, String append, String locking, String name, String immediateFlush, String ignoreExceptions, String bufferedIo, String bufferSizeStr, Layout<? extends Serializable> layout, Filter filter, String advertise, String advertiseUri, Configuration config) Deprecated.static <B extends MemoryMappedFileAppender.Builder<B>>
MemoryMappedFileAppenderMemoryMappedFileAppender.createAppender
(String fileName, String append, String name, String immediateFlush, String regionLengthStr, String ignore, Layout<? extends Serializable> layout, Filter filter, String advertise, String advertiseURI, Configuration config) Deprecated.static OutputStreamAppender
OutputStreamAppender.createAppender
(Layout<? extends Serializable> layout, Filter filter, OutputStream target, String name, boolean follow, boolean ignore) Creates an OutputStream Appender.static <B extends RandomAccessFileAppender.Builder<B>>
RandomAccessFileAppenderRandomAccessFileAppender.createAppender
(String fileName, String append, String name, String immediateFlush, String bufferSizeStr, String ignore, Layout<? extends Serializable> layout, Filter filter, String advertise, String advertiseURI, Configuration configuration) Deprecated.static <B extends RollingFileAppender.Builder<B>>
RollingFileAppenderRollingFileAppender.createAppender
(String fileName, String filePattern, String append, String name, String bufferedIO, String bufferSizeStr, String immediateFlush, TriggeringPolicy policy, RolloverStrategy strategy, Layout<? extends Serializable> layout, Filter filter, String ignore, String advertise, String advertiseUri, Configuration config) Deprecated.static <B extends RollingRandomAccessFileAppender.Builder<B>>
RollingRandomAccessFileAppenderRollingRandomAccessFileAppender.createAppender
(String fileName, String filePattern, String append, String name, String immediateFlush, String bufferSizeStr, TriggeringPolicy policy, RolloverStrategy strategy, Layout<? extends Serializable> layout, Filter filter, String ignoreExceptions, String advertise, String advertiseURI, Configuration configuration) Deprecated.static SmtpAppender
SmtpAppender.createAppender
(Configuration config, String name, String to, String cc, String bcc, String from, String replyTo, String subject, String smtpProtocol, String smtpHost, String smtpPortStr, String smtpUsername, String smtpPassword, String smtpDebug, String bufferSizeStr, Layout<? extends Serializable> layout, Filter filter, String ignore) Deprecated.UseSmtpAppender.newBuilder()
to create and configure aSmtpAppender.Builder
instance.static SocketAppender
SocketAppender.createAppender
(String host, int port, Protocol protocol, SslConfiguration sslConfig, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, String name, boolean immediateFlush, boolean ignoreExceptions, Layout<? extends Serializable> layout, Filter filter, boolean advertise, Configuration configuration) Deprecated.Deprecated in 2.7; useSocketAppender.newBuilder()
static SocketAppender
SocketAppender.createAppender
(String host, String portNum, String protocolIn, SslConfiguration sslConfig, int connectTimeoutMillis, String delayMillis, String immediateFail, String name, String immediateFlush, String ignore, Layout<? extends Serializable> layout, Filter filter, String advertise, Configuration config) Deprecated.Deprecated in 2.5; useSocketAppender.newBuilder()
static <B extends SyslogAppender.Builder<B>>
SyslogAppenderSyslogAppender.createAppender
(String host, int port, String protocolStr, SslConfiguration sslConfiguration, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, String name, boolean immediateFlush, boolean ignoreExceptions, Facility facility, String id, int enterpriseNumber, boolean includeMdc, String mdcId, String mdcPrefix, String eventPrefix, boolean newLine, String escapeNL, String appName, String msgId, String excludes, String includes, String required, String format, Filter filter, Configuration configuration, Charset charset, String exceptionPattern, LoggerFields[] loggerFields, boolean advertise) Deprecated.static WriterAppender
WriterAppender.createAppender
(StringLayout layout, Filter filter, Writer target, String name, boolean follow, boolean ignore) Creates a WriterAppender.Specifies the filter used for this appender.Constructors in org.apache.logging.log4j.core.appender with parameters of type FilterModifierConstructorDescriptionprotected
AbstractAppender
(String name, Filter filter, Layout<? extends Serializable> layout) Deprecated.protected
AbstractAppender
(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions) Deprecated.protected
AbstractAppender
(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties) Constructor.protected
AbstractOutputStreamAppender
(String name, Layout<? extends Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, M manager) protected
AbstractOutputStreamAppender
(String name, Layout<? extends Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, Property[] properties, M manager) Instantiates a WriterAppender and set the output destination to a newOutputStreamWriter
initialized withos
as itsOutputStream
.protected
AbstractWriterAppender
(String name, StringLayout layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, M manager) protected
AbstractWriterAppender
(String name, StringLayout layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, Property[] properties, M manager) Instantiates.protected
SocketAppender
(String name, Layout<? extends Serializable> layout, Filter filter, AbstractSocketManager manager, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser) protected
SocketAppender
(String name, Layout<? extends Serializable> layout, Filter filter, AbstractSocketManager manager, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser, Property[] properties) protected
SyslogAppender
(String name, Layout<? extends Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, AbstractSocketManager manager, Advertiser advertiser) protected
SyslogAppender
(String name, Layout<? extends Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, AbstractSocketManager manager, Advertiser advertiser, Property[] properties) -
Uses of Filter in org.apache.logging.log4j.core.appender.db
Constructors in org.apache.logging.log4j.core.appender.db with parameters of type FilterModifierConstructorDescriptionprotected
AbstractDatabaseAppender
(String name, Filter filter, boolean ignoreExceptions, T manager) protected
AbstractDatabaseAppender
(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties, T manager) Instantiates the base appender.protected
AbstractDatabaseAppender
(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, T manager) -
Uses of Filter in org.apache.logging.log4j.core.appender.db.jdbc
Methods in org.apache.logging.log4j.core.appender.db.jdbc with parameters of type FilterModifier and TypeMethodDescriptionstatic <B extends JdbcAppender.Builder<B>>
JdbcAppenderJdbcAppender.createAppender
(String name, String ignore, Filter filter, ConnectionSource connectionSource, String bufferSize, String tableName, ColumnConfig[] columnConfigs) Deprecated. -
Uses of Filter in org.apache.logging.log4j.core.appender.mom
Constructors in org.apache.logging.log4j.core.appender.mom with parameters of type FilterModifierConstructorDescriptionprotected
JmsAppender
(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, JmsManager manager) Deprecated.protected
JmsAppender
(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties, JmsManager manager) Constructs a new instance. -
Uses of Filter in org.apache.logging.log4j.core.appender.mom.jeromq
Methods in org.apache.logging.log4j.core.appender.mom.jeromq with parameters of type FilterModifier and TypeMethodDescriptionstatic JeroMqAppender
JeroMqAppender.createAppender
(String name, Layout<?> layout, Filter filter, Property[] properties, boolean ignoreExceptions, long affinity, long backlog, boolean delayAttachOnConnect, byte[] identity, boolean ipv4Only, long linger, long maxMsgSize, long rcvHwm, long receiveBufferSize, int receiveTimeOut, long reconnectIVL, long reconnectIVLMax, long sendBufferSize, int sendTimeOut, long sndHwm, int tcpKeepAlive, long tcpKeepAliveCount, long tcpKeepAliveIdle, long tcpKeepAliveInterval, boolean xpubVerbose) -
Uses of Filter in org.apache.logging.log4j.core.appender.mom.kafka
Methods in org.apache.logging.log4j.core.appender.mom.kafka with parameters of type FilterModifier and TypeMethodDescriptionstatic KafkaAppender
KafkaAppender.createAppender
(Layout<? extends Serializable> layout, Filter filter, String name, boolean ignoreExceptions, String topic, Property[] properties, Configuration configuration, String key) Deprecated. -
Uses of Filter in org.apache.logging.log4j.core.appender.nosql
Methods in org.apache.logging.log4j.core.appender.nosql with parameters of type FilterModifier and TypeMethodDescriptionstatic NoSqlAppender
NoSqlAppender.createAppender
(String name, String ignore, Filter filter, String bufferSize, NoSqlProvider<?> provider) Deprecated.since 2.11.0; useNoSqlAppender.Builder
. -
Uses of Filter in org.apache.logging.log4j.core.appender.rewrite
Methods in org.apache.logging.log4j.core.appender.rewrite with parameters of type FilterModifier and TypeMethodDescriptionstatic RewriteAppender
RewriteAppender.createAppender
(String name, String ignore, AppenderRef[] appenderRefs, Configuration config, RewritePolicy rewritePolicy, Filter filter) Creates a RewriteAppender. -
Uses of Filter in org.apache.logging.log4j.core.appender.routing
Methods in org.apache.logging.log4j.core.appender.routing with parameters of type FilterModifier and TypeMethodDescriptionstatic RoutingAppender
RoutingAppender.createAppender
(String name, String ignore, Routes routes, Configuration config, RewritePolicy rewritePolicy, PurgePolicy purgePolicy, Filter filter) Deprecated.Since 2.7; useRoutingAppender.newBuilder()
-
Uses of Filter in org.apache.logging.log4j.core.async
Methods in org.apache.logging.log4j.core.async with parameters of type FilterModifier and TypeMethodDescriptionstatic LoggerConfig
AsyncLoggerConfig.createLogger
(boolean additivity, Level level, String loggerName, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter) Deprecated.static LoggerConfig
AsyncLoggerConfig.createLogger
(String additivity, String levelName, String loggerName, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter) static LoggerConfig
AsyncLoggerConfig.RootLogger.createLogger
(String additivity, String levelName, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter) static LoggerConfig
AsyncLoggerConfig.RootLogger.createLogger
(String additivity, Level level, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter) Deprecated.Constructors in org.apache.logging.log4j.core.async with parameters of type FilterModifierConstructorDescriptionprotected
AsyncLoggerConfig
(String name, List<AppenderRef> appenders, Filter filter, Level level, boolean additive, Property[] properties, Configuration config, boolean includeLocation) -
Uses of Filter in org.apache.logging.log4j.core.config
Methods in org.apache.logging.log4j.core.config that return FilterModifier and TypeMethodDescriptionAppenderRef.getFilter()
LoggerConfig.Builder.getFilter()
LoggerConfig.getFilter()
LoggerConfig.RootLogger.Builder.getFilter()
Methods in org.apache.logging.log4j.core.config with parameters of type FilterModifier and TypeMethodDescriptionvoid
LoggerConfig.addAppender
(Appender appender, Level level, Filter filter) Adds an Appender to the LoggerConfig.void
AbstractConfiguration.addLoggerFilter
(Logger logger, Filter filter) Associates a Filter with a LoggerConfig.void
Configuration.addLoggerFilter
(Logger logger, Filter filter) static AppenderRef
AppenderRef.createAppenderRef
(String ref, Level level, Filter filter) Create an Appender reference.static LoggerConfig
LoggerConfig.createLogger
(boolean additivity, Level level, String loggerName, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter) Deprecated.static LoggerConfig
LoggerConfig.createLogger
(String additivity, Level level, String loggerName, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter) Deprecated.static LoggerConfig
LoggerConfig.RootLogger.createLogger
(String additivity, Level level, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter) Deprecated.LoggerConfig.Builder.withtFilter
(Filter filter) LoggerConfig.RootLogger.Builder.withtFilter
(Filter filter) Constructors in org.apache.logging.log4j.core.config with parameters of type FilterModifierConstructorDescriptionAppenderControl
(Appender appender, Level level, Filter filter) Constructor.protected
LoggerConfig
(String name, List<AppenderRef> appenders, Filter filter, Level level, boolean additive, Property[] properties, Configuration config, boolean includeLocation) -
Uses of Filter in org.apache.logging.log4j.core.filter
Classes in org.apache.logging.log4j.core.filter that implement FilterModifier and TypeClassDescriptionclass
Users should extend this class to implement filters.final class
TheBurstFilter
is a logging filter that regulates logging traffic.final class
Composes and invokes one or more filters.final class
This filter causes all logging events to be dropped.final class
Compares against a log level that is associated with a context value.final class
This filter returns the onMatch result if the logging level in the event matches the specified logging level exactly.final class
This filter returns theAbstractFilter.onMatch
result if the level of theLogEvent
is in the range of the configuredLevelRangeFilter.minLevel
andLevelRangeFilter.maxLevel
values, otherwise it returns theAbstractFilter.onMismatch
result.class
A Filter that operates on a Map.final class
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
Filter based on a value in the Thread Context Map (MDC).final class
This filter returns the onMatch result if there is no marker in the LogEvent.final class
This filter returns the onMatch result if the message matches the regular expression.final class
Returns the onMatch result if the script returns True and returns the onMismatch value otherwise.final class
This filter returns the onMatch result if the logging level in the event matches the specified logging level exactly.final class
Filter based on data in a StructuredDataMessage.class
Filter based on a value in the Thread Context Map (MDC).final class
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.final class
Filters events that fall within a specified time period in each day.Methods in org.apache.logging.log4j.core.filter that return FilterModifier and TypeMethodDescriptionAbstractFilterable.Builder.getFilter()
AbstractFilterable.getFilter()
Returns the Filter.Filterable.getFilter()
Returns an Iterator for all the Filters.Filter[]
CompositeFilter.getFiltersArray()
Methods in org.apache.logging.log4j.core.filter that return types with arguments of type FilterModifier and TypeMethodDescriptionCompositeFilter.getFilters()
Deprecated.CompositeFilter.iterator()
Methods in org.apache.logging.log4j.core.filter with parameters of type FilterModifier and TypeMethodDescriptionvoid
Adds a filter.void
Adds a new Filter.static CompositeFilter
CompositeFilter.createFilters
(Filter[] filters) Creates a CompositeFilter.void
AbstractFilterable.removeFilter
(Filter filter) Removes a Filter.CompositeFilter.removeFilter
(Filter filter) void
Filterable.removeFilter
(Filter filter) Removes a Filter.AbstractFilterable.Builder.withFilter
(Filter filter) Deprecated.Constructors in org.apache.logging.log4j.core.filter with parameters of type FilterModifierConstructorDescriptionprotected
AbstractFilterable
(Filter filter) protected
AbstractFilterable
(Filter filter, Property[] propertyArray)
AsyncAppender.Builder
instead