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.db |
The classes in this package and sub packages provide appenders for various types of databases and methods for
accessing databases.
|
org.apache.logging.log4j.core.appender.db.jdbc |
The JDBC Appender supports writing log events to a relational database using standard JDBC connections.
|
org.apache.logging.log4j.core.appender.db.jpa |
The JPA Appender supports writing log events to a relational database using the Java Persistence API.
|
org.apache.logging.log4j.core.appender.mom |
Message oriented middleware appenders.
|
org.apache.logging.log4j.core.appender.mom.jeromq |
Classes and interfaces for ZeroMQ/JeroMQ support.
|
org.apache.logging.log4j.core.appender.nosql |
The NoSQL Appender supports writing log events to NoSQL databases.
|
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.
|
org.apache.logging.log4j.web.appender |
Modifier and Type | Method | Description |
---|---|---|
Iterator<Filter> |
Logger.getFilters() |
This method is not exposed through the public API and is used primarily for unit testing.
|
Modifier and Type | Method | Description |
---|---|---|
void |
Logger.addFilter(Filter filter) |
This method is not exposed through the public API and is used primarily for unit testing.
|
void |
LoggerContext.addFilter(Filter filter) |
Adds a Filter to the Configuration.
|
void |
LoggerContext.removeFilter(Filter filter) |
Removes a Filter from the current Configuration.
|
Modifier and Type | Method | Description |
---|---|---|
static AsyncAppender |
AsyncAppender.createAppender(AppenderRef[] appenderRefs,
String errorRef,
boolean blocking,
long shutdownTimeout,
int size,
String name,
boolean includeLocation,
Filter filter,
Configuration config,
boolean ignoreExceptions) |
Deprecated.
use
AsyncAppender.Builder instead |
static ConsoleAppender |
ConsoleAppender.createAppender(Layout<? extends Serializable> layout,
Filter filter,
String targetStr,
String name,
String follow,
String ignore) |
Deprecated.
Deprecated in 2.7; use
ConsoleAppender.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; use
ConsoleAppender.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>> |
FileAppender.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>> |
MemoryMappedFileAppender.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>> |
RandomAccessFileAppender.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>> |
RollingFileAppender.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>> |
RollingRandomAccessFileAppender.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) |
Create a SmtpAppender.
|
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; use
SocketAppender.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; use
SocketAppender.newBuilder() |
static <B extends SyslogAppender.Builder<B>> |
SyslogAppender.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.
|
AsyncAppender.Builder |
AsyncAppender.Builder.setFilter(Filter filter) |
|
OutputStreamAppender.Builder |
OutputStreamAppender.Builder.setFilter(Filter aFilter) |
|
WriterAppender.Builder |
WriterAppender.Builder.setFilter(Filter aFilter) |
Constructor | Description |
---|---|
AbstractAppender(String name,
Filter filter,
Layout<? extends Serializable> layout) |
Constructor that defaults to suppressing exceptions.
|
AbstractAppender(String name,
Filter filter,
Layout<? extends Serializable> layout,
boolean ignoreExceptions) |
Constructor.
|
AbstractOutputStreamAppender(String name,
Layout<? extends 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(String name,
StringLayout layout,
Filter filter,
boolean ignoreExceptions,
boolean immediateFlush,
M manager) |
Instantiates.
|
SocketAppender(String name,
Layout<? extends Serializable> layout,
Filter filter,
AbstractSocketManager manager,
boolean ignoreExceptions,
boolean immediateFlush,
Advertiser advertiser) |
|
SyslogAppender(String name,
Layout<? extends Serializable> layout,
Filter filter,
boolean ignoreExceptions,
boolean immediateFlush,
AbstractSocketManager manager,
Advertiser advertiser) |
Constructor | Description |
---|---|
AbstractDatabaseAppender(String name,
Filter filter,
boolean ignoreExceptions,
T manager) |
Instantiates the base appender.
|
Modifier and Type | Method | Description |
---|---|---|
static <B extends JdbcAppender.Builder<B>> |
JdbcAppender.createAppender(String name,
String ignore,
Filter filter,
ConnectionSource connectionSource,
String bufferSize,
String tableName,
ColumnConfig[] columnConfigs) |
Deprecated.
|
Modifier and Type | Method | Description |
---|---|---|
static JpaAppender |
JpaAppender.createAppender(String name,
String ignore,
Filter filter,
String bufferSize,
String entityClassName,
String persistenceUnitName) |
Factory method for creating a JPA appender within the plugin manager.
|
Modifier and Type | Method | Description |
---|---|---|
JmsAppender.Builder |
JmsAppender.Builder.setFilter(Filter filter) |
Constructor | Description |
---|---|
JmsAppender(String name,
Filter filter,
Layout<? extends Serializable> layout,
boolean ignoreExceptions,
JmsManager manager) |
Modifier and Type | Method | Description |
---|---|---|
static 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) |
Modifier and Type | Method | Description |
---|---|---|
static NoSqlAppender |
NoSqlAppender.createAppender(String name,
String ignore,
Filter filter,
String bufferSize,
NoSqlProvider<?> provider) |
Factory method for creating a NoSQL appender within the plugin manager.
|
Modifier and Type | Method | Description |
---|---|---|
static RewriteAppender |
RewriteAppender.createAppender(String name,
String ignore,
AppenderRef[] appenderRefs,
Configuration config,
RewritePolicy rewritePolicy,
Filter filter) |
Creates a RewriteAppender.
|
Modifier and Type | Method | Description |
---|---|---|
static RoutingAppender |
RoutingAppender.createAppender(String name,
String ignore,
Routes routes,
Configuration config,
RewritePolicy rewritePolicy,
PurgePolicy purgePolicy,
Filter filter) |
Deprecated.
Since 2.7; use
RoutingAppender.newBuilder() |
Modifier and Type | Method | Description |
---|---|---|
static LoggerConfig |
AsyncLoggerConfig.createLogger(String additivity,
String levelName,
String loggerName,
String includeLocation,
AppenderRef[] refs,
Property[] properties,
Configuration config,
Filter filter) |
Factory method to create a LoggerConfig.
|
static LoggerConfig |
AsyncLoggerConfig.RootLogger.createLogger(String additivity,
String levelName,
String includeLocation,
AppenderRef[] refs,
Property[] properties,
Configuration config,
Filter filter) |
Constructor | Description |
---|---|
AsyncLoggerConfig(String name,
List<AppenderRef> appenders,
Filter filter,
Level level,
boolean additive,
Property[] properties,
Configuration config,
boolean includeLocation) |
Modifier and Type | Method | Description |
---|---|---|
Filter |
AppenderRef.getFilter() |
|
Filter |
LoggerConfig.getFilter() |
Modifier and Type | Method | Description |
---|---|---|
void |
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) |
Factory method to create a LoggerConfig.
|
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) |
Constructor | Description |
---|---|
AppenderControl(Appender appender,
Level level,
Filter filter) |
Constructor.
|
LoggerConfig(String name,
List<AppenderRef> appenders,
Filter filter,
Level level,
boolean additive,
Property[] properties,
Configuration config,
boolean includeLocation) |
Modifier and Type | Class | 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 | Method | Description |
---|---|---|
Filter |
AbstractFilterable.Builder.getFilter() |
|
Filter |
AbstractFilterable.getFilter() |
Returns the Filter.
|
Filter |
Filterable.getFilter() |
Returns an Iterator for all the Filters.
|
Filter[] |
CompositeFilter.getFiltersArray() |
Modifier and Type | Method | Description |
---|---|---|
List<Filter> |
CompositeFilter.getFilters() |
Deprecated.
|
Iterator<Filter> |
CompositeFilter.iterator() |
Modifier and Type | Method | Description |
---|---|---|
void |
AbstractFilterable.addFilter(Filter filter) |
Adds a filter.
|
CompositeFilter |
CompositeFilter.addFilter(Filter filter) |
|
void |
Filterable.addFilter(Filter filter) |
Adds a new Filter.
|
static CompositeFilter |
CompositeFilter.createFilters(Filter[] filters) |
Create a CompositeFilter.
|
void |
AbstractFilterable.removeFilter(Filter filter) |
Removes a Filter.
|
CompositeFilter |
CompositeFilter.removeFilter(Filter filter) |
|
void |
Filterable.removeFilter(Filter filter) |
Removes a Filter.
|
B |
AbstractFilterable.Builder.withFilter(Filter filter) |
Constructor | Description |
---|---|
AbstractFilterable(Filter filter) |
Modifier and Type | Method | Description |
---|---|---|
static ServletAppender |
ServletAppender.createAppender(Layout<? extends Serializable> layout,
Filter filter,
String name,
boolean ignoreExceptions) |
Deprecated.
|
Copyright © 1999-2018. 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.