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.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.mom.kafka |
Classes and interfaces for Kafka appender support.
|
org.apache.logging.log4j.core.appender.rolling |
Rolling File Appender and support classes.
|
org.apache.logging.log4j.core.layout |
Log4j 2 Layout support.
|
org.apache.logging.log4j.core.net |
Log4j 2 network support.
|
Modifier and Type | Interface and Description |
---|---|
interface |
StringLayout
Instantiates the @{link Layout} type for String-based layouts.
|
Modifier and Type | Method and Description |
---|---|
Layout<? extends Serializable> |
Appender.getLayout()
Returns the Layout used by this Appender if applicable.
|
Modifier and Type | Field and Description |
---|---|
protected Layout<?> |
OutputStreamManager.layout |
Modifier and Type | Method and Description |
---|---|
Layout<? extends Serializable> |
AbstractAppender.getLayout()
Returns the Layout for the appender.
|
Layout<? extends Serializable> |
AbstractAppender.Builder.getLayout() |
Layout<? extends Serializable> |
AbstractAppender.Builder.getOrCreateLayout() |
Layout<? extends Serializable> |
AbstractAppender.Builder.getOrCreateLayout(Charset charset) |
Modifier and Type | Method and Description |
---|---|
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.
Use
SmtpAppender.newBuilder() to create and configure a SmtpAppender.Builder instance. |
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 OutputStreamAppender |
OutputStreamAppender.createAppender(Layout<? extends Serializable> layout,
Filter filter,
OutputStream target,
String name,
boolean follow,
boolean ignore)
Creates an OutputStream Appender.
|
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 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 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 <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 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 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 ConsoleAppender |
ConsoleAppender.createDefaultAppenderForLayout(Layout<? extends Serializable> layout) |
protected static AbstractSocketManager |
SocketAppender.createSocketManager(String name,
Protocol protocol,
String host,
int port,
int connectTimeoutMillis,
SslConfiguration sslConfig,
int reconnectDelayMillis,
boolean immediateFail,
Layout<? extends Serializable> layout,
int bufferSize)
|
protected static AbstractSocketManager |
SocketAppender.createSocketManager(String name,
Protocol protocol,
String host,
int port,
int connectTimeoutMillis,
SslConfiguration sslConfig,
int reconnectDelayMillis,
boolean immediateFail,
Layout<? extends Serializable> layout,
int bufferSize,
SocketOptions socketOptions)
Creates an AbstractSocketManager for TCP, UDP, and SSL.
|
static FileManager |
FileManager.getFileManager(String fileName,
boolean append,
boolean locking,
boolean bufferedIo,
boolean createOnDemand,
String advertiseUri,
Layout<? extends Serializable> layout,
int bufferSize,
String filePermissions,
String fileOwner,
String fileGroup,
Configuration configuration)
Returns the FileManager.
|
static MemoryMappedFileManager |
MemoryMappedFileManager.getFileManager(String fileName,
boolean append,
boolean immediateFlush,
int regionLength,
String advertiseURI,
Layout<? extends Serializable> layout)
Returns the MemoryMappedFileManager.
|
static RandomAccessFileManager |
RandomAccessFileManager.getFileManager(String fileName,
boolean append,
boolean immediateFlush,
int bufferSize,
String advertiseURI,
Layout<? extends Serializable> layout,
Configuration configuration)
Returns the RandomAccessFileManager.
|
void |
HttpURLConnectionManager.send(Layout<?> layout,
LogEvent event) |
abstract void |
HttpManager.send(Layout<?> layout,
LogEvent event) |
B |
AbstractAppender.Builder.setLayout(Layout<? extends Serializable> layout) |
SmtpAppender.Builder |
SmtpAppender.Builder.setLayout(Layout<? extends Serializable> layout)
Specifies the layout used for the email message body.
|
B |
AbstractAppender.Builder.withLayout(Layout<? extends Serializable> layout)
Deprecated.
|
Constructor and Description |
---|
AbstractAppender(String name,
Filter filter,
Layout<? extends Serializable> layout)
|
AbstractAppender(String name,
Filter filter,
Layout<? extends Serializable> layout,
boolean ignoreExceptions)
|
AbstractAppender(String name,
Filter filter,
Layout<? extends Serializable> layout,
boolean ignoreExceptions,
Property[] properties)
Constructor.
|
AbstractOutputStreamAppender(String name,
Layout<? extends Serializable> layout,
Filter filter,
boolean ignoreExceptions,
boolean immediateFlush,
M manager)
|
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 new
OutputStreamWriter
initialized with os as its OutputStream . |
CountingNoOpAppender(String name,
Layout<?> layout) |
FileManager(LoggerContext loggerContext,
String fileName,
OutputStream os,
boolean append,
boolean locking,
boolean createOnDemand,
String advertiseURI,
Layout<? extends Serializable> layout,
boolean writeHeader,
ByteBuffer buffer)
Deprecated.
|
FileManager(LoggerContext loggerContext,
String fileName,
OutputStream os,
boolean append,
boolean locking,
boolean createOnDemand,
String advertiseURI,
Layout<? extends Serializable> layout,
String filePermissions,
String fileOwner,
String fileGroup,
boolean writeHeader,
ByteBuffer buffer) |
FileManager(String fileName,
OutputStream os,
boolean append,
boolean locking,
String advertiseURI,
Layout<? extends Serializable> layout,
boolean writeHeader,
ByteBuffer buffer)
Deprecated.
|
FileManager(String fileName,
OutputStream os,
boolean append,
boolean locking,
String advertiseURI,
Layout<? extends Serializable> layout,
int bufferSize,
boolean writeHeader)
Deprecated.
|
MemoryMappedFileManager(RandomAccessFile file,
String fileName,
OutputStream os,
boolean immediateFlush,
long position,
int regionLength,
String advertiseURI,
Layout<? extends Serializable> layout,
boolean writeHeader) |
OutputStreamManager(LoggerContext loggerContext,
OutputStream os,
String streamName,
boolean createOnDemand,
Layout<? extends Serializable> layout,
boolean writeHeader,
ByteBuffer byteBuffer) |
OutputStreamManager(OutputStream os,
String streamName,
Layout<?> layout,
boolean writeHeader) |
OutputStreamManager(OutputStream os,
String streamName,
Layout<?> layout,
boolean writeHeader,
ByteBuffer byteBuffer)
Deprecated.
|
OutputStreamManager(OutputStream os,
String streamName,
Layout<?> layout,
boolean writeHeader,
int bufferSize) |
RandomAccessFileManager(LoggerContext loggerContext,
RandomAccessFile file,
String fileName,
OutputStream os,
int bufferSize,
String advertiseURI,
Layout<? extends Serializable> layout,
boolean writeHeader) |
SocketAppender(String name,
Layout<? extends Serializable> layout,
Filter filter,
AbstractSocketManager manager,
boolean ignoreExceptions,
boolean immediateFlush,
Advertiser advertiser)
|
SocketAppender(String name,
Layout<? extends Serializable> layout,
Filter filter,
AbstractSocketManager manager,
boolean ignoreExceptions,
boolean immediateFlush,
Advertiser advertiser,
Property[] properties) |
SyslogAppender(String name,
Layout<? extends Serializable> layout,
Filter filter,
boolean ignoreExceptions,
boolean immediateFlush,
AbstractSocketManager manager,
Advertiser advertiser)
|
SyslogAppender(String name,
Layout<? extends Serializable> layout,
Filter filter,
boolean ignoreExceptions,
boolean immediateFlush,
AbstractSocketManager manager,
Advertiser advertiser,
Property[] properties) |
Modifier and Type | Method and Description |
---|---|
Layout<LogEvent> |
AbstractDatabaseAppender.getLayout()
This always returns
null , as database appenders do not use a single layout. |
Layout<? extends Serializable> |
AbstractDatabaseManager.AbstractFactoryData.getLayout()
Gets the layout.
|
Constructor and Description |
---|
AbstractDatabaseAppender(String name,
Filter filter,
Layout<? extends Serializable> layout,
boolean ignoreExceptions,
Property[] properties,
T manager)
Instantiates the base appender.
|
AbstractDatabaseAppender(String name,
Filter filter,
Layout<? extends Serializable> layout,
boolean ignoreExceptions,
T manager)
|
AbstractDatabaseManager(String name,
int bufferSize,
Layout<? extends Serializable> layout)
Instantiates the base manager.
|
AbstractFactoryData(int bufferSize,
Layout<? extends Serializable> layout)
Constructs the base factory data.
|
Modifier and Type | Method and Description |
---|---|
static JdbcDatabaseManager |
JdbcDatabaseManager.getManager(String name,
int bufferSize,
Layout<? extends Serializable> layout,
ConnectionSource connectionSource,
String tableName,
ColumnConfig[] columnConfigs,
ColumnMapping[] columnMappings)
Deprecated.
|
static JdbcDatabaseManager |
JdbcDatabaseManager.getManager(String name,
int bufferSize,
Layout<? extends Serializable> layout,
ConnectionSource connectionSource,
String tableName,
ColumnConfig[] columnConfigs,
ColumnMapping[] columnMappings,
boolean immediateFail,
long reconnectIntervalMillis)
|
static JdbcDatabaseManager |
JdbcDatabaseManager.getManager(String name,
int bufferSize,
Layout<? extends Serializable> layout,
ConnectionSource connectionSource,
String tableName,
ColumnConfig[] columnConfigs,
ColumnMapping[] columnMappings,
boolean immediateFail,
long reconnectIntervalMillis,
boolean truncateStrings)
Creates a JDBC manager for use within the
JdbcAppender , or returns a suitable one if it already exists. |
Constructor and Description |
---|
JmsAppender(String name,
Filter filter,
Layout<? extends Serializable> layout,
boolean ignoreExceptions,
JmsManager manager)
Deprecated.
|
JmsAppender(String name,
Filter filter,
Layout<? extends Serializable> layout,
boolean ignoreExceptions,
Property[] properties,
JmsManager manager) |
Modifier and Type | Method and 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 and Description |
---|---|
static KafkaAppender |
KafkaAppender.createAppender(Layout<? extends Serializable> layout,
Filter filter,
String name,
boolean ignoreExceptions,
String topic,
Property[] properties,
Configuration configuration,
String key)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static RollingFileManager |
RollingFileManager.getFileManager(String fileName,
String pattern,
boolean append,
boolean bufferedIO,
TriggeringPolicy policy,
RolloverStrategy strategy,
String advertiseURI,
Layout<? extends Serializable> layout,
int bufferSize,
boolean immediateFlush,
boolean createOnDemand,
String filePermissions,
String fileOwner,
String fileGroup,
Configuration configuration)
Returns a RollingFileManager.
|
static RollingRandomAccessFileManager |
RollingRandomAccessFileManager.getRollingRandomAccessFileManager(String fileName,
String filePattern,
boolean isAppend,
boolean immediateFlush,
int bufferSize,
TriggeringPolicy policy,
RolloverStrategy strategy,
String advertiseURI,
Layout<? extends Serializable> layout,
String filePermissions,
String fileOwner,
String fileGroup,
Configuration configuration) |
Constructor and Description |
---|
RollingFileManager(LoggerContext loggerContext,
String fileName,
String pattern,
OutputStream os,
boolean append,
boolean createOnDemand,
long size,
long initialTime,
TriggeringPolicy triggeringPolicy,
RolloverStrategy rolloverStrategy,
String advertiseURI,
Layout<? extends Serializable> layout,
boolean writeHeader,
ByteBuffer buffer)
Deprecated.
|
RollingFileManager(LoggerContext loggerContext,
String fileName,
String pattern,
OutputStream os,
boolean append,
boolean createOnDemand,
long size,
long initialTime,
TriggeringPolicy triggeringPolicy,
RolloverStrategy rolloverStrategy,
String advertiseURI,
Layout<? extends Serializable> layout,
String filePermissions,
String fileOwner,
String fileGroup,
boolean writeHeader,
ByteBuffer buffer) |
RollingFileManager(String fileName,
String pattern,
OutputStream os,
boolean append,
long size,
long initialTime,
TriggeringPolicy triggeringPolicy,
RolloverStrategy rolloverStrategy,
String advertiseURI,
Layout<? extends Serializable> layout,
boolean writeHeader,
ByteBuffer buffer)
Deprecated.
|
RollingFileManager(String fileName,
String pattern,
OutputStream os,
boolean append,
long size,
long initialTime,
TriggeringPolicy triggeringPolicy,
RolloverStrategy rolloverStrategy,
String advertiseURI,
Layout<? extends Serializable> layout,
int bufferSize,
boolean writeHeader)
Deprecated.
|
RollingRandomAccessFileManager(LoggerContext loggerContext,
RandomAccessFile raf,
String fileName,
String pattern,
OutputStream os,
boolean append,
boolean immediateFlush,
int bufferSize,
long size,
long time,
TriggeringPolicy policy,
RolloverStrategy strategy,
String advertiseURI,
Layout<? extends Serializable> layout,
boolean writeHeader)
Deprecated.
|
RollingRandomAccessFileManager(LoggerContext loggerContext,
RandomAccessFile raf,
String fileName,
String pattern,
OutputStream os,
boolean append,
boolean immediateFlush,
int bufferSize,
long size,
long initialTime,
TriggeringPolicy policy,
RolloverStrategy strategy,
String advertiseURI,
Layout<? extends Serializable> layout,
String filePermissions,
String fileOwner,
String fileGroup,
boolean writeHeader) |
Modifier and Type | Class and Description |
---|---|
class |
AbstractCsvLayout
A superclass for Comma-Separated Value (CSV) layouts.
|
class |
AbstractLayout<T extends Serializable>
Abstract base class for Layouts.
|
class |
AbstractStringLayout
Abstract base class for Layouts that result in a String.
|
class |
CsvLogEventLayout
A Comma-Separated Value (CSV) layout to log events.
|
class |
CsvParameterLayout
A Comma-Separated Value (CSV) layout to log event parameters.
|
class |
GelfLayout
Lays out events in the Graylog Extended Log Format (GELF) 1.1.
|
class |
HtmlLayout
Outputs events as rows in an HTML table on an HTML page.
|
class |
JsonLayout
Appends a series of JSON events as strings serialized as bytes.
|
class |
MessageLayout
Formats a
LogEvent in its Message form. |
class |
PatternLayout
A flexible layout configurable with pattern string.
|
class |
Rfc5424Layout
Formats a log event in accordance with RFC 5424.
|
class |
SerializedLayout
Deprecated.
Java Serialization has inherent security weaknesses, see https://www.owasp.org/index.php/Deserialization_of_untrusted_data .
Using this layout is no longer recommended. An alternative layout containing the same information is
JsonLayout when configured with properties="true". Deprecated since 2.9. |
class |
SyslogLayout
Formats a log event as a BSD Log record.
|
class |
XmlLayout
Appends a series of
event elements as defined in the log4j.dtd. |
class |
YamlLayout
Appends a series of YAML events as strings serialized as bytes.
|
Modifier and Type | Method and Description |
---|---|
static Layout<?> |
MessageLayout.createLayout() |
Modifier and Type | Method and Description |
---|---|
protected byte[] |
SmtpManager.formatContentToBytes(LogEvent[] priorEvents,
LogEvent appendEvent,
Layout<?> layout) |
static SslSocketManager |
SslSocketManager.getSocketManager(SslConfiguration sslConfig,
String host,
int port,
int connectTimeoutMillis,
int reconnectDelayMillis,
boolean immediateFail,
Layout<? extends Serializable> layout,
int bufferSize)
|
static SslSocketManager |
SslSocketManager.getSocketManager(SslConfiguration sslConfig,
String host,
int port,
int connectTimeoutMillis,
int reconnectDelayMillis,
boolean immediateFail,
Layout<? extends Serializable> layout,
int bufferSize,
SocketOptions socketOptions) |
static TcpSocketManager |
TcpSocketManager.getSocketManager(String host,
int port,
int connectTimeoutMillis,
int reconnectDelayMillis,
boolean immediateFail,
Layout<? extends Serializable> layout,
int bufferSize)
|
static TcpSocketManager |
TcpSocketManager.getSocketManager(String host,
int port,
int connectTimeoutMillis,
int reconnectDelayMillis,
boolean immediateFail,
Layout<? extends Serializable> layout,
int bufferSize,
SocketOptions socketOptions)
Obtains a TcpSocketManager.
|
static DatagramSocketManager |
DatagramSocketManager.getSocketManager(String host,
int port,
Layout<? extends Serializable> layout,
int bufferSize)
Obtain a SocketManager.
|
void |
SmtpManager.sendEvents(Layout<?> layout,
LogEvent appendEvent)
Send the contents of the cyclic buffer as an e-mail message.
|
protected void |
SmtpManager.writeBuffer(LogEvent[] priorEvents,
LogEvent appendEvent,
Layout<?> layout,
OutputStream out) |
protected void |
SmtpManager.writeFooter(Layout<?> layout,
OutputStream out) |
protected void |
SmtpManager.writeHeader(Layout<?> layout,
OutputStream out) |
Constructor and Description |
---|
AbstractSocketManager(String name,
OutputStream os,
InetAddress inetAddress,
String host,
int port,
Layout<? extends Serializable> layout,
boolean writeHeader,
int bufferSize)
The Constructor.
|
DatagramSocketManager(String name,
OutputStream os,
InetAddress inetAddress,
String host,
int port,
Layout<? extends Serializable> layout,
int bufferSize)
The Constructor.
|
SslSocketManager(String name,
OutputStream os,
Socket sock,
SslConfiguration sslConfig,
InetAddress inetAddress,
String host,
int port,
int connectTimeoutMillis,
int reconnectionDelayMillis,
boolean immediateFail,
Layout<? extends Serializable> layout,
int bufferSize)
|
SslSocketManager(String name,
OutputStream os,
Socket sock,
SslConfiguration sslConfig,
InetAddress inetAddress,
String host,
int port,
int connectTimeoutMillis,
int reconnectionDelayMillis,
boolean immediateFail,
Layout<? extends Serializable> layout,
int bufferSize,
SocketOptions socketOptions) |
TcpSocketManager(String name,
OutputStream os,
Socket socket,
InetAddress inetAddress,
String host,
int port,
int connectTimeoutMillis,
int reconnectionDelayMillis,
boolean immediateFail,
Layout<? extends Serializable> layout,
int bufferSize)
|
TcpSocketManager(String name,
OutputStream os,
Socket socket,
InetAddress inetAddress,
String host,
int port,
int connectTimeoutMillis,
int reconnectionDelayMillis,
boolean immediateFail,
Layout<? extends Serializable> layout,
int bufferSize,
SocketOptions socketOptions)
Constructs.
|
Copyright © 1999-2021 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.