Class GrowLog4j2Appender
java.lang.Object
org.apache.logging.log4j.core.AbstractLifeCycle
org.apache.logging.log4j.core.filter.AbstractFilterable
org.apache.logging.log4j.core.appender.AbstractAppender
codes.grow.packages.betterstack.logging.GrowLog4j2Appender
- All Implemented Interfaces:
org.apache.logging.log4j.core.Appender,org.apache.logging.log4j.core.filter.Filterable,org.apache.logging.log4j.core.impl.LocationAware,org.apache.logging.log4j.core.LifeCycle,org.apache.logging.log4j.core.LifeCycle2
@Plugin(name="GrowLog",
category="Core",
elementType="appender",
printObject=true)
public final class GrowLog4j2Appender
extends org.apache.logging.log4j.core.appender.AbstractAppender
Log4j 2 appender plugin (
<GrowLog name="grow"/>) that forwards events to a LogClient (Log4j is an optional, provided dependency).
Appenders created from a configuration file use the client registered with setDefaultClient(codes.grow.packages.betterstack.logging.LogClient); create(java.lang.String, codes.grow.packages.betterstack.logging.LogClient) binds an explicit client. Context data (MDC) becomes
attributes, together with logger.name, thread.name and exception.*.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.AbstractAppender
org.apache.logging.log4j.core.appender.AbstractAppender.Builder<B extends org.apache.logging.log4j.core.appender.AbstractAppender.Builder<B>>Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle
org.apache.logging.log4j.core.LifeCycle.State -
Field Summary
FieldsFields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGERFields inherited from interface org.apache.logging.log4j.core.Appender
ELEMENT_TYPE, EMPTY_ARRAY -
Method Summary
Modifier and TypeMethodDescriptionvoidappend(org.apache.logging.log4j.core.LogEvent event) static GrowLog4j2AppenderCreates an appender bound toclient(start it and add it to a configuration).static GrowLog4j2AppendercreateAppender(String name, org.apache.logging.log4j.core.Filter filter) Plugin factory used by configuration files.static voidsetDefaultClient(LogClient client) Sets the client used by appenders created from configuration files.static SeverityseverityOf(org.apache.logging.log4j.Level level) Maps a Log4j level to a severity.Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender
error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, requiresLocation, setHandler, toSerializable, toStringMethods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable
addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter, start, stop, stopMethods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stopMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.logging.log4j.core.LifeCycle
getState, initialize, isStarted, isStopped, start, stop
-
Field Details
-
PLUGIN_NAME
Plugin element name inlog4j2.xml.- See Also:
-
-
Method Details
-
createAppender
@PluginFactory public static GrowLog4j2Appender createAppender(@PluginAttribute("name") String name, @PluginElement("Filter") org.apache.logging.log4j.core.Filter filter) Plugin factory used by configuration files.- Parameters:
name- appender namefilter- optional filter- Returns:
- appender bound to the default client
-
create
Creates an appender bound toclient(start it and add it to a configuration).- Parameters:
name- appender nameclient- destination- Returns:
- appender
-
setDefaultClient
Sets the client used by appenders created from configuration files.- Parameters:
client- destination ornull
-
severityOf
Maps a Log4j level to a severity.- Parameters:
level- level- Returns:
- severity
-
append
public void append(org.apache.logging.log4j.core.LogEvent event)
-