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.rewrite |
Apache Flume Appender.
|
org.apache.logging.log4j.core.appender.rolling |
Rolling File Appender and support classes.
|
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.config.plugins.util |
Utility and manager classes for Log4j 2 plugins.
|
org.apache.logging.log4j.core.config.plugins.visitors |
Visitor classes for extracting values from a Configuration or Node corresponding to a plugin annotation.
|
org.apache.logging.log4j.core.filter |
Log4j 2 Filter support.
|
org.apache.logging.log4j.core.impl |
Log4j 2 private implementation classes.
|
org.apache.logging.log4j.core.layout |
Log4j 2 Layout support.
|
org.apache.logging.log4j.core.lookup |
Log4j 2 Lookups.
|
org.apache.logging.log4j.core.net |
Log4j 2 network support.
|
org.apache.logging.log4j.core.pattern |
Provides classes implementing format specifiers in conversion patterns.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractLogEvent
An abstract log event implementation with default values for all methods.
|
Modifier and Type | Method and Description |
---|---|
void |
Appender.append(LogEvent event)
Logs a LogEvent using whatever logic this Appender wishes to use.
|
void |
ErrorHandler.error(String msg,
LogEvent event,
Throwable t)
Handle an error with a message, and exception and a logging event.
|
Filter.Result |
Filter.filter(LogEvent event)
Filter an event.
|
void |
LogEventListener.log(LogEvent event) |
void |
Logger.PrivateConfig.logEvent(LogEvent event) |
byte[] |
Layout.toByteArray(LogEvent event)
Formats the event suitable for display.
|
T |
Layout.toSerializable(LogEvent event)
Formats the event as an Object that can be serialized.
|
Modifier and Type | Method and Description |
---|---|
void |
RollingFileAppender.append(LogEvent event)
Write the log entry rolling over the file when required.
|
void |
FailoverAppender.append(LogEvent event)
Handle the Log event.
|
void |
RandomAccessFileAppender.append(LogEvent event)
Write the log entry rolling over the file when required.
|
void |
AsyncAppender.append(LogEvent logEvent)
Actual writing occurs here.
|
void |
MemoryMappedFileAppender.append(LogEvent event)
Write the log entry rolling over the file when required.
|
void |
AbstractOutputStreamAppender.append(LogEvent event)
Actual writing occurs here.
|
void |
RollingRandomAccessFileAppender.append(LogEvent event)
Write the log entry rolling over the file when required.
|
void |
SmtpAppender.append(LogEvent event)
Perform SmtpAppender specific appending actions, mainly adding the event
to a cyclic buffer and checking if the event triggers an e-mail to be
sent.
|
void |
DefaultErrorHandler.error(String msg,
LogEvent event,
Throwable t)
Handle an error with a message, and exception and a logging event.
|
void |
AbstractAppender.error(String msg,
LogEvent event,
Throwable t)
Handle an error with a message, exception, and a logging event, using the
ErrorHandler configured for
this Appender. |
boolean |
SmtpAppender.isFiltered(LogEvent event)
Capture all events in CyclicBuffer.
|
Modifier and Type | Method and Description |
---|---|
Layout<LogEvent> |
AbstractDatabaseAppender.getLayout()
This always returns
null , as database appenders do not use a single layout. |
Modifier and Type | Method and Description |
---|---|
void |
AbstractDatabaseAppender.append(LogEvent event) |
void |
AbstractDatabaseManager.write(LogEvent event)
This method manages buffering and writing of events.
|
protected abstract void |
AbstractDatabaseManager.writeInternal(LogEvent event)
Performs the actual writing of the event in an implementation-specific way.
|
Modifier and Type | Method and Description |
---|---|
protected void |
JdbcDatabaseManager.writeInternal(LogEvent event) |
Modifier and Type | Class and Description |
---|---|
class |
AbstractLogEventWrapperEntity
Users of the JPA appender MUST extend this class, using JPA annotations on the concrete class and all of its
accessor methods (as needed) to map them to the proper table and columns.
|
class |
BasicLogEventEntity
Users of the JPA appender may want to extend this class instead of
AbstractLogEventWrapperEntity . |
Modifier and Type | Method and Description |
---|---|
protected LogEvent |
AbstractLogEventWrapperEntity.getWrappedEvent()
All eventual accessor methods must call this method and delegate the method call to the underlying wrapped event.
|
Modifier and Type | Method and Description |
---|---|
protected void |
JpaDatabaseManager.writeInternal(LogEvent event) |
Constructor and Description |
---|
AbstractLogEventWrapperEntity(LogEvent wrappedEvent)
Instantiates this base class.
|
BasicLogEventEntity(LogEvent wrappedEvent)
Instantiates this base class.
|
Modifier and Type | Method and Description |
---|---|
void |
JmsAppender.append(LogEvent event) |
Modifier and Type | Method and Description |
---|---|
LogEvent |
RewritePolicy.rewrite(LogEvent source)
Rewrite a logging event.
|
LogEvent |
MapRewritePolicy.rewrite(LogEvent source)
Rewrite the event.
|
LogEvent |
PropertiesRewritePolicy.rewrite(LogEvent source)
Rewrite the event.
|
Modifier and Type | Method and Description |
---|---|
void |
RewriteAppender.append(LogEvent event)
Modify the event and pass to the subordinate Appenders.
|
LogEvent |
RewritePolicy.rewrite(LogEvent source)
Rewrite a logging event.
|
LogEvent |
MapRewritePolicy.rewrite(LogEvent source)
Rewrite the event.
|
LogEvent |
PropertiesRewritePolicy.rewrite(LogEvent source)
Rewrite the event.
|
Modifier and Type | Method and Description |
---|---|
void |
RollingFileManager.checkRollover(LogEvent event)
Determine if a rollover should occur.
|
boolean |
TimeBasedTriggeringPolicy.isTriggeringEvent(LogEvent event)
Determine whether a rollover should occur.
|
boolean |
TriggeringPolicy.isTriggeringEvent(LogEvent event)
Determines if a rollover may be appropriate at this time.
|
boolean |
OnStartupTriggeringPolicy.isTriggeringEvent(LogEvent event)
Determine if a rollover should be triggered.
|
boolean |
SizeBasedTriggeringPolicy.isTriggeringEvent(LogEvent event)
Returns true if a rollover should occur.
|
boolean |
CompositeTriggeringPolicy.isTriggeringEvent(LogEvent event)
Determines if a rollover should occur.
|
Modifier and Type | Method and Description |
---|---|
void |
RoutingAppender.append(LogEvent event) |
Modifier and Type | Class and Description |
---|---|
class |
RingBufferLogEvent
When the Disruptor is started, the RingBuffer is populated with event objects.
|
Modifier and Type | Method and Description |
---|---|
LogEvent |
RingBufferLogEvent.createMemento()
Creates and returns a new immutable copy of this
RingBufferLogEvent . |
Modifier and Type | Method and Description |
---|---|
protected void |
AsyncLoggerConfig.callAppenders(LogEvent event)
Passes on the event to a separate thread that will call
AsyncLoggerConfig.asyncCallAppenders(LogEvent) . |
Modifier and Type | Method and Description |
---|---|
void |
AppenderControl.callAppender(LogEvent event)
Call the appender.
|
protected void |
LoggerConfig.callAppenders(LogEvent event) |
void |
AbstractConfiguration.createConfiguration(Node node,
LogEvent event) |
void |
Configuration.createConfiguration(Node node,
LogEvent event) |
void |
LoggerConfig.log(LogEvent event)
Logs an event.
|
Modifier and Type | Method and Description |
---|---|
PluginBuilder |
PluginBuilder.forLogEvent(LogEvent event)
Specifies the LogEvent that may be used to provide extra context for string substitutions.
|
Modifier and Type | Method and Description |
---|---|
Object |
PluginNodeVisitor.visit(Configuration configuration,
Node node,
LogEvent event,
StringBuilder log) |
Object |
PluginAttributeVisitor.visit(Configuration configuration,
Node node,
LogEvent event,
StringBuilder log) |
Object |
PluginValueVisitor.visit(Configuration configuration,
Node node,
LogEvent event,
StringBuilder log) |
Object |
PluginConfigurationVisitor.visit(Configuration configuration,
Node node,
LogEvent event,
StringBuilder log) |
Object |
PluginElementVisitor.visit(Configuration configuration,
Node node,
LogEvent event,
StringBuilder log) |
Object |
PluginVisitor.visit(Configuration configuration,
Node node,
LogEvent event,
StringBuilder log)
Visits a Node to obtain a value for constructing a Plugin object.
|
Object |
PluginBuilderAttributeVisitor.visit(Configuration configuration,
Node node,
LogEvent event,
StringBuilder log) |
Modifier and Type | Method and Description |
---|---|
Filter.Result |
StructuredDataFilter.filter(LogEvent event) |
Filter.Result |
ThresholdFilter.filter(LogEvent event) |
Filter.Result |
MarkerFilter.filter(LogEvent event) |
Filter.Result |
AbstractFilter.filter(LogEvent event)
Context Filter method.
|
Filter.Result |
BurstFilter.filter(LogEvent event) |
Filter.Result |
ThreadContextMapFilter.filter(LogEvent event) |
Filter.Result |
CompositeFilter.filter(LogEvent event)
Filter an event.
|
Filter.Result |
TimeFilter.filter(LogEvent event) |
Filter.Result |
DynamicThresholdFilter.filter(LogEvent event) |
Filter.Result |
MapFilter.filter(LogEvent event) |
Filter.Result |
RegexFilter.filter(LogEvent event) |
boolean |
AbstractFilterable.isFiltered(LogEvent event)
Determine if the LogEvent should be processed or ignored.
|
boolean |
Filterable.isFiltered(LogEvent event)
Determines if the event should be filtered.
|
Modifier and Type | Class and Description |
---|---|
class |
Log4jLogEvent
Implementation of a LogEvent.
|
Modifier and Type | Method and Description |
---|---|
LogEvent |
DefaultLogEventFactory.createEvent(String loggerName,
org.apache.logging.log4j.Marker marker,
String fqcn,
org.apache.logging.log4j.Level level,
org.apache.logging.log4j.message.Message data,
List<Property> properties,
Throwable t)
Creates a log event.
|
LogEvent |
LogEventFactory.createEvent(String loggerName,
org.apache.logging.log4j.Marker marker,
String fqcn,
org.apache.logging.log4j.Level level,
org.apache.logging.log4j.message.Message data,
List<Property> properties,
Throwable t) |
Modifier and Type | Method and Description |
---|---|
LogEvent |
SerializedLayout.toSerializable(LogEvent event)
Returns the LogEvent.
|
Modifier and Type | Method and Description |
---|---|
byte[] |
AbstractStringLayout.toByteArray(LogEvent event)
Formats the Log Event as a byte array.
|
byte[] |
SerializedLayout.toByteArray(LogEvent event)
Formats a
LogEvent as a serialized byte array of the LogEvent object. |
byte[] |
GelfLayout.toByteArray(LogEvent event) |
String |
HtmlLayout.toSerializable(LogEvent event)
Format as a String.
|
String |
Rfc5424Layout.toSerializable(LogEvent event)
Formats a
LogEvent in conformance with the RFC 5424 Syslog specification. |
String |
SyslogLayout.toSerializable(LogEvent event)
Formats a
LogEvent in conformance with the BSD Log record format. |
LogEvent |
SerializedLayout.toSerializable(LogEvent event)
Returns the LogEvent.
|
String |
PatternLayout.toSerializable(LogEvent event)
Formats a logging event to a writer.
|
String |
GelfLayout.toSerializable(LogEvent event) |
Modifier and Type | Method and Description |
---|---|
String |
StrLookup.lookup(LogEvent event,
String key)
Looks up a String key to a String value possibly using the current LogEvent.
|
String |
MapLookup.lookup(LogEvent event,
String key) |
String |
Interpolator.lookup(LogEvent event,
String var)
Resolves the specified variable.
|
String |
ContextMapLookup.lookup(LogEvent event,
String key)
Looks up the value from the ThreadContext Map.
|
String |
JavaLookup.lookup(LogEvent event,
String key)
Looks up the value of the environment variable.
|
String |
SystemPropertiesLookup.lookup(LogEvent event,
String key)
Looks up the value for the key using the data in the LogEvent.
|
String |
ResourceBundleLookup.lookup(LogEvent event,
String key)
Looks up the value for the key in the format "BundleName:BundleKey".
|
String |
JndiLookup.lookup(LogEvent event,
String key)
Looks up the value of the JNDI resource.
|
String |
DateLookup.lookup(LogEvent event,
String key)
Looks up the value of the environment variable.
|
String |
EnvironmentLookup.lookup(LogEvent event,
String key)
Looks up the value of the environment variable.
|
String |
StructuredDataLookup.lookup(LogEvent event,
String key)
Looks up the value for the key using the data in the LogEvent.
|
String |
StrSubstitutor.replace(LogEvent event,
char[] source)
Replaces all the occurrences of variables with their matching values
from the resolver using the given source array as a template.
|
String |
StrSubstitutor.replace(LogEvent event,
char[] source,
int offset,
int length)
Replaces all the occurrences of variables with their matching values
from the resolver using the given source array as a template.
|
String |
StrSubstitutor.replace(LogEvent event,
Object source)
Replaces all the occurrences of variables in the given source object with
their matching values from the resolver.
|
String |
StrSubstitutor.replace(LogEvent event,
String source)
Replaces all the occurrences of variables with their matching values
from the resolver using the given source string as a template.
|
String |
StrSubstitutor.replace(LogEvent event,
StringBuffer source)
Replaces all the occurrences of variables with their matching values
from the resolver using the given source buffer as a template.
|
String |
StrSubstitutor.replace(LogEvent event,
StringBuffer source,
int offset,
int length)
Replaces all the occurrences of variables with their matching values
from the resolver using the given source buffer as a template.
|
String |
StrSubstitutor.replace(LogEvent event,
StringBuilder source)
Replaces all the occurrences of variables with their matching values
from the resolver using the given source builder as a template.
|
String |
StrSubstitutor.replace(LogEvent event,
StringBuilder source,
int offset,
int length)
Replaces all the occurrences of variables with their matching values
from the resolver using the given source builder as a template.
|
String |
StrSubstitutor.replace(LogEvent event,
String source,
int offset,
int length)
Replaces all the occurrences of variables with their matching values
from the resolver using the given source string as a template.
|
boolean |
StrSubstitutor.replaceIn(LogEvent event,
StringBuffer source,
int offset,
int length)
Replaces all the occurrences of variables within the given source buffer
with their matching values from the resolver.
|
boolean |
StrSubstitutor.replaceIn(LogEvent event,
StringBuilder source)
Replaces all the occurrences of variables within the given source
builder with their matching values from the resolver.
|
boolean |
StrSubstitutor.replaceIn(LogEvent event,
StringBuilder source,
int offset,
int length)
Replaces all the occurrences of variables within the given source
builder with their matching values from the resolver.
|
protected String |
StrSubstitutor.resolveVariable(LogEvent event,
String variableName,
StringBuilder buf,
int startPos,
int endPos)
Internal method that resolves the value of a variable.
|
protected boolean |
StrSubstitutor.substitute(LogEvent event,
StringBuilder buf,
int offset,
int length)
Internal method that substitutes the variables.
|
Modifier and Type | Method and Description |
---|---|
void |
SmtpManager.add(LogEvent event) |
protected byte[] |
SmtpManager.formatContentToBytes(LogEvent[] priorEvents,
LogEvent appendEvent,
Layout<?> layout) |
protected byte[] |
SmtpManager.formatContentToBytes(LogEvent[] priorEvents,
LogEvent appendEvent,
Layout<?> layout) |
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.writeBuffer(LogEvent[] priorEvents,
LogEvent appendEvent,
Layout<?> layout,
OutputStream out) |
Modifier and Type | Method and Description |
---|---|
void |
AbstractStyleNameConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
MethodLocationPatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
RelativeTimePatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
ThreadPatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
RootThrowablePatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
StyleConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
FullLocationPatternConverter.format(LogEvent event,
StringBuilder output)
Formats an event into a string buffer.
|
void |
DatePatternConverter.format(LogEvent event,
StringBuilder output)
Formats an event into a string buffer.
|
void |
ThrowablePatternConverter.format(LogEvent event,
StringBuilder buffer)
Formats an event into a string buffer.
|
void |
ClassNamePatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Format a logging event.
|
void |
LevelPatternConverter.format(LogEvent event,
StringBuilder output)
Formats an event into a string buffer.
|
void |
NdcPatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
HighlightConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
LoggerPatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
SequenceNumberPatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
PatternFormatter.format(LogEvent event,
StringBuilder buf) |
void |
EncodingPatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
MdcPatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
FileLocationPatternConverter.format(LogEvent event,
StringBuilder output)
Formats an event into a string buffer.
|
void |
RegexReplacementConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
MessagePatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
abstract void |
LogEventPatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
LineSeparatorPatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
ExtendedThrowablePatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
LineLocationPatternConverter.format(LogEvent event,
StringBuilder output)
Formats an event into a string buffer.
|
void |
LiteralPatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
MarkerPatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
UuidPatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
void |
MapPatternConverter.format(LogEvent event,
StringBuilder toAppendTo)
Formats an event into a string buffer.
|
Copyright © 1999-2021 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.